Logback日志框架使用

Logback 通过 Logger 决定日志级别，再由 Appender 写入控制台或文件。下面使用 logback-spring.xml 配置日志分级、滚动文件和异步写入。

什么是 Logback？

Logback 是一个广泛使用的日志框架，通常与 SLF4J 一起使用，用于替代 Java 的原生日志框架（如 java.util.logging）和 Log4j。本文用到的能力：

特性	说明
异步写入	异步写入可减少业务线程等待，但队列满时仍需选择阻塞或丢弃
配置格式	本文使用 XML；其他格式需要确认版本及额外组件
日志级别	日志级别为 TRACE、DEBUG、INFO、WARN、ERROR；另有 ALL/OFF 控制值
输出目标	控制台、文件、数据库、远程服务等
配置重载	可自动检测配置文件变更
扩展组件	如 logstash-logback-encoder 方便接入 ELK
框架集成	通过 SLF4J 接收框架输出的日志

配置结构总览

本篇文章解析的 Logback 配置文件包括以下几个模块：

基础配置（扫描/上下文）
控制台输出
文件输出（INFO/WARN/ERROR）
异步日志写入
不同环境下的日志策略
日志格式与美化
Root Logger 总控输出

配置总览

Logback 的配置文件（默认读取 logback-spring.xml 或 logback.xml）一般包含以下结构

<configuration>
  <property/>       <!-- 定义变量 -->
  <appender/>       <!-- 定义日志输出目标 -->
  <logger/>         <!-- 针对包或类设置日志级别 -->
  <root/>           <!-- 根日志配置 -->
</configuration>

基础配置说明

<configuration>
</configuration>

这里使用 <springProperty> 和 <springProfile>，不要启用 Logback 配置扫描；Spring Boot 的 Logback 扩展不支持与扫描机制一起使用。参见 Spring Boot 日志扩展。

上下文变量定义

<springProperty scope="context" name="log.path" source="logging.path"/>

支持从 Spring 配置文件读取 logging.path，用于动态控制日志目录

彩色日志格式设置

<conversionRule conversionWord="clr" converterClass="org.springframework.boot.logging.logback.ColorConverter"/>

clr 是颜色转换规则的关键字，使控制台日志更加易读。

控制台输出配置

<appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
  <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
    <level>info</level>
  </filter>
  <encoder>
    <pattern>%d{yy-MM-dd.HH:mm:ss.SSS} [%-16t] %-5p %-22c{0}%X{ServiceId} -%X{trace-id} %m%n</pattern>
    <charset>UTF-8</charset>
  </encoder>
</appender>

仅输出 INFO 及以上日志
含线程、类名、trace-id，利于链路追踪

文件输出（INFO 级别）

    <appender name="INFO_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <!-- 正在记录的日志文件的路径及文件名 -->
    <file>./logData/log/log_info.log</file>
    <!--日志文件输出格式-->
    <encoder>
        <pattern>%d{yy-MM-dd.HH:mm:ss.SSS} [%-16t] %-5p %-22c{0}%X{ServiceId} -%X{trace-id} %m%n</pattern>
        <charset>UTF-8</charset>
    </encoder>
    <!-- 日志记录器的滚动策略，按日期，按大小记录 -->
    <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
        <!-- 每天日志归档路径以及格式 -->
        <fileNamePattern>./logData/log/log-info-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
        <maxFileSize>100MB</maxFileSize>
        <!--日志文件保留天数-->
        <maxHistory>15</maxHistory>
        <totalSizeCap>10GB</totalSizeCap>
    </rollingPolicy>
</appender>

滚动策略为：按天 + 按大小；
控制日志文件不超过 100MB，最多保留 15 天、10GB；
示例写入 ./logData/log；若使用 ${log.path}，需同时替换 <file> 和 <fileNamePattern> 中的路径。

文件输出（WARN/ERROR）

    <appender name="ERROR_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <!-- 正在记录的日志文件的路径及文件名 -->
    <file>./logData/log/log_error.log</file>
    <!--日志文件输出格式-->
    <encoder>
        <pattern>%d{yy-MM-dd.HH:mm:ss.SSS} [%-16t] %-5p %-22c{0}%X{ServiceId} -%X{trace-id} %m%n</pattern>
        <charset>UTF-8</charset>
    </encoder>
    <!-- 日志记录器的滚动策略，按日期，按大小记录 -->
    <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
        <fileNamePattern>./logData/log/log-error-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
        <maxFileSize>100MB</maxFileSize>
        <!-- 日志文件保留天数【根据服务器预留，可自行调整】 -->
        <maxHistory>7</maxHistory>
        <totalSizeCap>5GB</totalSizeCap>
    </rollingPolicy>
    <!-- WARN 级别及以上 -->
    <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
        <level>WARN</level>
    </filter>
</appender>

输出 WARN 和 ERROR 等高优先级日志
日志保留 7 天，最多 5GB
单独区分错误日志，便于报警系统采集

异步日志输出配置

<appender name="ASYNC_FILE_INFO" class="ch.qos.logback.classic.AsyncAppender">
    <!-- 队列剩余容量小于discardingThreshold,则会丢弃TRACT、DEBUG、INFO级别的日志;默认阈值为queueSize的20%;0禁用提前丢弃策略，但不保证无丢失 -->
    <discardingThreshold>0</discardingThreshold>
    <!-- 更改默认的队列的深度,该值会影响性能.默认值为256 -->
    <queueSize>8192</queueSize>
    <!-- neverBlock:true 在队列满时丢弃日志，包括 WARN/ERROR -->
    <neverBlock>true</neverBlock>
    <!--是否提取调用者数据-->
    <includeCallerData>false</includeCallerData>
    <appender-ref ref="INFO_FILE"/>
</appender>
<appender name="ASYNC_FILE_ERROR" class="ch.qos.logback.classic.AsyncAppender">
    <!-- 队列剩余容量小于discardingThreshold,则会丢弃TRACT、DEBUG、INFO级别的日志;默认阈值为queueSize的20%;0禁用提前丢弃策略，但不保证无丢失 -->
    <discardingThreshold>0</discardingThreshold>
    <!-- 更改默认的队列的深度,该值会影响性能.默认值为256 -->
    <queueSize>1024</queueSize>
    <!-- neverBlock:true 在队列满时丢弃日志，包括 WARN/ERROR -->
    <neverBlock>true</neverBlock>
    <!--是否提取调用者数据-->
    <includeCallerData>false</includeCallerData>
    <appender-ref ref="ERROR_FILE"/>
</appender>

AsyncAppender 将日志交给后台线程；是否阻塞取决于队列状态和 neverBlock 配置
设置 neverBlock=true 时，队列满后任何级别的日志都可能被丢弃；discardingThreshold=0 只关闭提前丢弃低级别日志的策略
队列大小可根据系统吞吐能力调整

开发环境专属配置

<springProfile name="dev">
  <logger name="com.nmys.view" level="debug"/>
</springProfile>

仅在开发环境启用某个包的 DEBUG 日志，生产环境不受影响

Root Logger 配置总控

<root level="info">
    <appender-ref ref="CONSOLE"/>
    <!-- 异步日志-INFO -->
    <appender-ref ref="ASYNC_FILE_INFO"/>
    <!-- 异步日志-ERROR -->
    <appender-ref ref="ASYNC_FILE_ERROR"/>
</root>

设置默认日志级别为 INFO
同时输出至控制台、文件（INFO）、文件（ERROR）

完整配置与调用

整合代码如下：

<?xml version="1.0" encoding="UTF-8"?>
<!-- 日志级别从低到高分为TRACE < DEBUG < INFO < WARN < ERROR < FATAL，如果设置为WARN，则低于WARN的信息都不会输出 -->
<configuration>

    <contextName>logback</contextName>
    <!-- name的值是变量的名称，value的值时变量定义的值。通过定义的值会被插入到logger上下文中。定义变量后，可以使“${}”来使用变量。 -->
    <springProperty scope="context" name="log.path" source="logging.path"/>
    <!-- 日志格式 -->
    <conversionRule conversionWord="clr" converterClass="org.springframework.boot.logging.logback.ColorConverter"/>
    <conversionRule conversionWord="wex"
                    converterClass="org.springframework.boot.logging.logback.WhitespaceThrowableProxyConverter"/>
    <conversionRule conversionWord="wEx"
                    converterClass="org.springframework.boot.logging.logback.ExtendedWhitespaceThrowableProxyConverter"/>

    <!-- 输出到控制台 -->
    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <!-- 此日志appender是为开发使用，只配置最底级别，控制台输出的日志级别是大于或等于此级别的日志信息 -->
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>info</level>
        </filter>
        <encoder>
            <pattern>%d{yy-MM-dd.HH:mm:ss.SSS} [%-16t] %-5p %-22c{0}%X{ServiceId} -%X{trace-id} %m%n</pattern>
            <charset>UTF-8</charset>
        </encoder>
    </appender>

    <!--输出到文件-->
    <!-- 时间滚动输出 level为 INFO 日志 -->
    <appender name="INFO_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 正在记录的日志文件的路径及文件名 -->
        <file>./logData/log/log_info.log</file>
        <!--日志文件输出格式-->
        <encoder>
            <pattern>%d{yy-MM-dd.HH:mm:ss.SSS} [%-16t] %-5p %-22c{0}%X{ServiceId} -%X{trace-id} %m%n</pattern>
            <charset>UTF-8</charset>
        </encoder>
        <!-- 日志记录器的滚动策略，按日期，按大小记录 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
            <!-- 每天日志归档路径以及格式 -->
            <fileNamePattern>./logData/log/log-info-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
        <maxFileSize>100MB</maxFileSize>
            <!--日志文件保留天数-->
            <maxHistory>15</maxHistory>
            <totalSizeCap>10GB</totalSizeCap>
        </rollingPolicy>
    </appender>

    <!-- 时间滚动输出 level为 ERROR 日志 -->
    <appender name="ERROR_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 正在记录的日志文件的路径及文件名 -->
        <file>./logData/log/log_error.log</file>
        <!--日志文件输出格式-->
        <encoder>
            <pattern>%d{yy-MM-dd.HH:mm:ss.SSS} [%-16t] %-5p %-22c{0}%X{ServiceId} -%X{trace-id} %m%n</pattern>
            <charset>UTF-8</charset>
        </encoder>
        <!-- 日志记录器的滚动策略，按日期，按大小记录 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
            <fileNamePattern>./logData/log/log-error-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
        <maxFileSize>100MB</maxFileSize>
            <!-- 日志文件保留天数【根据服务器预留，可自行调整】 -->
            <maxHistory>7</maxHistory>
            <totalSizeCap>5GB</totalSizeCap>
        </rollingPolicy>
        <!-- WARN 级别及以上 -->
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>WARN</level>
        </filter>
    </appender>

    <!-- 异步输出 -->
    <appender name="ASYNC_FILE_INFO" class="ch.qos.logback.classic.AsyncAppender">
        <!-- 队列剩余容量小于discardingThreshold,则会丢弃TRACT、DEBUG、INFO级别的日志;默认阈值为queueSize的20%;0禁用提前丢弃策略，但不保证无丢失 -->
        <discardingThreshold>0</discardingThreshold>
        <!-- 更改默认的队列的深度,该值会影响性能.默认值为256 -->
        <queueSize>8192</queueSize>
        <!-- neverBlock:true 在队列满时丢弃日志，包括 WARN/ERROR -->
        <neverBlock>true</neverBlock>
        <!--是否提取调用者数据-->
        <includeCallerData>false</includeCallerData>
        <appender-ref ref="INFO_FILE"/>
    </appender>

    <appender name="ASYNC_FILE_ERROR" class="ch.qos.logback.classic.AsyncAppender">
        <!-- 队列剩余容量小于discardingThreshold,则会丢弃TRACT、DEBUG、INFO级别的日志;默认阈值为queueSize的20%;0禁用提前丢弃策略，但不保证无丢失 -->
        <discardingThreshold>0</discardingThreshold>
        <!-- 更改默认的队列的深度,该值会影响性能.默认值为256 -->
        <queueSize>1024</queueSize>
        <!-- neverBlock:true 在队列满时丢弃日志，包括 WARN/ERROR -->
        <neverBlock>true</neverBlock>
        <!--是否提取调用者数据-->
        <includeCallerData>false</includeCallerData>
        <appender-ref ref="ERROR_FILE"/>
    </appender>

    <!-- 开发环境：控制台打印 -->
    <springProfile name="dev">
        <logger name="com.nmys.view" level="debug"/>
    </springProfile>
    <root level="info">
        <appender-ref ref="CONSOLE"/>
        <!-- 异步日志-INFO -->
        <appender-ref ref="ASYNC_FILE_INFO"/>
        <!-- 异步日志-ERROR -->
        <appender-ref ref="ASYNC_FILE_ERROR"/>
    </root>

</configuration>

我们需要在yml中配置当前xml路径

logging:
  level:
    root: info
  config: classpath:logback-spring.xml

代码中使用Logger

    public static final Logger log = Logger.getLogger(Application.class.getName());

级别定义见 Logback 架构说明，异步队列和滚动策略见 Appender 文档。