SpringBoot中如何使用logback日志框架

骑猪看日落 2023-07-01 08:34 33阅读 0赞

对于Java来说，现在有很多的日志实现，像commons-logging、log4j、log4j2、logback等，这些都是比较主流的日志实现。SpringBoot对上述主流的日志实现都做了很好的支持，这样以来我们在使用日志框架时就显得有些困惑了，怎么样选择日志框架，才是最优配置。  
其实最优配置是相对的，不过我们可以根据SpringBoot“约定优于配置”的理念作为指导，来选择适合自己的日志框架。默认情况下，当我们使用启动类来构建项目时，SpringBoot使用logback来记录日志。

# 基础配置 #

在使用SpringBoot时收集日志时，如果你对日志的显示格式以及日志文件的输出内容没有特殊的要求时，我们都甚至不需要定义日志实现框架的配置文件，只需在SpringBoot的配置文件中添加基本日志配置即可满足我们的需求，当然这些配置项有些只是针对默认的logback才生效，基础配置项列表如下：

debug=false
    trace=false
    # LOGGING
    logging.config=
    logging.exception-conversion-word=%wEx
    logging.file=
    logging.file.max-history=0
    logging.file.max-size=10MB
    logging.group.*=
    logging.level.*=
    logging.path=
    logging.pattern.console=
    logging.pattern.dateformat=yyyy-MM-dd HH:mm:ss.SSS
    logging.pattern.file=
    logging.pattern.level=%5
    plogging.register-shutdown-hook=false

## 1、debug、trace属性 ##

默认false，如果为true，则表示打开调试或跟踪模式，调试或跟踪模式只针对SpringBoot系统内部日志，并不是所有的日志都以debug级别显示，比如我们手动通过api输出的日志就不受影响。

## 2、logging.config属性 ##

该属性指定日志配置文件的所在位置，默认会从classpath的根路径加载，如果两种方式都没有指定，则根据日志框架实现类型加载默认的日志配置文件（在框架内部）。

## 3、logging.exception-conversion-word属性 ##

默认值“%wEx”，主要用彩色异常日志的格式化，不常用。

## 4、logging.file属性 ##

只有在SpringBoot默认的日志配置下此属性才有意义，它指定日志文件生成的完整路径或相对路径。如果是ide运行项目则相对路径以src为基准，如果是可执行jar包，则以jar包为基准。

## 5、logging.path属性 ##

只有在SpringBoot默认的日志配置下此属性才有意义，它指定生成的日志文件所在的文件夹的完整路径或相对路径，相对路径的基准目录同上。如果使用此属性，则生成的日志文件名称固定，为spring.log，而且如果同时配置了logging.file属性，则以logging.file属性配置位为准。

## 6、logging.file.max-size属性 ##

此属性只在默认日志实现为logback并且loggin.file属性启用之后才生效，表示日志文件的大小，单位MB。如果日志文件超过此设置的之后，会自动生成一个压缩包，压缩包的命名规则：日志文件名称.log.xxxx-xx-xx.num。

## 7、logging.file.max-history属性 ##

此属性只在默认日志实现为logback并且loggin.file属性启用之后才生效，表示生成的日志文件压缩包的存档时间，默认是0，表示永远存档，如果大于0表示最多保留x天。该属性只在6属性存在的情况下才有意义。

## 8、logging.group属性 ##

此属性表示的是一个日志组，它的作用在于方便的控制某个组下的日志级别，例如：

#定义com.icypt.controller包下的日志，统一由controller组管理
    logging.group.controller=com.icypt.controller
    #控制日志组日志级别
    loggin.level.contoller=info

SpringBoot也预定义了一些日志组，如下：

logging.group.web=org.springframework.core.codec, org.springframework.http, org.springframework.web, org.springframework.boot.actuate.endpoint.web, org.springframework.boot.web.servlet.ServletContextInitializerBeans
    logging.group.sql=org.springframework.jdbc.core, org.hibernate.SQL

所以我们在以后调试SpringBoot项目时可以通过这些预定义组来临时修改日志级别，岂不是很方便。

## 9、logging.level属性 ##

此属性用于指定日志级别，其后可以跟root、组名称、包名称、包.类名等，例如：

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

这里有个优先级的问题需要注意一下：logging.level后跟的路径越详细优先级越高：

logging.level.包.类 > logging.level.包 > logging.level.组 > logging.level.root

## 10、格式化属性 ##

logging.pattern.console= \#格式化控制台打印的日志  
logging.pattern.dateformat=yyyy-MM-dd HH:mm:ss.SSS \#格式化日志日期时间  
logging.pattern.file= \#格式化输出到文件的日志  
logging.pattern.level=%5p \#格式化日志级别

## 11、logging.register-shutdown-hook属性 ##

此属性默认值false，目前还未使用过此属性，不知其使用场景是什么，各位学友有谁知道，在公众号留言告诉我一下。  
那么，如果你对日志记录要求不是很高，采用SpringBoot默认的logback日志框架再加上一些自定义的属性配置就可以完成日志的搜集工作了。如果以上这些设置还不能满足你的需求，就得自定义logback的配置文件了，当然也可以集成其他日志框架。

# 自定义日志配置文件 #

由于SpringBoot默认支持Logback日志实现框架，所以我们要做的就是定义其配置文件，并放置指定的路径下即可，这个配置文件的存放路径，在上述的基础配置中已经提到过，这里就不赘述了。

## 1、定义logback配置文件 ##

为了使我们的配置文件结构更加清晰，这里将logback的配置文件根据其不同的功能进行分解整合。  
**配置文件一、logback入口配置文件，命名为logback-init.xml**

<?xml version="1.0" encoding="UTF-8"?>
    
    
    
    
    
    <configuration scan="true" scanPeriod="10 seconds">
       
       <property name="log.path" value="D:/sboot/logs/" />
       
       <property name="log.file.prefix" value="sboot" />
    
       
       <include resource="logback/defaults.xml" />
       <include resource="logback/console-appender.xml" />
       <include resource="logback/file-appender.xml" />
    
       
       <root level="INFO">
          
          <appender-ref ref="CONSOLE" />
          <appender-ref ref="FILE_INFO" />
          <appender-ref ref="FILE_ERROR" />
       </root>
    </configuration>

**配置文件二，logback默认配置文件，命名为default.xml**

<?xml version="1.0" encoding="UTF-8"?>
    
    <included>
       
       <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{${LOG_DATEFORMAT_PATTERN:-yyyy-MM-dd HH:mm:ss.SSS}}){faint} %clr(${LOG_LEVEL_PATTERN:-%5p}) %clr(${PID:- }){magenta} %clr(---){faint} %clr([%15.15t]){faint} %clr(%-40.40logger{39}){cyan} %clr(:){faint} %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}}"/>
       
       <property name="FILE_LOG_PATTERN" value="${FILE_LOG_PATTERN:-%d{${LOG_DATEFORMAT_PATTERN:-yyyy-MM-dd HH:mm:ss.SSS}} ${LOG_LEVEL_PATTERN:-%5p} ${PID:- } --- [%t] %-40.40logger{39} : %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}}"/>
       
       <logger name="org.apache.catalina.startup.DigesterFactory" level="ERROR"/>
       <logger name="org.apache.catalina.util.LifecycleBase" level="ERROR"/>
       <logger name="org.apache.coyote.http11.Http11NioProtocol" level="WARN"/>
       <logger name="org.apache.sshd.common.util.SecurityUtils" level="WARN"/>
       <logger name="org.apache.tomcat.util.net.NioSelectorPool" level="WARN"/>
       <logger name="org.eclipse.jetty.util.component.AbstractLifeCycle" level="ERROR"/>
       <logger name="org.hibernate.validator.internal.util.Version" level="WARN"/>
    </included>

**配置文件三、logback控制台日志输出配置文件，命名为console-appender.xml**

<?xml version="1.0" encoding="UTF-8"?>
    
    <included>
       <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
          <encoder>
             <pattern>${ CONSOLE_LOG_PATTERN}</pattern>
             
             <charset>UTF-8</charset>
          </encoder>
       </appender>
    </included>

**配置文件四、logback文件日志输出配置文件，命名为file-appender.xml**

<?xml version="1.0" encoding="UTF-8"?>
    <included>
    
       
       <appender name="FILE_INFO"
          class="ch.qos.logback.core.rolling.RollingFileAppender">
          <encoder>
             
             <pattern>${ FILE_LOG_PATTERN}</pattern>
             
             <charset>UTF-8</charset>
          </encoder>
          
          <file>${ log.path}${ log.file.prefix}_info.log</file>
          
          <filter class="ch.qos.logback.classic.filter.LevelFilter">
             
             <level>ERROR</level>
             
             <onMatch>DENY</onMatch>
             
             <onMismatch>ACCEPT</onMismatch>
          </filter>
          
          <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
             
             <fileNamePattern>${ log.path}/${ log.file.prefix}_info_%d{ yyyy-MM-dd}_%i.gz</fileNamePattern>
             
             <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>1MB</maxFileSize>
             </timeBasedFileNamingAndTriggeringPolicy>
             
             <maxHistory>120</maxHistory>
          </rollingPolicy>
       </appender>
    
       
       <appender name="FILE_ERROR"
               class="ch.qos.logback.core.rolling.RollingFileAppender">
          <encoder>
             
             <pattern>${ FILE_LOG_PATTERN}</pattern>
             
             <charset>UTF-8</charset>
          </encoder>
          
          <file>${ log.path}${ log.file.prefix}_error.log</file>
          
          <filter class="ch.qos.logback.classic.filter.LevelFilter">
             <level>ERROR</level>
             <onMatch>ACCEPT</onMatch>
             <onMismatch>DENY</onMismatch>
          </filter>
          
          <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
             
             <fileNamePattern>${ log.path}/${ log.file.prefix}_error_%d{ yyyy-MM-dd}_%i.gz</fileNamePattern>
             
             <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>1MB</maxFileSize>
             </timeBasedFileNamingAndTriggeringPolicy>
             
             <maxHistory>120</maxHistory>
          </rollingPolicy>
       </appender>
    </included>

以上四个配置文件由logback-init.xml文件作为统一入口进行整合，使得日志配置结构更加简单明了，这也是对SpringBoot默认配置的一种学习和参考。关于配置文件的说明，看注释就好，这里就不赘述了。

## 2、在SpringBoot属性配置中定义logback入口配置文件位置 ##

#定义日志配置文件路径
    logging.config=classpath:./logback/logback-init.xml

## 3、温馨提示 ##

1>、一旦我们自定义了日志配置文件，则之前在用于logback默认配置的基础属性都将失效，原则上自定义配置文件已经涵盖了之间所述的默认配置属性，所以并无大碍。  
2>、Spring日志的初始化先与SpringBoot上下文的加载，所以不能在配置类中使用@PropertySource来获取属进行日志的控制。  
3>、如果想要把配置文件置于可执行jar包的外部，只需对上述配置稍作修改即可：  
**修改一、SpringBoot属性配置文件**

#定义日志配置文件路径，file的基准在ide中是项目根目录，在可执行jar文件中与就是其本身
    logging.config=file:./logback/logback-init.xml
    或者
    logging.config=完整路径

**修改二、Logback入口配置文件**

<include file="./logback/defaults.xml"/>
    <include file="./logback/console-appender.xml"/>
    <include file="./logback/file-appender.xml"/>

至此，关于SpringBoot中Logback日志框架的使用就说清楚了，各位小伙伴赶快去实践吧！

> 更多最新技术文章，请关注“冰点IT”公众号