logback新认识(一)：主要组件appender、rollingPolicy和triggeringPolicy的使用和理解

vlambda
2020-08-26

logback新认识(一)：主要组件appender、rollingPolicy和triggeringPolicy的使用和理解

更多干货及时获取

logback日志必备。平时在新建项目的时候都是 Ctrl+C和 Ctrl+V，完全不要自己做什么，不管使用Springmvc还是Springboot都不需要配置 logback.xml文件的位置，直接将 logback.xml放到resources目录下，命令符合要求即可。但是真正懂或者了解logback里面的各项配置的却少之又少。现在工作闲暇时间看了一下官方的文档，然后自己操作一下，算是入门，不再像之前那么懵比。

logback的主要组成部分

appender，是用来定义一个写日志记录的组件，常用的appender类有 ConsoleAppender和 RollingFileAppender，前者是用来在控制台上打印日志，后者是将日志输出到文件中。
layout，是指定日志的布局方式，这个基本都不会去特殊的指定，可以忽略，知道有这个东西即可。
encoder，负责把事件转换成字节数组并把字节数组写到合适的输出流。 encoder可以指定属性值 class，这里对应的类只有一个 PatternLayoutEncoder，也是默认值，可以不去指定。
filter，过滤器分为三种，logback-classic提供的是两种，分别是常规的过滤器和Turbo过滤器。常用的过滤器就是按照日志级别来控制，将不同级别的日志输出到不同文件中，便于查看日志。如：错误日志输出到 xxx-error.log，info日志输出到 xxx-info.log中。
rollingPolicy，用来设置日志的滚动策略，当达到条件后会自动将条件前的日志生成一个备份日志文件，条件后的日志输出到最新的日志文件中。常用的是按照时间来滚动（使用的类 TimeBaseRollingPolicy）,还有一种就是基于索引来实现（使用的类 FixedWindowRollingPolicy）。
triggeringPolicy，日志触发器策略，常用的是日志的大小的控制，当日志达到对应的大小的时候，就会触发。生成新的日志文件。日志大小的控制配合 rollingPlicy使用的时候，不同的 rollingPolicy会有所不同。

上面就是常用的几个组成部分，下面来各个说明一下。

logback组成部分详解

Appender

定义日志组件:（具体结束看代码注释）

 
   
   
 
  
    
    
  <!--
  
    
    
  打印在控制台上的日志，日志的encoder是默认的PatternLayoutEncoder，具体的pattern通过标签指定
  
    
    
  appender对应的class类型使用的是ConsoleAppender
  
    
    
   -->
  
    
    
  <appender name="console" class="ch.qos.logback.core.ConsoleAppender">
  
    
    
   <encoder>
  
    
    
   <pattern>【logbck】%blue([requestId:%X{requestId:-syslogId}]) %d{yyyy-MM-dd HH:mm:ss.SSS} %red([%thread]) %5level - %msg%n</pattern>
  
    
    
   </encoder>
  
    
    
  </appender>

rollingPolicy & triggeringPolicy

rollingPolicy对应是时间滚动策略的日志文件定义:

 
   
   
 
  
    
    
  <!-- 滚动文件的方式生成日志日志文件，文件的存储位置通过file标签指定 -->
  
    
    
  <!-- 通过encoder指定日志的生成格式,每个appender的日志格式都可以自定义，不用相同 -->
  
    
    
  <appender name="file" class="ch.qos.logback.core.rolling.RollingFileAppender">
  
    
    
   <file>/logback/log/test.log</file>
  
    
    
   <encoder>
  
    
    
   <pattern>【logbck】%blue([requestId:%X{requestId:-syslogId}]) %d{yyyy-MM-dd HH:mm:ss.SSS} %red([%thread]) %5level - %msg%n</pattern>
  
    
    
   </encoder>
  
    
    
   <!--
  
    
    
   通过rollingPolicy设置日志滚动的策略，这是使用按照时间滚动
  
    
    
   fileNamePattern属性设置滚动生成文件的格式,这里设置的精确到天，也就是按照天滚动，如果时间设置精确到秒，就按秒来滚动
  
    
    
   maxHistory属性设定最大的文件数，比如按天滚动，这里设置了30天，在第31天日志生成的时候，第一天的日志就会被删掉
  
    
    
   -->
  
    
    
   <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
  
    
    
   <fileNamePattern>/logback/log/test-%d{yyyy-MM-dd}.log</fileNamePattern>
  
    
    
   <maxHistory>30</maxHistory>
  
    
    
   </rollingPolicy>
  
    
    
  </appender>

说明：fileNamePattern是要格外说明的。如上我设置按天来滚动，前一天日志打印到23点59分，然后就一直没有请求日志，直到次日的1点才有新的日志进入。在0点到1点这个时间段，日志文件是不会滚动生成新的日志文件。因为滚动的动作是需要日志写入动作来触发。

上面是根据时间滚动，下面看一下根据索引滚动。

rollingPolicy对应是索引滚动策略的日志文件定义：

 
   
   
 
  
    
    
  <!-- 设置为按照索引的方式滚动，定义文件名称的时候使用%i作为占位符，滚动后会会用角标替换 -->
  
    
    
  <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
  
    
    
   <fileNamePattern>/logback/log/test-%i.log</fileNamePattern>
  
    
    
   <minIndex>1</minIndex>
  
    
    
   <maxIndex>3</maxIndex>
  
    
    
  </rollingPolicy>
  
    
    
  <!-- 指定文件最大尺寸，达到该尺寸，就触发rollingPolicy对应的策略，maxFileSize属性指定文件大小 -->
  
    
    
  <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
  
    
    
   <maxFileSize>1MB</maxFileSize>
  
    
    
  </triggeringPolicy>

说明：

maxIndex不可设置为过大，过大后会自动被置为默认值12，这个过大的值具体是多少没测试过（欢迎小伙伴测试后在文末回复一下，就偷个懒了）。
第一次滚动，生成test-1.log，第二次滚动时会将之前的test-1.log文件修改成test-2.log，将最新生成的日志文件命名为test-1.log，依此类推，指导索引达到设置的最大值。当超过最大值的时候，会将索引最大的文件直接删除，用前一个文件移到最后一位。就像传送带，最先放上的物品会最先掉出传送带。
在时间滚动的方式里面，可以用时间作为触发机制。但是在使用索引方式的时候，需要定义一个 triggeringPolicy作为触发机制。

rollingPolicy对应的是时间策略并配合文件大小触发器来实现日志文件定义：

 
   
   
 
  
    
    
  <!-- 使用按照时间滚动策略，内嵌按照文件大小来分隔日志的触发器策略 -->
  
    
    
  <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
  
    
    
   <fileNamePattern>/logback/log/test-%d{yyyy-MM-dd}-%i.log</fileNamePattern>
  
    
    
   <!-- 使用SizeAndTimeBasedFNATP实现，可以看一下TimeBasedRollingPolicy源码中对应timeBasedFileNamingAndTriggeringPolicy的类型，根据类型确定需要使用的class类 -->
  
    
    
   <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
  
    
    
   <maxFileSize>1MB</maxFileSize>
  
    
    
   </timeBasedFileNamingAndTriggeringPolicy>
  
    
    
  </rollingPolicy>

说明：按照时间滚动的单位是天，按照文件大小的滚动是1M，当今天产生的日志大小是5M，就会生成5个日志文件，每个文件对应的大小是1M，对应生成日期是一天，对应的编号不同，也就是 %i占位符替换后的编号(从0开始)。

filter

过滤器，根据日志类型将日志输出到不同的日志文件中。文件定义如下：

 
   
   
 
  
    
    
  <!-- info级别日志会输出到test-info.log日志文件中 -->
  
    
    
  <appender name="info-log" class="ch.qos.logback.core.rolling.RollingFileAppender">
  
    
    
   <file>/logback/log/test-info.log</file>
  
    
    
   <encoder>
  
    
    
   <pattern>【logbck】%blue([requestId:%X{requestId:-syslogId}]) %d{yyyy-MM-dd HH:mm:ss.SSS} %red([%thread]) %5level - %msg%n</pattern>
  
    
    
   </encoder>
  
    
    
   <!-- filter过滤器，INFO级别 -->
  
    
    
   <filter class="ch.qos.logback.classic.filter.LevelFilter">
  
    
    
   <level>INFO</level>
  
    
    
   <onMatch>ACCEPT</onMatch>
  
    
    
   <onMismatch>DENY</onMismatch>
  
    
    
   </filter>
  
    
    
  </appender>
  
    
    
  <!-- error级别日志会输出到test-error.log日志文件中 -->
  
    
    
  <appender name="info-error" class="ch.qos.logback.core.rolling.RollingFileAppender">
  
    
    
   <file>/logback/log/test-error.log</file>
  
    
    
   <encoder>
  
    
    
   <pattern>【logbck】%blue([requestId:%X{requestId:-syslogId}]) %d{yyyy-MM-dd HH:mm:ss.SSS} %red([%thread]) %5level - %msg%n</pattern>
  
    
    
   </encoder>
  
    
    
   <!-- filter过滤器，ERROR级别 -->
  
    
    
   <filter class="ch.qos.logback.classic.filter.LevelFilter">
  
    
    
   <level>ERROR</level>
  
    
    
   <onMatch>ACCEPT</onMatch>
  
    
    
   <onMismatch>DENY</onMismatch>
  
    
    
   </filter>
  
    
    
  </appender>

不同appender对应不同的日志组件，常规操作，不多说。

总结

其实logback里面的东西还有很多，这里只说基本的操作，在日常开发中很实用的内容。至于源码什么的解析了没什么意思。遇到logback报错能够解决，遇到logback配置报错能够解决，在没有logback模板的情况下，可以徒手写一波就OK啦。

这篇文章说的是主要核心元素，接下来还会写一篇文章，写一下MDC的使用和其他酷炫的操作。

vlambda博客
学习文章列表