日志系列2——logback配置文件详解

Posted 码农小陈

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了日志系列2——logback配置文件详解相关的知识，希望对你有一定的参考价值。

1.logback 配置文件的组成

1.1 root节点

  root 节点是必选节点，用来指定最基础的日志输出级别，只有一个 level 属性，用于设置打印级别，可选如下：TRACE,DEBUG,INFO,WARN,ERROR,ALL,OFF。

  root 节点可以包含 0 个或多个元素，将appender添加进来。如下：

 
   
   
 
    
  
    
    
  
  1. <root level="debug">
    2. 
  
    
    
  
  2.  <appender-ref ref="console" />
    3. 
  
    
    
  
  3.  <appender-ref ref="file" />
    4. 
  
    
    
  
  4. </root>
    5.

appender 也是子节点之一，将会在后面说明。

1.2 property节点

  用于定义变量，方便使用。有两个属性：name,value。定义变量后，可以使用${}来使用变量。如下：

 
   
   
 
    
  
    
    
  
  1. <property name="path" value="./log"/>
    2. 
  
    
    
  
  2. <property name="appname" value="app"/>
    3.

1.3 appender节点

appender中有2个必填属性--name和class。name为节点的名称，class为的全限定类名，也就是日志输出目的地的处理类。其中，encoder子节点用来控制日志的输出格式

 
   
   
 
    
  
    
    
  
  1. <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender"> 
    2. 
  
    
    
  
  2.  <encoder> 
    3. 
  
    
    
  
  3.  <pattern>%-4relative [%thread] %-5level %logger{35} - %msg %n</pattern> 
    4. 
  
    
    
  
  4.  </encoder> 
    5. 
  
    
    
  
  5. </appender> 
    6.

appender 用来格式化日志输出的节点，这个最重要。有两个属性：

  • name:该本 appender 命名

  • class:指定输出策略，通常有两种：控制台输出，文件输出

下面通过例子来说明这个怎么用：

在logback中，主要有以下三种日志目的地处理类：

1.3.1 ch.qos.logback.core.ConsoleAppender

将日志输出到控制台

 
   
   
 
    
  
    
    
  
  1. <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender"> 
    2. 
  
    
    
  
  2.  <encoder> 
    3. 
  
    
    
  
  3.  <pattern>%-4relative [%thread] %-5level %logger{35} - %msg %n</pattern> 
    4. 
  
    
    
  
  4.  </encoder> 
    5. 
  
    
    
  
  5. </appender> 
    6.
1.3.2 ch.qos.logback.core.FileAppender

将日志输出到具体的磁盘文件中，可以单独指定具体的位置，也可以设置日志的输出格式；

 
   
   
 
    
  
    
    
  
  1. <appender name="FILE" class="ch.qos.logback.core.FileAppender"> 
    2. 
  
    
    
  
  2.  <file>e:/log.out</file> 
    3. 
  
    
    
  
  3.  <append>true</append> 
    4. 
  
    
    
  
  4.  <prudent>false</prudent>
    5. 
  
    
    
  
  5.  <encoder> 
    6. 
  
    
    
  
  6.  <pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern> 
    7. 
  
    
    
  
  7.  </encoder> 
    8. 
  
    
    
  
  8. </appender> 
    9.

子节点append：新增的日志是否以追加到文件结尾的方式写入到log.out文件中，true为追加，fasle为清空现存文件写入；子节点prudent：日志是否被安全的写入磁盘文件，默认为false。如果为true，则效率低下；

1.3.3 ch.qos.logback.core.rolling.RollingFileAppender

滚动记录日志，当符合rollingPolicy节点中设置的条件时，会将现有日志移到新的文件中去。rollingPolicy节点中可设置的条件为：文件的大小、时间等；

 
   
   
 
    
  
    
    
  
  1. <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
    2. 
  
    
    
  
  2.  <file>e:/log.out</file>
    3. 
  
    
    
  
  3.  <append>true</append> 
    4. 
  
    
    
  
  4.  <prudent>false</prudent>
    5. 
  
    
    
  
  5.  <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
    6. 
  
    
    
  
  6.  <fileNamePattern>testLog-%d{yyyy-MM-dd}.log</fileNamePattern>
    7. 
  
    
    
  
  7.  <maxHistory>30</maxHistory>
    8. 
  
    
    
  
  8.  </rollingPolicy>
    9. 
  
    
    
  
  9.  <encoder>
    10. 
  
    
    
  
  10.  <pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern>
    11. 
  
    
    
  
  11.  </encoder>
    12. 
  
    
    
  
  12. </appender>
    13.
1.3.4 ch.qos.logback.classic.AsyncAppender

异步记录日志，内部通过使用缓存的方式来实现异步打印，将日志打印事件event放入缓存中。具体数据结构为BlockingQueue；

 
   
   
 
    
  
    
    
  
  1. <appender name="FILE" class="ch.qos.logback.core.FileAppender"> 
    2. 
  
    
    
  
  2.  <file>e:/log.out</file> 
    3. 
  
    
    
  
  3.  <append>true</append> 
    4. 
  
    
    
  
  4.  <prudent>false</prudent>
    5. 
  
    
    
  
  5.  <encoder> 
    6. 
  
    
    
  
  6.  <pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern> 
    7. 
  
    
    
  
  7.  </encoder> 
    8. 
  
    
    
  
  8. </appender> 
    9. 
  
    
    
  
  9. <appender name ="ASYNC" class= "ch.qos.logback.classic.AsyncAppender"> 
    10. 
  
    
    
  
  10.  <discardingThreshold>0</discardingThreshold> 
    11. 
  
    
    
  
  11.  <queueSize>512</queueSize> 
    12. 
  
    
    
  
  12.  <appender-ref ref ="FILE"/> 
    13. 
  
    
    
  
  13. </appender> 
    14.

子节点queueSize：指的是BlockingQueue的队列容量大小，默认为256个；子节点discardingThreshold：如果BlockingQueue中还剩余20%的容量，那么程序会丢弃TRACE、DEBUG和INFO级别的日志打印事件event，只保留WARN和ERROR级别的。为了保留所有的日志打印事件，可以将该值设置为0。

1.3.5 rollingPolicy

日志文件的滚动策略，与RollingFileAppender搭配使用，当日志文件发生变动时决定RollingFileAppender的行为。在rollingPolicy节点中有一个class属性，可选的值为TimeBasedRollingPolicy、FixedWindowRollingPolicy、TriggeringPolicy。其中ch.qos.logback.core.rolling.TimeBasedRollingPolicy表示根据时间制定日志文件的滚动策略；

 
   
   
 
    
  
    
    
  
  1. <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
    2. 
  
    
    
  
  2.  <fileNamePattern>testLog-%d{yyyy-MM-dd}.log</fileNamePattern>
    3. 
  
    
    
  
  3.  <maxHistory>30</maxHistory>
    4. 
  
    
    
  
  4. </rollingPolicy>
    5.

ch.qos.logback.core.rolling.FixedWindowRollingPolicy表示如果日志文件大小超过指定范围时，会根据文件名拆分成多个文件；

 
   
   
 
    
  
    
    
  
  1. <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy"> 
    2. 
  
    
    
  
  2.  <fileNamePattern>tests.%i.log.zip</fileNamePattern> 
    3. 
  
    
    
  
  3.  <minIndex>1</minIndex> 
    4. 
  
    
    
  
  4.  <maxIndex>4</maxIndex> 
    5. 
  
    
    
  
  5.  </rollingPolicy> 
    6.

2.配置文件例子

 
   
   
 
    
  
    
    
  
  1. <?xml version="1.0" encoding="UTF-8"?>
    2. 
  
    
    
  
  2. <configuration debug="false">
    3. 
  
    
    
  
  3.  <!--设置存储路径变量-->
    4. 
  
    
    
  
  4.  <property name="LOG_HOME" value="./log"/>
    5. 
  
    
    
  

    6. 
  
    
    
  
  6.  <!--控制台输出appender-->
    7. 
  
    
    
  
  7.  <appender name="console" class="ch.qos.logback.core.ConsoleAppender">
    8. 
  
    
    
  
  8.  <!--设置输出格式-->
    9. 
  
    
    
  
  9.  <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
    10. 
  
    
    
  
  10.  <!--格式化输出：%d表示日期，%thread表示线程名，%-5level：级别从左显示5个字符宽度%msg：日志消息，%n是换行符-->
    11. 
  
    
    
  
  11.  <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
    12. 
  
    
    
  
  12.  <!--设置编码-->
    13. 
  
    
    
  
  13.  <charset>UTF-8</charset>
    14. 
  
    
    
  
  14.  </encoder>
    15. 
  
    
    
  
  15.  </appender>
    16. 
  
    
    
  

    17. 
  
    
    
  
  17.  <!--文件输出,时间窗口滚动-->
    18. 
  
    
    
  
  18.  <appender name="timeFileOutput" class="ch.qos.logback.core.rolling.RollingFileAppender">
    19. 
  
    
    
  
  19.  <!--日志名,指定最新的文件名，其他文件名使用FileNamePattern -->
    20. 
  
    
    
  
  20.  <File>${LOG_HOME}/timeFile/out.log</File>
    21. 
  
    
    
  
  21.  <!--文件滚动模式-->
    22. 
  
    
    
  
  22.  <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
    23. 
  
    
    
  
  23.  <!--日志文件输出的文件名,可设置文件类型为gz,开启文件压缩-->
    24. 
  
    
    
  
  24.  <FileNamePattern>${LOG_HOME}/timeFile/info.%d{yyyy-MM-dd}.%i.log.gz</FileNamePattern>
    25. 
  
    
    
  
  25.  <!--日志文件保留天数-->
    26. 
  
    
    
  
  26.  <MaxHistory>30</MaxHistory>
    27. 
  
    
    
  
  27.  <!--按大小分割同一天的-->
    28. 
  
    
    
  
  28.  <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
    29. 
  
    
    
  
  29.  <maxFileSize>10MB</maxFileSize>
    30. 
  
    
    
  
  30.  </timeBasedFileNamingAndTriggeringPolicy>
    31. 
  
    
    
  
  31.  </rollingPolicy>
    32. 
  
    
    
  

    33. 
  
    
    
  
  33.  <!--输出格式-->
    34. 
  
    
    
  
  34.  <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
    35. 
  
    
    
  
  35.  <!--格式化输出：%d表示日期，%thread表示线程名，%-5level：级别从左显示5个字符宽度%msg：日志消息，%n是换行符-->
    36. 
  
    
    
  
  36.  <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
    37. 
  
    
    
  
  37.  <!--设置编码-->
    38. 
  
    
    
  
  38.  <charset>UTF-8</charset>
    39. 
  
    
    
  
  39.  </encoder>
    40. 
  
    
    
  

    41. 
  
    
    
  
  41.  </appender>
    42. 
  
    
    
  
  42.  <!-- 异步输出 -->
    43. 
  
    
    
  
  43.  <appender name="ASYNC-INFO" class="ch.qos.logback.classic.AsyncAppender">
    44. 
  
    
    
  
  44.  <!-- 不丢失日志.默认的,如果队列的80%已满,则会丢弃TRACT、DEBUG、INFO级别的日志 -->
    45. 
  
    
    
  
  45.  <discardingThreshold>0</discardingThreshold>
    46. 
  
    
    
  
  46.  <!-- 更改默认的队列的深度,该值会影响性能.默认值为256 -->
    47. 
  
    
    
  
  47.  <queueSize>256</queueSize>
    48. 
  
    
    
  
  48.  <!-- 添加附加的appender,最多只能添加一个 -->
    49. 
  
    
    
  
  49.  <appender-ref ref="timeFileOutput"/>
    50. 
  
    
    
  
  50.  </appender>
    51. 
  
    
    
  
  51.  <!--指定基础的日志输出级别-->
    52. 
  
    
    
  
  52.  <root level="INFO">
    53. 
  
    
    
  
  53.  <!--appender将会添加到这个loger-->
    54. 
  
    
    
  
  54.  <appender-ref ref="console"/>
    55. 
  
    
    
  
  55.  <appender-ref ref="timeFileOutput"/>
    56. 
  
    
    
  
  56.  </root>
    57. 
  
    
    
  
  57. </configuration>
    58.

3 spring boot 使用logback日志

SpringBoot工程自带logback和slf4j的依赖，所以只要在maven依赖中添加了spring-boot-starter-logging即可。logback框架会默认加载classpath下命名为logback-spring或logback的配置文件。

 
   
   
 
    
  
    
    
  
  1. <dependency>
    2. 
  
    
    
  
  2.  <groupId>org.springframework.boot</groupId>
    3. 
  
    
    
  
  3.  <artifactId>spring-boot-starter-logging</artifactId>
    4. 
  
    
    
  
  4. </dependency>
    5.

3.1 简单使用

如果无需复杂的日志配置，执行简单设置日志打印级别，打印方式可直接在application.yml 中配置。

 
   
   
 
    
  
    
    
  
  1. logging:
    2. 
  
    
    
  
  2.  # 配置日志存放路径,日志文件名为：spring.log
    3. 
  
    
    
  
  3.  path: e:/log
    4. 
  
    
    
  
  4.  file:
    5. 
  
    
    
  
  5.  # 设置日志文件大小
    6. 
  
    
    
  
  6.  max-size: 20MB
    7. 
  
    
    
  
  7.  level:
    8. 
  
    
    
  
  8.  # root日志以info级别输出
    9. 
  
    
    
  
  9.  root: info
    10. 
  
    
    
  
  10.  # 此包下所有class以DEBUG级别输出
    11. 
  
    
    
  
  11.  com.demo.test: debug
    12.

3.2 多环境日志输出

Spring Boot 官方推荐优先使用带有 -spring 的文件名作为你的日志配置（如使用 logback-spring.xml ，而不是 logback.xml ），命名为 logback-spring.xml 的日志配置文件， spring boot 可以为它添加一些 spring boot 特有的配置项示例如下：

 
   
   
 
    
  
    
    
  
  1. <configuration>
    2. 
  
    
    
  
  2.  <!-- 测试环境+开发环境. 多个使用逗号隔开. -->
    3. 
  
    
    
  
  3.  <springProfile name="test,dev">
    4. 
  
    
    
  
  4.  <logger name="com.test.demo" level="DEBUG" additivity="false">
    5. 
  
    
    
  
  5.  <appender-ref ref="console"/>
    6. 
  
    
    
  
  6.  </logger>
    7. 
  
    
    
  
  7.  </springProfile>
    8. 
  
    
    
  
  8.  <!-- 生产环境. -->
    9. 
  
    
    
  
  9.  <springProfile name="prod">
    10. 
  
    
    
  
  10.  <logger name="com.test.demo" level="INFO" additivity="false">
    11. 
  
    
    
  
  11.  <appender-ref ref="timeFileOutput"/>
    12. 
  
    
    
  
  12.  </logger>
    13. 
  
    
    
  
  13.  </springProfile>
    14. 
  
    
    
  
  14. </configuration>
    15.

    下一章节《日志系列3——如何通过日志跟踪号快速定位日志》敬请期待。如果你觉得我写的还不错，请点击右下角 在看 按钮

以上是关于日志系列2——logback配置文件详解的主要内容，如果未能解决你的问题，请参考以下文章

Spring Boot 2 中的默认日志管理与 Logback 配置详解

Spring Boot 2 中的默认日志管理与 Logback 配置详解

java日志框架系列：logback框架过滤器（filter）详解

源码详解系列 ------ 全面讲解logback的使用和源码

slf4j 与 logback日志配置详解

Spring Boot系列一:默认日志logback配置解析