【Spring Boot实战与进阶】logback详解和最佳配置

待我称王封你为后i 2021-12-13 04:24 218阅读 0赞

> Spring Boot是很优秀的框架，它的出现简化了新Spring应用的初始搭建以及开发过程，大大减少了代码量，目前已被大多数企业认可和使用。这个专栏将对Spring Boot框架从浅入深，从实战到进阶，不但我们要懂得如何去使用，还要去剖析框架源码，学习其优秀的设计思想。

> 汇总目录链接：[【Spring Boot实战与进阶】学习目录][Spring Boot]

本来打算参考别人写的来配置下Spring Boot项目，结果发现每个人写的都不一样，最后决定去认真学习了官方文档。

### 文章目录 ###

*   *  一、什么是logback
     *  二、架构
     *  三、logback的配置
     *   *  1、logback 的初始化步骤
         *  2、配置logger
         *  3、配置 root logger
         *  4、配置 appender
         *  5、根据官方文档，配置了详细的logback文件

## 一、什么是logback ##

logback 继承自 log4j，它建立在有十年工业经验的日志系统之上。它比其它所有的日志系统更快并且更小，包含了许多独特并且有用的特性。

## 二、架构 ##

Logback 的架构非常的通用，适用不同的使用场景。Logback 被分成三个不同的模块：logback-core，logback-classic，logback-access。这三个不同类型的组件一起作用能够让开发者根据消息的类型以及日志的级别来打印日志。Logger 类作为 logback-classic 模块的一部分。Appender 与 Layouts 接口作为 logback-core 的一部分。作为一个通用的模块，logback-core 没有 logger 的概念。  
  logback-core 是其它两个模块的基础。logback-classic 模块可以看作是 log4j 的一个优化版本，它天然的支持 SLF4J，所以你可以随意的从其它日志框架（例如：log4j 或者 java.util.logging）切回到 logack。  
  logback-access 可以与 Servlet 容器进行整合，例如：Tomcat、Jetty。它提供了 http 访问日志的功能。

## 三、logback的配置 ##

### 1、logback 的初始化步骤 ###

（1） logback 会在类路径下寻找名为 logback-test.xml 的文件。  
（2） 如果没有找到，logback 会继续寻找名为 logback.groovy 的文件。  
（3） 如果没有找到，logback 会继续寻找名为 logback.xml 的文件。  
（4） 如果没有找到，将会通过 JDK 提供的 ServiceLoader 工具在类路径下寻找文件 META-- INFO/services/ch.qos.logback.classic.spi.Configurator，该文件的内容为实现了 Configurator 接口的实现类的全限定类名。  
（5） 如果以上都没有成功，logback 会通过 BasicConfigurator 为自己进行配置，并且日志将会全部在控制台打印出来。

### 2、配置logger ###

通过 logger标签来进行配置，一个 logger 标签必须包含一个 name 属性，一个可选的 level 属性，一个可选 additivity 属性。additivity 的值为 true 或 false。level 的值为 TRACE，DEBUG，INFO，WARN，ERROR，ALL，OFF，INHERITED，NULL。当 level 的值为 INHERITED 或 NULL 时，将会强制 logger 继承上一层的级别。  
   logger元素至少包含 0 或多个 appender-ref 元素。每一个 appender 通过这种方式被添加到 logger 上。与 log4j 不同的是，logbakc-classic 不会关闭或移除任何之前在 logger 上定义好的的 appender。

### 3、配置 root logger ###

root logger 通过 root元素来进行配置。它只支持一个属性——level。它不允许设置其它任何的属性，因为 additivity 并不适用 root logger。而且，root logger 的名字已经被命名为 “ROOT”，也就是说也不支持 name 属性。level 属性的值和logger一样，但是不能设置为 INHERITED 或 NULL。  
  跟 <logger 元素类似， 元素可以包含 0 或多个 元素。

**例子**  
  如果我们不想看到属于 “chapters.configuration” 组件中任何的 DEBUG 信息，但是有一个类例外。

<configuration>
        <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
            <encoder>
                <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
            </encoder>
        </appender>
    
        <logger name="chapters.configuration" level="INFO" />
        <logger name="chapters.configuration.Foo" level="DEBUG" />
    
        <root level="DEBUG">
            <appender-ref ref="STDOUT" />
        </root>
    </configuration>

<table> 
 <thead> 
  <tr> 
   <th align="left">Logger name</th> 
   <th>指定级别</th> 
   <th>有效级别</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left">root</td> 
   <td>DEBUG</td> 
   <td>DEBUG</td> 
  </tr> 
  <tr> 
   <td align="left">chapters.configuration</td> 
   <td>INFO</td> 
   <td>INFO</td> 
  </tr> 
  <tr> 
   <td align="left">chapters.configuration.MyApp</td> 
   <td>null</td> 
   <td>INFO</td> 
  </tr> 
  <tr> 
   <td align="left">chapters.configuration.Foo</td> 
   <td>DEBUG</td> 
   <td>DEBUG</td> 
  </tr> 
 </tbody> 
</table>

### 4、配置 appender ###

通过 appender元素进行配置，需要两个强制的属性 name 与 class。name 属性用来指定 appender 的名字，class 属性需要指定类的全限定名用于实例化。appender元素可以包含 0 或一个 元素，0 或多个encoder元素，0 或多个filter元素。除了这些公共的元素之外，appender 元素可以包含任意与 appender 类的 JavaBean 属性相一致的元素。

**FileAppender** 是 OutputStreamAppender 的子类，将日志事件输出到文件中。通过 file 来指定目标文件。如果该文件存在，根据 append 的值，要么将日志追加到文件中，要么该文件被截断。

<appender name="FILE" class="ch.qos.logback.core.FileAppender">
            <file>myApp.log</file>
            <encoder>
                <pattern>
                    %date %level [%thread] %logger{10} [%file:%line] %msg%n
                </pattern>
            </encoder>
        </appender>

**RollingFileAppender** 继承自FileAppender，具有轮转日志文件的功能。例如，RollingFileAppender 将日志输出到 log.txt 文件，在满足了特定的条件之后，将日志输出到另外一个文件。  
  与 RollingFileAppender 进行交互的有两个重要的子组件。第一个是 RollingPolicy，它负责日志轮转的功能。另一个是 TriggeringPolicy，它负责日志轮转的时机。所以 RollingPolicy 负责发生什么，TriggeringPolicy 负责什么时候发生。  
  为了让 RollingFileAppender 生效，必须同时设置 RollingPolicy 与 TriggeringPolicy。但是，如果 RollingPolicy 也实现了 TriggeringPolicy 接口，那么只需要设置前一个就好了。

<appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
            <file>logFile.log</file>
            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
    		
                <fileNamePattern>logFile.%d{yyyy-MM-dd}.log</fileNamePattern>
    			
                <maxHistory>30</maxHistory>
                <totalSizeCap>3GB</totalSizeCap>
            </rollingPolicy>
    
            <encoder>
                <pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern>
            </encoder>
        </appender>

**TimeBasedRollingPolicy** 是最常用的轮转策略。它是基于时间来定义轮转策略。例如按天或者按月。TimeBasedRollingPolicy 既负责轮转的行为，也负责触发轮转。实际上，TimeBasedRollingPolicy 同时实现了 RollingPolicy 与 TriggeringPolicy 接口。  
  TimeBasedRollingPolicy 的配置需要一个强制的属性 fileNamePattern 以及其它的可选属性。  
  TimeBasedRollingPolicy 支持文件自动压缩。如果 fileNamePattern 以 .gz 或者 .zip 结尾，将会启动这个特性。

**基于大小以及时间的轮转策略**  
  有时你希望按时轮转，但同时又想限制每个日志文件的大小。特别是如果后期处理工具需要对日志进行大小限制。为了满足这个需求，logback 配备了 SizeAndTimeBasedRollingPolicy。  
  注意，TimeBasedRollingPolicy 可以限制归档文件总的大小。所以如果你想要这个限制，你可以通过设置 totalSizeCap 来达到这个目的。

<appender name="ROLLING" class="ch.qos.logback.core.rolling.RollingFileAppender">
            <file>mylog.txt</file>
            <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
    		
                <fileNamePattern>mylog-%d{yyyy-MM-dd}.%i.txt</fileNamePattern>
                <maxFileSize>100MB</maxFileSize>
                <maxHistory>60</maxHistory>
                <totalSizeCap>20GB</totalSizeCap>
            </rollingPolicy>
    
            <encoder>
                <pattern>%msg%n</pattern>
            </encoder>
        </appender>

### 5、根据官方文档，配置了详细的logback文件 ###

<?xml version="1.0" encoding="UTF-8"?>
    
    
    
    <configuration scan="true" scanPeriod="60 seconds">
        <contextName>logback</contextName>
        <property name="log.path" value="./logs" />
        <property name="app.name" value="bootdemo" />
    
        
        
        <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" />
            
        <property name="CONSOLE_LOG_PATTERN" value="${CONSOLE_LOG_PATTERN:-%clr(%d{yyyy-MM-dd HH:mm:ss.SSS}){faint} %clr(${LOG_LEVEL_PATTERN:-%5p}) | %clr(${PID:- }){magenta} | %clr(%15.15t){faint} | %clr(%-40.40logger{39}:%-4.4line){cyan} | %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}}"/>
        
        
        <property name="LOG_PATTERN" value="${LOG_PATTERN:-%d{yyyy-MM-dd HH:mm:ss.SSS} | ${LOG_LEVEL_PATTERN:-%5p} | ${PID:- } | %15.15t | %-40.40logger{39}:%-4.4line | %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}}"/>
    
        
        <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
            <encoder>
                <pattern>${CONSOLE_LOG_PATTERN}</pattern>
                <charset>UTF-8</charset>
            </encoder>
        </appender>
    
        
        <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
            <file>${log.path}/${app.name}.log</file>
            <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
                <fileNamePattern>${log.path}/%d{yyyy-MM-dd}/${app.name}.%i.log</fileNamePattern>
                
                <maxFileSize>10MB</maxFileSize>
                
                <maxHistory>30</maxHistory>
                <totalSizeCap>3GB</totalSizeCap>
            </rollingPolicy>
            <encoder>
                <pattern>${LOG_PATTERN}</pattern>
                <charset>UTF-8</charset>
            </encoder>
        </appender>
    
    	
        <appender name="ERROR_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
            <file>${log.path}/error.log</file>
            <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
                <fileNamePattern>${log.path}/%d{yyyy-MM-dd}/error.%i.log</fileNamePattern>
                <maxFileSize>10MB</maxFileSize>
                <maxHistory>30</maxHistory>
                <totalSizeCap>3GB</totalSizeCap>
            </rollingPolicy>
            <encoder>
                <pattern>${LOG_PATTERN}</pattern>
                <charset>UTF-8</charset>
            </encoder>
            
            <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
                <level>ERROR</level>
            </filter>
        </appender>
    
        <root level="INFO">
            <appender-ref ref="CONSOLE" />
            <appender-ref ref="FILE" />
            <appender-ref ref="ERROR_FILE"/>
        </root>
    
    </configuration>

[Spring Boot]: https://yunfan.blog.csdn.net/article/details/103614982