SpringBoot整合Logback日志框架配置全解析

末蓝、 2023-10-13 13:08 89阅读 0赞

### 一、Logback日志框架介绍 ###

SpringBoot使用 Commons Logging 进行所有内部日志的记录，但默认配置也提供了对常用日志的支持，如 Java Util Logging，Log4J2，和Logback. 每种logger都可以通过配置使用控制台或文件输出日志内容。

Logback是log4j框架的作者开发的新一代日志框架，它效率更高、能够适应诸多的运行环境，同时天然支持SLF4J。

### 二、SpringBoot与Logback ###

假设你使用starter启动创建SpringBoot应用，则默认已经导入了spring-boot-starter-logging的依赖，相继也就导入了logback所需要的依赖。

![521577681bfe48add897b666b480f4a2.png][]

#### 1、默认日志格式 ####

于是，当我们启动SpringBoot应用时，控制台将会显示INFO级别的日志输出。

![f67f3d3fd837e329325b3b709ce579e7.png][]

可以看到，输出内容如下：

*  日期和时间，精确到毫秒级别。
 *  日志级别：INFO，【日志级别默认从高到低：ERROR，WARN，INFO，DEBUG，TRACE】。
 *  进程ID
 *  分隔符：来标识实际日志消息的开始。
 *  线程名：用方括号括起来(在控制台输出时可能被截断)。
 *  日志记录器名称:这通常是源类名称(通常缩写)。
 *  日志信息

> logback是没有FATAL级别的，它对应的就是ERROR。

#### 2、控制台输出 ####

默认的日志配置就是将日志信息**显示到控制台**，默认情况下，**将会显示INFO级别以上**的日志信息。你还可以通过使用`--debug`标志启动debug模式。

$ java -jar myapp.jar --debug

使用IDEA操作可以编辑Program arguments：--debug。

在application.properties中配置debug=true同样也可以将日志级别调整到DEBUG。

#### 3、文件输出 ####

默认情况下，SpringBoot的日志只会输出到控制台，如果你还想输出到文件中，你需要配置`logging.file.name`和`logging.file.path`两个属性。

下面这个表格展示如何组合使用`logging.*`来达到理想的效果：

<table> 
 <thead> 
  <tr> 
   <th><code>logging.file.name</code></th> 
   <th><code>logging.file.path</code></th> 
   <th>Example</th> 
   <th>Description</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td><em>(none)</em></td> 
   <td><em>(none)</em></td> 
   <td></td> 
   <td>只会输出到控制台</td> 
  </tr> 
  <tr> 
   <td>指定文件</td> 
   <td><em>(none)</em></td> 
   <td><code>my.log</code></td> 
   <td>写入指定的日志文件在当前项目目录下</td> 
  </tr> 
  <tr> 
   <td><em>(none)</em></td> 
   <td>指定目录</td> 
   <td><code>log</code></td> 
   <td>在当前项目下的log目录，写入spring.log文件</td> 
  </tr> 
 </tbody> 
</table>

日志文件达到10 MB时会触发滚动策略【切分】，默认情况下会记录INFO以上级别的信息。 可以使用`logging.file.max-size`属性更改大小限制。 除非已设置`logging.file.max-history`属性，否则默认情况下**将保留最近7天的轮转日志文件**。 可以使用`logging.file.total-size-cap`限制日志归档文件的总大小。 当日志归档的总大小超过该阈值时，将删除备份。 要在应用程序启动时强制清除日志存档，请使用`logging.file.clean-history-on-start`属性。

#### 4、日志级别 ####

可以使用logging.level设置所有受支持的日志记录器的级别。

logging.level.root=warn
    logging.level.org.springframework.web=debug
    logging.level.org.hibernate=error

#### 5、日志组 ####

使用logging.group能够将相关的logger组合在一起统一管理日志级别等配置。使用方法如下：

假设定义了group为tomcat：

logging.group.tomcat=org.apache.catalina, org.apache.coyote, org.apache.tomcat

一旦这样定义之后，就可以仅仅通过一行配置，完成相关三个logger的级别配置：

logging.level.tomcat=TRACE

SpringBoot预定义了两个开箱即用的日志组：

<table> 
 <thead> 
  <tr> 
   <th>Name</th> 
   <th>Loggers</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>web</td> 
   <td><code>org.springframework.core.codec</code>,&nbsp;<code>org.springframework.http</code>,&nbsp;<code>org.springframework.web</code>,&nbsp;<code>org.springframework.boot.actuate.endpoint.web</code>,&nbsp;<code>org.springframework.boot.web.servlet.ServletContextInitializerBeans</code></td> 
  </tr> 
  <tr> 
   <td>sql</td> 
   <td><code>org.springframework.jdbc.core</code>,&nbsp;<code>org.hibernate.SQL</code>,&nbsp;<code>org.jooq.tools.LoggerListener</code></td> 
  </tr> 
 </tbody> 
</table>

# pre-defined
    logging.level.web=debug
    logging.level.sql=debug

#### 6、自定义log配置 ####

由于日志服务一般都在ApplicationContext创建前就初始化了，它并不是必须通过Spring的配置文件控制。因此通过系统属性和传统的Spring Boot外部配置文件依然可以很好的支持日志控制和管理。

你可以根据你的日志系统，按照下面表格的定义规则，选择定义对应的日志配置：

<table> 
 <thead> 
  <tr> 
   <th>Logging System</th> 
   <th>Customization</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>Logback</td> 
   <td><code>logback-spring.xml</code>,&nbsp;<code>logback-spring.groovy</code>,&nbsp;<code>logback.xml</code>, or&nbsp;<code>logback.groovy</code></td> 
  </tr> 
  <tr> 
   <td>Log4j2</td> 
   <td><code>log4j2-spring.xml</code>&nbsp;or&nbsp;<code>log4j2.xml</code></td> 
  </tr> 
  <tr> 
   <td>JDK (Java Util Logging)</td> 
   <td><code>logging.properties</code></td> 
  </tr> 
 </tbody> 
</table>

SpringBoot官方推荐使用带有`-spring`的文件名作为配置，如`logback-spring.xml`而不是`logback.xml`。

这样命名的好处在于：因为标准的`logback.xml`配置文件加载得太早，所以不能在其中使用扩展，需要使用`logback-spring.xml`。

> 当然上面是默认的命名规则，如果你想自定义xml的名称，自定义路径，可以通过logging.config属性配置：`logging.config=classpath:logging-config.xml`

### 三、logback-spring.xml自定义注意事项 ###

接下来分享一份配置十分详细的logback.xml配置，参照注释，应该就能够掌握xml的定义。

<?xml version="1.0" encoding="UTF-8"?>
    <configuration  scan="true" scanPeriod="10 seconds" debug="false">
        
        
        
        
        <contextName>logback</contextName>
        
        <property name="log.path" value="log" />
        <property name="console_log_pattern"
                  value="%black(%contextName-) %red(%d{yyyy-MM-dd HH:mm:ss}) %green([%thread]) %highlight(%-5level) %boldMagenta(%logger{36}) - %gray(%msg%n)"/>
        <property name="charset" value="UTF-8"/>
        
        <appender name="console" class="ch.qos.logback.core.ConsoleAppender">
            
            
             <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
                 <level>DEBUG</level>
             </filter>
            <encoder>
                <pattern>${console_log_pattern}</pattern>
            </encoder>
        </appender>
    
        
        <appender name="info_file" class="ch.qos.logback.core.rolling.RollingFileAppender">
            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                <fileNamePattern>${log.path}/roll_info/logback.%d{yyyy-MM-dd}.log</fileNamePattern>
            </rollingPolicy>
            <encoder>
                <pattern>${console_log_pattern}</pattern>
                <charset>${charset}</charset>
            </encoder>
            
            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                
                <fileNamePattern>${log.path}/info/log-info-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
                <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                    <maxFileSize>100MB</maxFileSize>
                </timeBasedFileNamingAndTriggeringPolicy>
                
                <maxHistory>15</maxHistory>
            </rollingPolicy>
            
            <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
                <maxFileSize>10MB</maxFileSize>
            </triggeringPolicy>
            
            <filter class="ch.qos.logback.classic.filter.LevelFilter">
                <level>INFO</level>
                <onMatch>ACCEPT</onMatch>
                <onMismatch>DENY</onMismatch>
            </filter>
        </appender>
        
        <appender name="warn_file" class="ch.qos.logback.core.rolling.RollingFileAppender">
        </appender>
        
        <appender name="error_file" class="ch.qos.logback.core.rolling.RollingFileAppender">
        </appender>
    
        
        <root level="info">
            <appender-ref ref="console" />
            <appender-ref ref="info_file" />
            <appender-ref ref="warn_file"/>
            <appender-ref ref="error_file"/>
        </root>
    
        
        
        <logger name="com.hyh.logback.web.LogTestController" level="WARN" additivity="false">
            <appender-ref ref="console"/>
            <appender-ref ref="warn_file"/>
            <appender-ref ref="error_file"/>
        </logger>
    
        
        
        <springProfile name="dev">
            
            <logger name="com.hyh.logback.web" level="DEBUG">
                <appender-ref ref="console"/>
            </logger>
            
            <root level="INFO">
                <appender-ref ref="console"/>
            </root>
        </springProfile>
    </configuration>

最终的效果，会在项目路径下生成日志文件：`/log/info/log-info-2020-11-01.0.log`，并且日志文件的策略也在xml中定义。

控制台打印信息，如下图所示：

![fd9d5d6436c88ac68cf663f5314a9bc5.png][]

[521577681bfe48add897b666b480f4a2.png]: https://img-blog.csdnimg.cn/img_convert/521577681bfe48add897b666b480f4a2.png
[f67f3d3fd837e329325b3b709ce579e7.png]: https://img-blog.csdnimg.cn/img_convert/f67f3d3fd837e329325b3b709ce579e7.png
[fd9d5d6436c88ac68cf663f5314a9bc5.png]: https://img-blog.csdnimg.cn/img_convert/fd9d5d6436c88ac68cf663f5314a9bc5.png