Logback之Filter

在使用Logback打印日志时，有时候可能会有些自定义的需求；
比如不打印某个类的日志/只打印某个类的日志/以及日志级别的过滤等等。

logback 使用不难 ，官方文档

默认情况下，过滤器相关的实现关系如下

这里简单介绍两个过滤器
ThresholdFilter, LevelFilter

二者根本的区别在于匹配日志级别的机制不同，以下为Logback完整日志等级；
在Logback中行为中有类似Spring Security 中的一个行为定义；即：赞成，中立，反对三种行为。

ThresholdFilter：匹配大于或等于设置等级的日志
LevelFilter：匹配等于设置等级的日志

简单查看源码可以看到二者的区别

ThresholdFilter 核心逻辑

LevelFilter核心逻辑

这里看到过滤器并不能看到直接的结果，该变量定义来自，父类 AbstractMatcherFilter， 跟进去看看

可以看到这里有两个变量可以设置，如果都不设置的情况下，默认值为中立，意味着不会打印设置级别的日志；可以通过分别设置两个变量实现命中和未命中的处理方式。

logback配置

spring boot 官方推荐使用 logback-spring.xml，可以获得一些spring boot 的支持，能使用 springProfile 来激活不同环境的日志配置。

<springProfile name="dev">
    <logger name="com.aib" level="DEBUG" additivity="false">
        <appender-ref ref="log-file"/>
        <appender-ref ref="STDOUT"/>
    </logger>
    <root level="info">
        <appender-ref ref="STDOUT"/>
    </root>
</springProfile>

• ThresholdFilter

		<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
		<!-- 打印info及以上级别的日志 -->
            <level>INFO</level>
        </filter>

• LevelFilter

<filter class="ch.qos.logback.classic.filter.LevelFilter">
            <!-- 只打印INFO级别日志 -->
            <level>INFO</level>
            <!-- 匹配时的操作：接收（记录） -->
            <onMatch>ACCEPT</onMatch>
            <!-- 不匹配时的操作：拒绝（不记录） -->
            <onMismatch>DENY</onMismatch>
        </filter>

附上一个相对完整的logback-spring.xml配置

<?xml version="1.0" encoding="UTF-8"?>
<configuration scan="true" scanPeriod="60 seconds" debug="false">
    <!-- 日志存放路径 -->
	<property name="log.path" value="logs/app" />
   <!-- 日志输出格式 -->
	<property name="log.pattern" value="%d{HH:mm:ss.SSS} [%thread] %-5level %logger{20} - [%method,%line] - %msg%n" />

    <!-- 控制台输出 -->
	<appender name="console" class="ch.qos.logback.core.ConsoleAppender">
		<encoder>
			<pattern>${log.pattern}</pattern>
		</encoder>
	</appender>

    <!-- 系统日志输出 -->
	<appender name="file_info" class="ch.qos.logback.core.rolling.RollingFileAppender">
	    <file>${log.path}/info.log</file>
        <!-- 循环政策：基于时间创建日志文件 -->
		<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 日志文件名格式 -->
			<fileNamePattern>${log.path}/info.%d{yyyy-MM-dd}.log</fileNamePattern>
			<!-- 日志最大的历史 60天 -->
			<maxHistory>60</maxHistory>
		</rollingPolicy>
		<encoder>
			<pattern>${log.pattern}</pattern>
		</encoder>
		<filter class="ch.qos.logback.classic.filter.LevelFilter">
            <!-- 过滤的级别 -->
            <level>INFO</level>
            <!-- 匹配时的操作：接收（记录） -->
            <onMatch>ACCEPT</onMatch>
            <!-- 不匹配时的操作：拒绝（不记录） -->
            <onMismatch>DENY</onMismatch>
        </filter>
	</appender>

    <appender name="file_error" class="ch.qos.logback.core.rolling.RollingFileAppender">
	    <file>${log.path}/error.log</file>
        <!-- 循环政策：基于时间创建日志文件 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
            <!-- 日志文件名格式 -->
            <fileNamePattern>${log.path}/error.%d{yyyy-MM-dd}-%i.log</fileNamePattern>
			<!-- 日志最大的历史 60天 -->
			<maxHistory>60</maxHistory>
			<!-- 单个文件大小 -->
			<maxFileSize>10MB</maxFileSize>
        </rollingPolicy>
        <encoder>
            <pattern>${log.pattern}</pattern>
        </encoder>
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <!-- 过滤的级别 -->
            <level>ERROR</level>
			<!-- 匹配时的操作：接收（记录） -->
            <onMatch>ACCEPT</onMatch>
			<!-- 不匹配时的操作：拒绝（不记录） -->
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>
    
    <!-- dev 只记录控制台日志，不生成日志文件 -->
<springProfile name="dev">
    <logger name="com.aib" level="DEBUG" additivity="false">
        <appender-ref ref="STDOUT"/>
    </logger>
        <!-- 系统模块日志级别控制  -->
	<logger name="com.xx" level="info" />
	<!-- Spring日志级别控制，如果子logger指定了appender，可能需要屏蔽向上传递到 root logger   -->
	<logger name="org.springframework" level="warn" additivity="false">
		<appender-ref ref="console" />
	</logger>
	<!--系统操作日志，root logger 只是定义全局的日志级别，和全局的appender ，即使 自定义logger 的级别不匹配，依然会执行 root appender -->
    <root level="info">
        <appender-ref ref="console"/>
    </root>
</springProfile>

    <!-- prod 对 com.aib 目录下的日志级别设为debug，生成文件 + 控制台 -->
<springProfile name="prod">
        <!-- 系统模块日志级别控制  -->
	<logger name="com.xx" level="info" />
	<!-- Spring日志级别控制，如果子logger指定了appender，可能需要屏蔽向上传递到 root logger   -->
	<logger name="org.springframework" level="warn" additivity="false">
		<appender-ref ref="console" />
	</logger>
	<!--系统操作日志，root logger 只是定义全局的日志级别，和全局的appender ，即使 自定义logger 的级别不匹配，依然会执行 root appender -->

    <logger name="com.aib" level="DEBUG" additivity="false">
        <appender-ref ref="console"/>
        <appender-ref ref="file_error"/>
        <appender-ref ref="file_info"/>
    </logger>
    <root level="info">
        <appender-ref ref="console"/>
        <appender-ref ref="file_error"/>
        <appender-ref ref="file_info"/>
    </root>
</springProfile>
</configuration>