logback使用filter过滤日志

男娘i 2022-11-28 13:57 160阅读 0赞

**笔者语录****：** 我发现我喜欢捣鼓一些小玩意儿，虽然官网(见文末)写得很明白了，但是咱们对感兴趣的部分来敲一遍代码好吧。

--------------------

## 过滤器简介： ##

*  简介  
      logback具有过滤器支持。`logbcak允许给日志记录器appender配置一个或多个Filter(或者给整体配置一个或多个TurboFilter)，来控制:当满足过滤器指定的条件时，才记录日志(或不满足条件时，拒绝记录日志)`。logback支持自定义过滤器，当然logback也自带了一些常用的过滤器，在绝大多数时候，自带的过滤器其实就够用了，一般是不需要自定义过滤器的。
 *  logback提供的过滤器支持主要分两大类
    
     *  ch.qos.logback.core.filter.`Filter`  
        ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2p1c3RyeV9kZW5n_size_16_color_FFFFFF_t_70_pic_center]
     *  ch.qos.logback.classic.turbo.`TurboFilter`  
        ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2p1c3RyeV9kZW5n_size_16_color_FFFFFF_t_70_pic_center 1]
 *  Filter与TurboFilter自带的几种常用过滤器

<table> 
 <thead> 
  <tr> 
   <th align="center">过滤器</th> 
   <th align="center">来源</th> 
   <th align="center">说明</th> 
   <th align="center">相对常用</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="center">LevelFilter</td> 
   <td align="center">Filter</td> 
   <td align="center">对指定level的日志进行记录(或不记录)，对不等于指定level的日志不记录(或进行记录)</td> 
   <td align="center">是</td> 
  </tr> 
  <tr> 
   <td align="center">ThresholdFilter</td> 
   <td align="center">Filter</td> 
   <td align="center">对大于或等于指定level的日志进行记录(或不记录)，对小于指定level的日志不记录(或进行记录)<br>提示：info级别是大于debug的</td> 
   <td align="center">是</td> 
  </tr> 
  <tr> 
   <td align="center">EvaluatorFilter</td> 
   <td align="center">Filter</td> 
   <td align="center">对满足指定表达式的日志进行记录(或不记录)，对不满足指定表达式的日志不作记录(或进行记录)</td> 
   <td align="center">是</td> 
  </tr> 
  <tr> 
   <td align="center">MDCFilter</td> 
   <td align="center">TurboFilter</td> 
   <td align="center">若MDC域中存在指定的key-value，则进行记录，否者不作记录</td> 
   <td align="center">是</td> 
  </tr> 
  <tr> 
   <td align="center">DuplicateMessageFilter</td> 
   <td align="center">TurboFilter</td> 
   <td align="center">根据配置不记录多余的重复的日志</td> 
   <td align="center">是</td> 
  </tr> 
  <tr> 
   <td align="center">DynamicThresholdFilter</td> 
   <td align="center">TurboFilter</td> 
   <td align="center">动态版的ThresholdFilter，根据MDC域中是否存在某个键，该键对应的值是否相等，可实现日志级别动态切换<br>示例：<code>&lt;turboFilter class="ch.qos.logback.classic.turbo.DynamicThresholdFilter"&gt;&lt;DefaultThreshold&gt;ERROR&lt;/DefaultThreshold&gt;&lt;OnHigherOrEqual&gt;ACCEPT&lt;/OnHigherOrEqual&gt;&lt;OnLower&gt;NEUTRAL&lt;/OnLower&gt;&lt;Key&gt;userRole&lt;/Key&gt;&lt;MDCValueLevelPair&gt;&lt;value&gt;admin&lt;/value&gt;&lt;level&gt;DEBUG&lt;/level&gt;&lt;/MDCValueLevelPair&gt;&lt;MDCValueLevelPair&gt;&lt;value&gt;dba&lt;/value&gt;&lt;level&gt;INFO&lt;/level&gt;&lt;/MDCValueLevelPair&gt;&lt;MDCValueLevelPair&gt;&lt;value&gt;user&lt;/value&gt;&lt;level&gt;WARN&lt;/level&gt;&lt;/MDCValueLevelPair&gt;&lt;/turboFilter&gt;</code>此时，作用有以下几种情况：<br>情况一：MDC域中不存在对应的键userRole，或者存在对应的 键userRole，但是其值不等于任何一个MDCValueLevelPair中的value值。那么此时会以${DefaultThreshold}为界线，大于等于该级别的日志将会被${OnHigherOrEqual}，小于该级别的日志将会被${OnLower}<br>情况二：MDC域中存在对应的键userRole，且其对应的值等于其中一个MDCValueLevelPair中的value值。那么此时会以该MDCValueLevelPair中的${level}为界线，大于等于该级别的日志将会被${OnHigherOrEqual}，小于该级别的日志将会被${OnLower}</td> 
   <td align="center">是</td> 
  </tr> 
  <tr> 
   <td align="center">MarkerFilter</td> 
   <td align="center">TurboFilter</td> 
   <td align="center">针对带有指定标记的日志，进行记录(或不作记录)</td> 
   <td align="center">否</td> 
  </tr> 
  <tr> 
   <td align="center">…</td> 
   <td align="center">…</td> 
   <td align="center">…</td> 
   <td align="center">…</td> 
  </tr> 
 </tbody> 
</table>

*  `若过滤器已经返回了需要记录，那么就一定会对该日志进行记录(不论当前日志的level是否大于等于系统设置的最低日志级别)`。
 *  `TurboFilter的性能是优于Filter的，这是因为TurboFilter的作用时机是在创建日志事件ILoggingEvent对象之前，而Filter的作用时机是在创建之后`。若一个日志注定是会被过滤掉不记录的，那么创建ILoggingEvent对象(包括后续的参数组装方法调用等)这个步骤无疑是非常消耗性能的。

--------------------

## 过滤器的FilterReply状态枚举： ##

对于Filter而言，需不需要记录日志，取决于ch.qos.logback.core.filter.Filter\#decide方法的返回：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2p1c3RyeV9kZW5n_size_16_color_FFFFFF_t_70_pic_center 2]  
  对于TurboFilter而言，需不需要记录日志，取决于ch.qos.logback.classic.turbo.TurboFilter\#decide方法的返回：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2p1c3RyeV9kZW5n_size_16_color_FFFFFF_t_70_pic_center 3]  
  可以看到，返回的都是FilterReply这个枚举：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2p1c3RyeV9kZW5n_size_16_color_FFFFFF_t_70_pic_center 4]

*  FilterReply有三种枚举值：
    
     *  `DENY`：表示不用看后面的过滤器了，这里就给拒绝了，不作记录。
     *  `NEUTRAL`：表示需不需要记录，还需要看后面的过滤器。若所有过滤器返回的全部都是NEUTRAL，那么需要记录日志。
     *  `ACCEPT`：表示不用看后面的过滤器了，这里就给直接同意了，需要记录。

--------------------

## 过滤器的使用(示例)： ##

##### 使用LevelFilter的logback.xml(示例)： #####

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2p1c3RyeV9kZW5n_size_16_color_FFFFFF_t_70_pic_center 5]  
**测试一下：**

*  编写测试方法：  
    ![在这里插入图片描述][20200818124521617.png_pic_center]
 *  运行方法，产出日志：  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2p1c3RyeV9kZW5n_size_16_color_FFFFFF_t_70_pic_center 6]

##### 使用ThresholdFilter的logback.xml(示例)： #####

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2p1c3RyeV9kZW5n_size_16_color_FFFFFF_t_70_pic_center 7]

**测试一下：**

*  编写测试方法：  
    ![在这里插入图片描述][20200818124616271.png_pic_center]
 *  运行方法，产出日志：  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2p1c3RyeV9kZW5n_size_16_color_FFFFFF_t_70_pic_center 8]

##### 使用EvaluatorFilter的logback.xml(示例)： #####

*  需要引入额外的解析库依赖janino：
    
        <dependency>
            <groupId>org.codehaus.janino</groupId>
            <artifactId>janino</artifactId>
            <version>3.1.2</version>
        </dependency>
 *  logbaxk.xml  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2p1c3RyeV9kZW5n_size_16_color_FFFFFF_t_70_pic_center 9]

**测试一下：**

*  编写测试方法：  
    ![在这里插入图片描述][20200818124802822.png_pic_center]
 *  运行方法，产出日志：  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2p1c3RyeV9kZW5n_size_16_color_FFFFFF_t_70_pic_center 10]

##### 使用MDCFilter的logback.xml(示例)： #####

**测试一下：**  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2p1c3RyeV9kZW5n_size_16_color_FFFFFF_t_70_pic_center 11]

*  编写测试方法：  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2p1c3RyeV9kZW5n_size_16_color_FFFFFF_t_70_pic_center 12]
 *  运行方法，产出日志：  
    ![在这里插入图片描述][20200818124931322.png_pic_center]

##### 使用DynamicThresholdFilter的logback.xml(示例)：![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2p1c3RyeV9kZW5n_size_16_color_FFFFFF_t_70_pic_center 13] #####

**测试一下：**

*  编写测试方法：  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2p1c3RyeV9kZW5n_size_16_color_FFFFFF_t_70_pic_center 14]
 *  运行方法，产出日志：  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2p1c3RyeV9kZW5n_size_16_color_FFFFFF_t_70_pic_center 15]

--------------------

## 自定义过滤器： ##

##### 自定义Filter： #####

*  编写自定义Filter  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2p1c3RyeV9kZW5n_size_16_color_FFFFFF_t_70_pic_center 16]
 *  在logback.xml中配置使用此过滤器  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2p1c3RyeV9kZW5n_size_16_color_FFFFFF_t_70_pic_center 17]  
    **测试一下：**
 *  编写测试方法：  
    ![在这里插入图片描述][20200818125313339.png_pic_center]
 *  运行方法，产出日志：  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2p1c3RyeV9kZW5n_size_16_color_FFFFFF_t_70_pic_center 18]

##### 自定义TurboFilter： #####

*  编写自定义TurboFilter  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2p1c3RyeV9kZW5n_size_16_color_FFFFFF_t_70_pic_center 19]
 *  在logback.xml中配置使用此过滤器  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2p1c3RyeV9kZW5n_size_16_color_FFFFFF_t_70_pic_center 20]

**测试一下：**

*  编写测试方法：  
    ![在这里插入图片描述][20200818125418896.png_pic_center]
 *  运行方法，产出日志：  
    ![在这里插入图片描述][20200818125432149.png_pic_center]

--------------------

**logback使用filter过滤日志，初步学习完毕！**

**^\_^ 如有不当之处，欢迎指正**

**^\_^ 参考链接  
         [http://logback.qos.ch/manual/filters.html][http_logback.qos.ch_manual_filters.html]**

**^\_^ 测试代码托管链接  
         [https://github.com/JustryDeng…logback-Filter&TurboFilter…][https_github.com_JustryDeng_logback-Filter_TurboFilter]**

**^\_^ 本文已经被收录进[《程序员成长笔记》 ][Link 1]，笔者JustryDeng**

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2p1c3RyeV9kZW5n_size_16_color_FFFFFF_t_70_pic_center]: /images/20221124/bea8eea03aa3477cbbd0b364e4806cf2.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2p1c3RyeV9kZW5n_size_16_color_FFFFFF_t_70_pic_center 1]: /images/20221124/6611f07e2da04b97a8fb95847ea4f90c.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2p1c3RyeV9kZW5n_size_16_color_FFFFFF_t_70_pic_center 2]: /images/20221124/d0c8bda3c28045f6b675deaa417ea3eb.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2p1c3RyeV9kZW5n_size_16_color_FFFFFF_t_70_pic_center 3]: /images/20221124/a4dccb01121f463fa19b72e2fbecec0b.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2p1c3RyeV9kZW5n_size_16_color_FFFFFF_t_70_pic_center 4]: /images/20221124/dac9b9c03ed54aa7824fcdc5db59a09d.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2p1c3RyeV9kZW5n_size_16_color_FFFFFF_t_70_pic_center 5]: /images/20221124/bc3754fde1504b73a676c19bc4c63d3c.png
[20200818124521617.png_pic_center]: /images/20221124/20c2374756a04380aa56d87393b00c46.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2p1c3RyeV9kZW5n_size_16_color_FFFFFF_t_70_pic_center 6]: /images/20221124/b692f60f15394fe58c91503667b7e789.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2p1c3RyeV9kZW5n_size_16_color_FFFFFF_t_70_pic_center 7]: /images/20221124/dd46336320244fe0bec6caa5680dff81.png
[20200818124616271.png_pic_center]: /images/20221124/70509d41d8f743e486b1d5544db1ccec.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2p1c3RyeV9kZW5n_size_16_color_FFFFFF_t_70_pic_center 8]: /images/20221124/36bd0a10473c4dbfb31dc752be98cd79.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2p1c3RyeV9kZW5n_size_16_color_FFFFFF_t_70_pic_center 9]: /images/20221124/3df0609ac34f4842945e1981477904f9.png
[20200818124802822.png_pic_center]: /images/20221124/188494594c1047ea9a63f050106c2362.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2p1c3RyeV9kZW5n_size_16_color_FFFFFF_t_70_pic_center 10]: /images/20221124/a495213f68a34841b6366eea2ea0a364.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2p1c3RyeV9kZW5n_size_16_color_FFFFFF_t_70_pic_center 11]: /images/20221124/ab315cfec1b34872952dbda9e3b309f5.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2p1c3RyeV9kZW5n_size_16_color_FFFFFF_t_70_pic_center 12]: /images/20221124/bd1528d846f5476c97559ba4b5210028.png
[20200818124931322.png_pic_center]: /images/20221124/318913fe04314ceb9790df944756b8ba.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2p1c3RyeV9kZW5n_size_16_color_FFFFFF_t_70_pic_center 13]: /images/20221124/af15bb63964245b1943c8e578975344c.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2p1c3RyeV9kZW5n_size_16_color_FFFFFF_t_70_pic_center 14]: /images/20221124/ae0283d1faf042eb84ac5a3afcb8acc4.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2p1c3RyeV9kZW5n_size_16_color_FFFFFF_t_70_pic_center 15]: /images/20221124/d40ebe20114b461d992f80363f7f0827.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2p1c3RyeV9kZW5n_size_16_color_FFFFFF_t_70_pic_center 16]: /images/20221124/99e9b42c9d204eeb8d34da9d04846d55.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2p1c3RyeV9kZW5n_size_16_color_FFFFFF_t_70_pic_center 17]: /images/20221124/07e2e05181fc48e1b87cd7d72b0132e9.png
[20200818125313339.png_pic_center]: /images/20221124/3e0aa245b1504f75afa48180a9967055.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2p1c3RyeV9kZW5n_size_16_color_FFFFFF_t_70_pic_center 18]: /images/20221124/643ea94c4a1c4cf2a62239b2869537eb.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2p1c3RyeV9kZW5n_size_16_color_FFFFFF_t_70_pic_center 19]: /images/20221124/0d6213ec8e974c9db259929a4c868479.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2p1c3RyeV9kZW5n_size_16_color_FFFFFF_t_70_pic_center 20]: /images/20221124/3f32d533db26431ba44dc39f397a0284.png
[20200818125418896.png_pic_center]: /images/20221124/4e328a09b27142eba7d6479fda02afe8.png
[20200818125432149.png_pic_center]: /images/20221124/fa3edb321d6b42458fe4f2c2201097ec.png
[http_logback.qos.ch_manual_filters.html]: http://logback.qos.ch/manual/filters.html
[https_github.com_JustryDeng_logback-Filter_TurboFilter]: https://github.com/JustryDeng/CommonRepository/tree/master/Abc_LogbackFilter_Demo
[Link 1]: https://gitee.com/JustryDeng/notebook