Logback标签介绍以及常用配置

Logback常用配置介绍

LOGBack简介

官方手册

介绍

作者Ceki Gülcü在Java日志领域世界知名。他创造了Log4J，这个最早的Java日志框架即便在JRE内置日志功能的竞争下仍然非常流行。随后他又着手实现SLF4J 这个“简单的日志前端接口（Façade）”来替代Jakarta Commons-Logging 。LOGBack，一个“可靠、通用、快速而又灵活的Java日志框架”。

• Logger可以分配的级别：TRACE、DEBUG、INFO、WARN 和 ERROR

  级别顺序为：TRACE < DEBUG < INFO < WARN < ERROR

logback的官方网站：http://logback.qos.ch

SLF4J的官方网站：http://www.slf4j.org

组成

logback当前分成三个模块：logback-core，logback- classic和logback-access。

• logback-core：其它两个模块的基础模块；
• logback- classic：log4j的一个 改良版本，完整实现SLF4J API，可以很方便地更换成其它日志系统如log4j或JDK14 Logging
• logback-access：访问模块与Servlet容器集成提供通过Http来访问日志的功能

自定义日志配置

不同的日志系统对应的日志文件命名方式

日志系统	日志文件命名方式
Logback	logback-spring.xml, logback-spring.groovy, logback.xml, logback.groovy
Log4j	log4j-spring.properties, log4j-spring.xml, log4j.properties, log4j.xml
Log4j2	log4j2-spring.xml, log4j2.xml
JDK (Java Util Logging)	logging.properties

注意：Spring Boot官方推荐优先使用带有-spring的文件名作为日志配置（如使用logback-spring.xml，而不是logback.xml），命名为logback-spring.xml的日志配置文件，spring boot可以为它添加一些spring boot特有的配置项。 默认的命名规则，并且放在 src/main/resources 下面即可。

自定义日志文件名

application.yml或者application.properties中通过修改logging.config属性指定自定义的名字

logging.config=classpath:logging-config.xml

使用

• 引入依赖，引入logback-classic会同时引入logback-core的包，相反不会

  <dependency>
    <groupId>ch.qos.logback</groupId>
    <artifactId>logback-classic</artifactId>
    <version>1.2.3</version>
  </dependency>
  

• 创建配置文件：src目录下/resource目录下

  • logback查找配置文件顺序原文在这

    a. logback首先会试着查找logback-test.xml文件;

    b. 当没有找到时，继续试着查找logback.groovy文件;

    c. 当没有找到时，继续试着查找logback.xml文件;

    d. 如果仍然没有找到，则使用默认配置（打印到控制台）。

• 清除common-logging等其他日志实现包

  • 使用命令mvn dependency:tree查看依赖树，如果有其他依赖中有common-logging、log4j或者slf4j的包，使用<exclusion>标签去除

    spring本身日志就使用的commons-logging，仅仅去掉就会使其不能正常工作，还需要添加commons logging到slf4j的桥接器jcl-over-slf4j，在项目中添加如下依赖即可

    <dependency>
        <groupId>org.slf4j</groupId>
        <artifactId>jcl-over-slf4j</artifactId>
        <version>${jcl.over.slf4j.version}</version>
    </dependency>
    

    如果有直接使用log4j的组件，也要将log4j排除掉，同时添加log4j-over-slf4

    <dependency>
        <groupId>org.slf4j</groupId>
        <artifactId>log4j-over-slf4j</artifactId>
    </dependency>
    

• 使用slf4j+logback的方案，只需要引入logback-classic即可，不再需要单独引入slf4j、logback-core模块，logback-classic依赖以上两个模块。

logback的优点(13点)

• 更快的实现 Logback的内核重写了，在一些关键执行路径上性能提升10倍以上。而且logback不仅性能提升了，初始化内存加载也更小了。
• 非常充分的测试 Logback经过了几年，数不清小时的测试。Logback的测试完全不同级别的。
• Logback-classic非常自然实现了SLF4j Logback-classic实现了 SLF4j。在使用SLF4j中，你都感觉不到logback-classic。而且因为logback-classic非常自然地实现了SLF4J， 所以切换到log4j或者其他日志框架非常容易，只需要提供成另一个jar包就OK，根本不需要去动那些通过SLF4JAPI实现的代码。
• 非常充分的文档 官方网站有两百多页的文档。
• 自动重新加载配置文件 当配置文件修改了，Logback-classic能自动重新加载配置文件。扫描过程快且安全，它并不需要另外创建一个扫描线程。这个技术充分保证了应用程序能在JEE环境里面跑得很欢。
• Lilith Lilith是log事件的观察者，和log4j的chainsaw类似。而lilith还能处理大数量的log数据 。
• 谨慎的模式和非常友好的恢复 在谨慎模式下，多个FileAppender实例跑在多个JVM下，能够安全地写到同一个日志文件。RollingFileAppender会有些限制。Logback的FileAppender和它的子类包括RollingFileAppender能够非常友好地从I/O异常中恢复。
• 配置文件可以处理不同的情况 开发人员经常需要判断不同的Logback配置文件在不同的环境下（开发，测试，生产）。而这些配置文件仅仅只有一些很小的不同，可以通过,和来实现，这样一个配置文件就可以适应多个环境。
• Filters（过滤器） 有些时候，需要诊断一个问题，需要打出日志。在log4j，只有降低日志级别，不过这样会打出大量的日志，会影响应用性能。在Logback，你可以继续保持那个日志级别而除掉某种特殊情况，如alice这个用户登录，她的日志将打在DEBUG级别而其他用户可以继续打在WARN级别。要实现这个功能只需加4行XML配置。可以参考MDCFIlter 。
• SiftingAppender（一个非常多功能的Appender） 它可以用来分割日志文件根据任何一个给定的运行参数。如，SiftingAppender能够区别日志事件跟进用户的Session，然后每个用户会有一个日志文件。
• 自动压缩已经打出来的log RollingFileAppender在产生新文件的时候，会自动压缩已经打出来的日志文件。压缩是个异步过程，所以甚至对于大的日志文件，在压缩过程中应用不会受任何影响。
• 堆栈树带有包版本 Logback在打出堆栈树日志时，会带上包的数据。
• 自动去除旧的日志文件 通过设置TimeBasedRollingPolicy或者SizeAndTimeBasedFNATP的maxHistory属性，你可以控制已经产生日志文件的最大数量。如果设置maxHistory 12，那那些log文件超过12个月的都会被自动移除。

根结点 configuration🌟

configuration 属性

• scan：当此属性设置为true时，配置文件如果发生改变，将会被重新加载，默认值为true。
• scanPeriod：设置监测配置文件是否有修改的时间间隔，如果没有给出时间单位，默认单位是毫秒。当scan为true时，此属性生效。默认的时间间隔为1分钟。
• debug：当此属性设置为true时，将打印出logback内部日志信息，实时查看logback运行状态。默认值为false。

<!-- 示例 -->
<configuration scan="true" scanPeriod="60 seconds" debug="false">  
	<!-- 其他配置省略 -->
</configuration> 

子节点们

contextName、property、appender、logger、root

子节点<contextName>

上下文名称，默认为“default”，可以通过%contextName来打印日志上下文名称，一般来说我们不用这个属性，可有可无。

<!-- 示例代码 -->
<configuration scan="true" scanPeriod="60 seconds" debug="false">  
      <contextName>myAppName</contextName>  
      <!-- 其他配置省略-->  
</configuration> 

子节点<property>

定义变量值的标签

• 有两个属性，name和value

• 通过<property>*定义的值会被插入到logger上下文中

• 通过使"${xxx}"来使用变量

  <!-- 示例代码 -->
  <configuration scan="true" scanPeriod="60 seconds" debug="false">  
        <property name="APP_Name" value="myAppName" />   
        <contextName>${APP_Name}</contextName>  
        <!-- 其他配置省略-->  
  <!-- 系统日志输出 -->
  	<appender name="file" class="ch.qos.logback.core.rolling.RollingFileAppender">
  		<file>${APP_Name}/boss.log</file>
  		<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
  			<!-- 按天回滚 daily -->
  			<fileNamePattern>${APP_Name}/boss.%d{yyyy-MM-dd}.log</fileNamePattern>
  			<!-- 日志最大的历史 30天 -->
  			<maxHistory>60</maxHistory>
  			<!--用来指定日志文件的上限大小，那么到了这个值，就会删除旧的日志-->
  			<!--<totalSizeCap>1GB</totalSizeCap>-->
  		</rollingPolicy>
  		<encoder>
  			<pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{80} - %msg%n</pattern>
  		</encoder>
  	</appender>
  </configuration> 
  

子节点<timestamp>

• 两个属性:key,datePattern

• key：​标识此<timestamp>的名字；

• datePattern：设置将当前时间（解析配置文件的时间）转换为字符串的模式，遵循java.txt.SimpleDateFormat的格式。

  <!-- 示例代码 -->
  <configuration scan="true" scanPeriod="60 seconds" debug="false">  
        <timestamp key="bySecond" datePattern="yyyyMMdd'T'HHmmss"/>   
        <contextName>${bySecond}</contextName>  
        <!-- 其他配置省略-->  
  </configuration>
  

子节点<logger>

用来设置某一个包或者具体的某一个类的日志打印级别、以及指定。

• 有一个name属性，一个可选的level和一个可选的addtivity属性
• name：用来指定受此logger约束的某一个包或者具体的某一个类（通过指定包路径/类的全路径），name范围越大，级别越高
• level：用来设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，还有一个特俗值INHERITED或者同义词NULL，代表强制执行上级的级别。如果未设置此属性，那么当前logger将会继承上级的级别
• addtivity：是否向上级logger传递打印信息。默认是true。

孙子节点：appender-ref

可以包含零个或多个元素，标识这个appender将会添加到这个logger。

子节点<root>

其实就是特殊的元素，只有一个level属性，可以包含零个或多个元素，标识这个appender将会添加到这个logger。

• level：用来设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，不能设置为INHERITED或者同义词NULL，默认是DEBUG。

3种配置方式

// 统一测试java代码
package com.logback;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class LogbackTest {
    private static Logger log = LoggerFactory.getLogger(LogbackTest_01.class);

    public static void main(String[] args) {
        log.trace("======trace");
        log.debug("======debug");
        log.info("======info");
        log.warn("======warn");
        log.error("======error");
    }
}

第1种：只配置root

<!-- 示例代码 -->
<configuration>   
   
  <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">   
    <!-- encoder 默认配置为PatternLayoutEncoder -->   
    <encoder>   
      <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>   
    </encoder>   
  </appender>   
   
  <root level="INFO">             
    <appender-ref ref="STDOUT" />   
  </root>     
 
 </configuration> 

• appender的配置表示打印到控制台

• <root level=“INFO”>将root的打印级别设置为“INFO”，指定了名字为“STDOUT”的appender

  当执行logback.LogbackTest类的main方法时，root将级别为“INFO”及大于“INFO”的日志信息交给已经配置好的名为“STDOUT”的appender处理，“STDOUT”appender将信息打印到控制台；

执行结果

17:05:08.0402 [main] INFO  com.logback.LogbackTest_01 - ======info
17:05:08.0409 [main] WARN  com.logback.LogbackTest_01 - ======warn
17:05:08.0409 [main] ERROR com.logback.LogbackTest_01 - ======error

第2种：带有logger的配置，不指定级别，不指定appender

<!-- 示例代码 -->
<configuration>

    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <!-- encoder 默认配置为PatternLayoutEncoder -->
        <encoder>
            <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
        </encoder>
    </appender>

    <!-- logback为java中的包 -->
    <logger name="logback"/>

    <root level="DEBUG">
        <appender-ref ref="STDOUT"/>
    </root>

</configuration>  

• appender的配置表示打印到控制台，配置了打印的格式

• <logger name=“logback” />将控制logback包下的所有类的日志的打印，但是并没有设置打印级别，所以继承他的上级的日志级别“DEBUG”；

• 没有设置addtivity，默认为true，将此logger的打印信息向上级传递；

• 没有设置appender，此logger本身不打印任何信息。

• <root level=“DEBUG”>将root的打印级别设置为“DEBUG”，指定了名字为“STDOUT”的appender。

  当执行logback.LogbackTest类的main方法时，因为LogbackDemo 在包logback中，所以首先执行<logger name=“logback” />，将级别为“DEBUG”及大于“DEBUG”的日志信息传递给root，本身并不打印；root接到下级传递的信息，交给已经配置好的名为“STDOUT”的appender处理，“STDOUT”appender将信息打印到控制台；

执行结果

17:14:40.041 [main] DEBUG com.logback.LogbackTest_01 - ======debug
17:14:40.047 [main] INFO  com.logback.LogbackTest_01 - ======info
17:14:40.054 [main] WARN  com.logback.LogbackTest_01 - ======warn
17:14:40.054 [main] ERROR com.logback.LogbackTest_01 - ======error

第3种：带有多个logger的配置，指定级别，指定appender

<!-- 示例代码 -->
<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <!-- encoder 默认配置为PatternLayoutEncoder -->
        <encoder>
            <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
        </encoder>
    </appender>

    <!-- logback为java中的包 -->
    <logger name="logback"/>
    <!--logback.LogbackDemo：类的全路径 -->
    <logger name="logback.LogbackTest" level="INFO" additivity="false">
        <appender-ref ref="STDOUT"/>
    </logger>

    <root level="ERROR">
        <appender-ref ref="STDOUT"/>
    </root>
</configuration>

• appender的配置表示打印到控制台，并配置了日志的输出格式

• <logger name=“logback” />将控制logback包下的所有类的日志的打印，但是并没用设置打印级别，所以继承他的上级<root>的日志级别“DEBUG”；

• 没有设置addtivity，默认为true，将此loger的打印信息向上级传递；

• 没有设置appender，此loger本身不打印任何信息。

• <logger name=“logback.LogbackDemo” level=“INFO” additivity=“false”>控制logback.LogbackDemo类的日志打印，打印级别为“INFO”；

• additivity属性为false，表示此loger的打印信息不再向上级传递，指定了名字为“STDOUT”的appender；

• <root level=“ERROR”>将root的打印级别设置为“ERROR”，指定了名字为“STDOUT”的appender;

  当执行logback.LogbackTest类的main方法时，先执行<logger name=“logback.LogbackDemo” level=“INFO” additivity=“false”>，将级别为“INFO”及大于“INFO”的日志信息交给此loger指定的名为“STDOUT”的appender处理，在控制台中打出日志，不再向次logger的上级 <logger name=“logback”/> 传递打印信息；

执行结果

17:30:30.550 [main] INFO  com.logback.LogbackTest_01 - ======info
17:30:30.553 [main] WARN  com.logback.LogbackTest_01 - ======warn
17:30:30.553 [main] ERROR com.logback.LogbackTest_01 - ======error

注意⚠️： 如果将logger的additivity="false"改为additivity=“true”，会出现下面的输出

​ **原因：**因为打印信息向上级传递，logger本身打印一次，root接到后又打印一次。

17:31:05.582 [main] INFO  com.logback.LogbackTest_01 - ======info
17:31:05.582 [main] INFO  com.logback.LogbackTest_01 - ======info
17:31:05.585 [main] WARN  com.logback.LogbackTest_01 - ======warn
17:31:05.585 [main] WARN  com.logback.LogbackTest_01 - ======warn
17:31:05.585 [main] ERROR com.logback.LogbackTest_01 - ======error
17:31:05.585 [main] ERROR com.logback.LogbackTest_01 - ======error

日志格式化标签：<appender>

appender是configuration的子节点，用于格式化日志输出，是负责写日志的组件。

• <appender>有两个必要属性name和class
• name指定appender名称
• class指定appender的全限定名
• appender日志输出方式实现类：ConsoleAppender、FileAppender、RollingFileAppender、SocketAppender、SMTPAppender、DBAppender、SyslogAppender、SiftingAppender等

日志类：ConsoleAppender

把日志添加到控制台，有两个子节点：<encoder>、<target>

• <encoder>：对日志进行格式化

• <target>：字符串 System.out 或者 System.err ，默认 System.out

  <!-- 示例代码 -->
  <?xml version="1.0" encoding="UTF-8"?>
  <configuration>  
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">  
      <encoder>  
        <pattern>%-4relative [%thread] %-5level %logger{35} - %msg %n</pattern>  
      </encoder>  
    </appender>  
    
    <root level="DEBUG">  
      <appender-ref ref="STDOUT" />  
    </root>  
  </configuration>  
  

日志类：FileAppender

把日志写入到文件中，有<file>、<append>、<encoder>、<prudent>等子节点

• <file>：被写入的文件名，可以是相对路径，也可以是绝对路径，如果上级目录不存在会自动创建，没有默认值。

• <append>：如果是 true，日志被追加到文件结尾，如果是 false，清空现存文件，默认是true。

• <encoder>：对记录事件进行格式化。（具体参数稍后讲解 ）

• <prudent>：如果是 true，日志会被安全的写入文件，即使其他的FileAppender也在向此文件做写入操作，效率低，默认是 false。

  <!-- 示例代码 -->
  <?xml version="1.0" encoding="UTF-8"?>
    <appender name="FILE" class="ch.qos.logback.core.FileAppender">
      <file>testFile.log</file>
      <append>true</append>
      <encoder>
        <pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern>
      </encoder>
    </appender>
  
    <root level="DEBUG">
      <appender-ref ref="FILE" />
    </root>
  </configuration>
  

日志类：RollingFileAppender

滚动记录文件，先将日志记录到指定文件，当符合某个条件时，将日志记录到其他文件，有<file>、<append>、<encoder>、<rollingPolicy>、<triggeringPolicy >、<prudent>

• <file>：被写入的文件名，可以是相对目录，也可以是绝对目录，如果上级目录不存在会自动创建，没有默认值。
• <append>：如果是 true，日志被追加到文件结尾，如果是 false，清空现存文件，默认是true。
• <encoder>：对记录事件进行格式化。（具体参数稍后讲解 ）
• <rollingPolicy>：当发生滚动时，决定 RollingFileAppender 的行为，涉及文件移动和重命名（重命名文件）。
• <triggeringPolicy>：告知 RollingFileAppender 何时激活滚动。
• <prudent>：当为true时，不支持FixedWindowRollingPolicy。支持TimeBasedRollingPolicy，但是有两个限制，1不支持也不允许文件压缩，2不能设置file属性，必须留空。

<rollingPolicy>

滚动写入策略，有<fileNamePattern>、<maxHistory>子节点，例如：TimeBasedRollingPolicy、FixedWindowRollingPolicy

TimeBasedRollingPolicy

最常用的滚动策略，它根据时间来制定滚动策略，既负责滚动也负责出发滚动。可以有两个参数：fileNamePattern，maxHistory

• <fileNamePattern>：必要节点，包含文件名及“%d”转换符，“%d”可以包含一个java.text.SimpleDateFormat指定的时间格式，如：%d{yyyy-MM}。如果直接使用 %d，默认格式是yyyy-MM-dd。

  RollingFileAppender 的file字节点可有可无，通过设置file，可以为活动文件和归档文件指定不同位置，当前日志总是记录到file指定的文件（活动文件），活动文件的名字不会改变；如果没设置file，活动文件的名字会根据fileNamePattern 的值，每隔一段时间改变一次。"/“或者”\"会被当做目录分隔符。

• <maxHistory>：可选节点，控制保留的归档文件的最大数量，超出数量就删除旧文件。假设设置每个月滚动，且<maxHistory>是6，则只保存最近6个月的文件，删除之前的旧文件。注意，删除旧文件是，那些为了归档而创建的目录也会被删除。

FixedWindowRollingPolicy

根据固定窗口算法重命名文件的滚动策略。子节点（参数）：minIndex、maxIndex、fileNamePattern

• <minIndex>：窗口索引最小值
• <maxIndex>：窗口索引最大值，当用户指定的窗口过大时，会自动将窗口设置为12
• <fileNamePattern>：必须包含%i，例如，假设最小值和最大值分别为1和2，命名模式为 mylog%i.log,会产生归档文件mylog1.log和mylog2.log。还可以指定文件压缩选项，例如，mylog%i.log.gz 或者log%i.log.zip

配置样例： 每天生成一个日志文件，保存30天的日志文件

<!-- 示例代码 -->
<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">

        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>logFile.%d{yyyy-MM-dd}.log</fileNamePattern>
            <maxHistory>30</maxHistory>
        </rollingPolicy>

        <encoder>
            <pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern>
        </encoder>
    </appender>

    <root level="DEBUG">
        <appender-ref ref="FILE"/>
    </root>
</configuration>

<triggeringPolicy>

查看当前活动文件的大小，如果超过指定大小会告知 RollingFileAppender 触发当前活动文件滚动，子节点（参数）：maxFileSize

涉及类例如：SizeBasedTriggeringPolicy

• <maxFileSize>：这是活动文件的大小，默认值是10MB，如果没有达到设置的文件大小，是不会将日志落地的

配置样例：按照固定窗口模式生成日志文件，当文件大于20MB时，生成新的日志文件。窗口大小是1到3，当保存了3个归档文件后，将覆盖最早的日志

<!-- 示例代码 -->
<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>test.log</file>

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

        <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
            <maxFileSize>5MB</maxFileSize>
        </triggeringPolicy>
        <encoder>
            <pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern>
        </encoder>
    </appender>

    <root level="DEBUG">
        <appender-ref ref="FILE"/>
    </root>
</configuration> 

子标签：<encoder>

负责两件事，一是把日志信息转换成字节数组，二是把字节数组写入到输出流

目前PatternLayoutEncoder 是唯一有用的且默认的encoder

有一个<pattern>节点，用来设置日志的输入格式。使用“%”加“转换符”方式，如果要输出“%”，则必须用“\”对“%”进行转义。

<encoder>
    <pattern>%d{HH:mm:ss.SSSS} %-4relative [%thread] %-5level %logger{35} - %msg%n</pattern>
</encoder>

<pattern>中转换符说明

格式修饰符，与转换符共同使用：可选的格式修饰符位于“%”和转换符之间（修饰符用来规定转换符的输入样式）。

可选修饰符:

• 左对齐 标志，符号是减号“-”；
• 最小宽度 修饰符，用十进制数表示。如果字符小于最小宽度，则左填充或右填充，默认是左填充（即右对齐），填充符为空格。如果字符大于最小宽度，字符永远不会被截断。
• 最大宽度 修饰符，符号是点号"."后面加十进制数。如果字符大于最大宽度，则从前面截断。点符号“.”后面加减号“-”在加数字，表示从尾部截断

eg：%-4relative：表示，将输出从程序启动到创建日志记录的时间进行左对齐且最小宽度为4。

RollingFileAppender参数

日志过滤器 filter🌟

过滤器（appender的子标签）：执行一个过滤器会返回个枚举值，即DENY，NEUTRAL，ACCEPT其中之一。

• 返回DENY，日志将立即被抛弃不再经过其他过滤器；
• 返回NEUTRAL，有序列表里的下个过滤器过接着处理日志；
• 返回ACCEPT，日志会被立即处理，不再经过剩余过滤器。

说明：过滤器被添加到<appender> 中，为<appender> 添加一个或多个过滤器后，可以用任意条件对日志进行过滤。<appender> 有多个过滤器时，按照配置顺序执行。

常用过滤器

LevelFilter、ThresholdFilter、EvaluatorFilter等。

LevelFilter

级别过滤器，根据日志级别进行过滤。如果日志级别等于配置级别，过滤器会根据onMath 和 onMismatch接收或拒绝日志。

子节点：

• <level>：设置过滤级别
• <onMatch>：用于配置符合过滤条件的操作，可选值：DENY，NEUTRAL，ACCEPT其中之一
• <onMismatch>：用于配置不符合过滤条件的操作，可选值：DENY，NEUTRAL，ACCEPT其中之一

<!-- 示例代码 -->
<!-- 将过滤器的日志级别配置为INFO，所有INFO级别的日志交给appender处理，非INFO级别的日志，被过滤掉 -->
<configuration>
    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>INFO</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
        <encoder>
            <pattern>
                %-4relative [%thread] %-5level %logger{30} - %msg%n
            </pattern>
        </encoder>
    </appender>
    <root level="DEBUG">
        <appender-ref ref="CONSOLE"/>
    </root>
</configuration>

ThresholdFilter

临界值过滤器，过滤掉低于指定临界值的日志。当日志级别等于或高于临界值时，过滤器返回NEUTRAL；当日志级别低于临界值时，日志会被拒绝。

子节点：

• <level>：设置过滤级别

<!-- 示例代码 -->
<!-- 过滤掉所有低于INFO级别的日志 -->
<configuration>
    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <!-- 过滤掉 TRACE 和 DEBUG 级别的日志-->
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>INFO</level>
        </filter>
        <encoder>
            <pattern>
                %-4relative [%thread] %-5level %logger{30} - %msg%n
            </pattern>
        </encoder>
    </appender>
    <root level="DEBUG">
        <appender-ref ref="CONSOLE"/>
    </root>
</configuration>

EvaluatorFilter

求值过滤器，评估、鉴别日志是否符合指定条件。需要额外的两个JAR包，commons-compiler.jar和janino.jar

子节点

• <evaluator>：鉴别器，常用的鉴别器是JaninoEventEvaluato，也是默认的鉴别器，它以任意的java布尔值表达式作为求值条件，求值条件在配置文件解释过成功被动态编译，布尔值表达式返回true就表示符合过滤条件。
  • 子标签：<expression>，用于配置求值条件。
  • 子标签：<matcher> ：匹配器，尽管<expression>中可以使用String类的matches()方法进行模式匹配，但会导致每次调用过滤器时都会创建一个新的Pattern对象，为了消除这种开销，可以预定义一个或多个matcher对象，以后就可以在求值表达式中重复引用。
    • 子标签：<name>，用于定义matcher的名字，求值表达式中使用这个名字来引用matcher；
    • 子标签：<regex>，用于配置匹配条件。
• <onMatch>：用于配置符合过滤条件的操作
• <onMismatch>：用于配置不符合过滤条件的操作

求值表达式作用于当前日志，logback向求值表达式暴露日志的各种字段如下：

<!-- 示例代码 -->
<!-- 使用<expression>过滤掉所有日志消息中不包含“billing”字符串的日志 -->
<configuration>
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <filter class="ch.qos.logback.core.filter.EvaluatorFilter">
            <evaluator> <!-- 默认为 ch.qos.logback.classic.boolex.JaninoEventEvaluator -->
                <expression>return message.contains("billing");</expression>
            </evaluator>
            <OnMatch>ACCEPT</OnMatch>
            <OnMismatch>DENY</OnMismatch>
        </filter>
        <encoder>
            <pattern>
                %-4relative [%thread] %-5level %logger - %msg%n
            </pattern>
        </encoder>
    </appender>

    <root level="INFO">
        <appender-ref ref="STDOUT"/>
    </root>
</configuration>

<!-- 示例代码 -->
<!-- 使用<matcher>过滤掉所有基数 -->
<configuration debug="true">
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <filter class="ch.qos.logback.core.filter.EvaluatorFilter">
            <evaluator>
                <matcher>
                    <name>odd</name>
                    <!-- filter out odd numbered statements -->
                    <regex>statement [13579]</regex>
                </matcher>

                <expression>odd.matches(formattedMessage)</expression>
            </evaluator>
            <OnMismatch>NEUTRAL</OnMismatch>
            <OnMatch>DENY</OnMatch>
        </filter>
        <encoder>
            <pattern>%-4relative [%thread] %-5level %logger - %msg%n</pattern>
        </encoder>
    </appender>

    <root level="DEBUG">
        <appender-ref ref="STDOUT"/>
    </root>
</configuration>

多环境日志输出

logback-spring.xml

<configuration>
    ...

    <!-- 测试环境+开发环境. 多个使用逗号隔开. -->
    <springProfile name="test,dev">
        <logger name="com.example.demo.controller" level="DEBUG" additivity="false">
            <appender-ref ref="consoleLog"/>
        </logger>
    </springProfile>

    <!-- 生产环境. -->
    <springProfile name="prod">
        <logger name="com.example.demo.controller" level="INFO" additivity="false">
            <appender-ref ref="consoleLog"/>
        </logger>
    </springProfile>
</configuration>

application.yml

application.yml增加环境选择的配置active: dev
 
server:
  port: 9010
 
spring:
  profiles:
    active: dev
  datasource:
    url: jdbc:mysql://localhost:3306/test?characterEncoding=utf8
    username: root
    password: root
 
mybatis:
    type-aliases-package: org.larry.springboot.entity
    mapper-locations: classpath:mapper/**/*.xml
    check-config-location: true
 
active: test 	// 【test、dev、prod】，根据 active 的环境，自动采用上面配置的springProfile的 logger 日志
 

自定义日志路径

application.yml增加日志相关自定义配置

logback:
  logdir: /Users/inke/dev/log/tomcat/sell
  appname: sell

在logback-spring.xml中

<?xml version="1.0" encoding="UTF-8"?>
<configuration scan="true" scanPeriod="60 seconds" debug="false">

    <!--application.yml 传递参数，不能使用logback 自带的<property>标签 -->
    <springProperty scope="context" name="appname" source="logback.appname"/>
    <springProperty scope="context" name="logdir" source="logback.logdir"/>

    <contextName>${appname}</contextName>

    <!--输出到控制台 ConsoleAppender-->
    <appender name="consoleLog" class="ch.qos.logback.core.ConsoleAppender">
        <!--展示格式 layout-->
        <layout class="ch.qos.logback.classic.PatternLayout">
            <pattern>
                <pattern>%d{HH:mm:ss.SSS} %contextName [%thread] %-5level %logger{36} - %msg%n</pattern>
            </pattern>
        </layout>
    </appender>
</configuration>

参考地址：https://blog.csdn.net/qq_36850813/article/details/83092051