logback 常用配置详解（三） <filter>

灰太狼 2023-06-30 15:57 28阅读 0赞

**`<filter>`:**  
过滤器，执行一个过滤器会有返回个枚举值，即DENY，NEUTRAL，ACCEPT其中之一。返回DENY，日志将立即被抛弃不再经过其他过滤器；返回NEUTRAL，有序列表里的下个过滤器过接着处理日志；返回ACCEPT，日志会被立即处理，不再经过剩余过滤器。  
过滤器被添加到`<Appender>` 中，为`<Appender>` 添加一个或多个过滤器后，可以用任意条件对日志进行过滤。`<Appender>` 有多个过滤器时，按照配置顺序执行。

下面是几个常用的过滤器：  
LevelFilter： 级别过滤器，根据日志级别进行过滤。如果日志级别等于配置级别，过滤器会根据onMath 和 onMismatch接收或拒绝日志。有以下子节点：  
`<level>`:设置过滤级别  
`<onMatch>`:用于配置符合过滤条件的操作  
`<onMismatch>`:用于配置不符合过滤条件的操作  
例如：将过滤器的日志级别配置为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；当日志级别低于临界值时，日志会被拒绝。

例如：过滤掉所有低于INFO级别的日志。

<configuration>   
      <appender name="CONSOLE"   
        class="ch.qos.logback.core.ConsoleAppender">   
           
        <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就表示符合过滤条件。evaluator有个子标签`<expression>`，用于配置求值条件。  
求值表达式作用于当前日志，logback向求值表达式暴露日志的各种字段：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L211c2lfbQ_size_16_color_FFFFFF_t_70]  
`<onMatch>`:用于配置符合过滤条件的操作  
`<onMismatch>`:用于配置不符合过滤条件的操作  
例如：过滤掉所有日志消息中不包含“billing”字符串的日志。

<configuration>   
       
      <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">   
        <filter class="ch.qos.logback.core.filter.EvaluatorFilter">         
          <evaluator>    
            <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>` ：  
匹配器，尽管可以使用String类的matches()方法进行模式匹配，但会导致每次调用过滤器时都会创建一个新的Pattern对象，为了消除这种开销，可以预定义一个或多个matcher对象，定以后就可以在求值表达式中重复引用。`<matcher>`是`<evaluator>`的子标签。

`<matcher>`中包含两个子标签，一个是`<name>`，用于定义matcher的名字，求值表达式中使用这个名字来引用matcher；另一个是`<regex>`，用于配置匹配条件。

<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>   
                 
              <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>

其他Filter不太常用我这里就不讲了，大家可以参见官网。

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L211c2lfbQ_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20200118183341971.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L211c2lfbQ==,size_16,color_FFFFFF,t_70