Log4j 2 (5) Layout与Filter

Appender使用布局将LogEvent格式化为可以让日志的输出更具有可读性。 在Log4j 1.x和Logback Layout中，都是把日志事件转成String。 在Log4j 2中，Layout返回一个字节数组。 这样可以让Layout的结果输出形式更加多样化。 但是，这也意味着我们需要为大多数Layout配置一个字符集，以确保字节数组能够正确输出。

如果你仔细阅读官方文档，你会发现，log4j比logback的输出更加丰富，可以支持CSV,JSON,XML等等，这些对于在web项目中可能也不常用，我也不做记录，如果将来真的需要，直接阅读官方文档以及示例。这里我们关注我们用的最频繁的Pattern Layout。

Pattern Layout

这个类型的layout最灵活也是最常用

参数列表：

Patterns规则

当然还有一些不常用的不列举出来，具体看官方的表格。基本上与logback的encoder差不多的语法

logger pattern示例

date pattern示例

我们来尝试解读一个pattern吧！

%d{yyyy/MM/dd HH:mm:ss.SSS} %-5p [%t] [%X{requestId} - %C{0}] %m%n

打印的格式大致是日期+左对齐5格的日志等级+ 被[]括起来的线程名+MDC定义的key为requestId+没有包前缀的类名（指的是logger的名）+日志信息。

Filter

Log4j 2的过滤器其实和logback也是差不多的，我们直接引用logback中关于过滤器的描述：

logback 过滤器基于三元逻辑（ternary logic ），允许它们有序地组装或者链接在一起组成一个任意复杂的过滤策略。那么你可能就会问了：哎呀什么是三元逻辑呢？跟Java的三元运算符概念差不多吗？答案当然是跟三元运算符不一样了，它更偏向是二元逻辑，只有真假两种。我们来看一下维基百科上对三元逻辑的解释吧：

有三种状态来表示真、假和一个表示不确定的第三值；；这相对于基础的二元逻辑（比如布尔逻辑，它只提供真假两种状态）

我们现在知道了原来三元逻辑就是有三种状态啊，既然是基于三元逻辑的过滤器应该也有三个类似的状态值吧？是的，没错！过滤器的decide(ILoggingEvent event)方法会被调用，且返回值只能是FilterReply中定义的ACCEPT、DENY和NEUTRAL的三个枚举值的其中一个。

如果返回DENY，那么日志事件立即被抛弃，不再经过剩余过滤器；

如果返回NEUTRAL，那么有序列表里的下一个过滤器会接着处理记录事件；

如果返回ACCEPT，那么日志事件被立即处理，不再经过剩余过滤器。

在log4j中也是使用这三个状态代表过滤状态。可以在以下四个位置之一中配置过滤器：：

• 在配置文件里直接配置Context-wide Filters。这个过滤器是全局范围的过滤器，即如果被这个过滤器拒绝的日志将不会到下一个过滤器进行处理，相反如果被这个过滤器接受的将直接执行，不会进入到其他过滤器甚至不会受到日志等级的影响。他被配置在Appender和Logger中；
• 在Logger 配置Filters。这个类型的过滤器执行顺序是排在Context-wide Filters和日志等级的过滤之后。这些过滤器拒绝的事件都将被丢弃，并且该事件不会传递给父Logger，即使additivity 设置为true；
• 在Appender中配置Filters 。用于确定特定的Appender是否应处理日志事件的格式化和输出；
• 在Appender Reference 中配置的Filters。用于确定Logger是否应将事件路由到Appender。

举个例子，表示下以上四个位置的过滤器：

<Configuration status="warn" name="MyApp" packages="">
     <Filters>
     <!-- 全局级别Filter-> Context-wide Filters -->
        <LevelRangeFilter minLevel="DEBUG" maxLevel="ERROR" onMatch="DENY"></LevelRangeFilter>
      </Filters>

  <Loggers>
     <!-- Logger级别的Filter -->
    <Root level="error">
      <MapFilter onMatch="ACCEPT" onMismatch="NEUTRAL" operator="or">
        <KeyValuePair key="eventId" value="Login"/>
        <KeyValuePair key="eventId" value="Logout"/>
      </MapFilter>
    </Root>

 <Appenders>
    <RollingFile name="RollingFile" fileName="logs/app.log"
                 filePattern="logs/app-%d{MM-dd-yyyy}.log.gz">
      <!-- Appender级别的Filter -->
      <BurstFilter level="INFO" rate="16" maxBurst="100"/>
      <PatternLayout>
        <pattern>%d %p %c{1.} [%t] %m%n</pattern>
      </PatternLayout>
      <TimeBasedTriggeringPolicy />
    </RollingFile>
  </Appenders>    

    <Logger name="TestJavaScriptFilter" level="trace" additivity="false">
       <!-- AppenderRef级别的Filter -->
      <AppenderRef ref="List">
        <ScriptFilter onMatch="ACCEPT" onMisMatch="DENY">
          <ScriptRef ref="filter.js" />
        </ScriptFilter>
      </AppenderRef>
    </Logger>
  </Loggers>

</Configuration>

BurstFilter

例如

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="warn" name="MyApp" packages="">
    <Appenders>
        <RollingFile name="RollingFile" fileName="logs/app.log"
                     filePattern="logs/app-%d{MM-dd-yyyy}.log.gz">
            <BurstFilter level="WARN" rate="10" maxBurst="2"/>
            <PatternLayout>
                <pattern>%d %p %c{1.} [%t] %m%n</pattern>
            </PatternLayout>
            <TimeBasedTriggeringPolicy />
        </RollingFile>
    </Appenders>
    <Loggers>
        <Root level="info">
            <AppenderRef ref="RollingFile"/>
        </Root>
    </Loggers>
</Configuration>

输出：

2020-04-25 22:08:14,071 INFO l.TestFilter [main] test info 0
2020-04-25 22:08:14,074 WARN l.TestFilter [main] test warn 0
2020-04-25 22:08:14,074 ERROR l.TestFilter [main] test error 0
2020-04-25 22:08:14,075 ERROR l.TestFilter [main] test error 2 0
2020-04-25 22:08:14,075 ERROR l.TestFilter [main] test error 1
2020-04-25 22:08:14,075 ERROR l.TestFilter [main] test error 2 1
2020-04-25 22:08:14,075 ERROR l.TestFilter [main] test error 2

假如你把maxBurst设置小于等于0，那么会被赋予默认值：rate*100。

CompositeFilter

复合过滤器提供了一种指定多个过滤器的方法。他以Filters元素加入到配置中，元素里面可以配置多个过滤器。该元素不支持添加参数。

例如：

 <Filters>
    <MarkerFilter marker="EVENT" onMatch="ACCEPT" onMismatch="NEUTRAL"/>
    <DynamicThresholdFilter key="loginId" defaultThreshold="ERROR"
                            onMatch="ACCEPT" onMismatch="NEUTRAL">
      <KeyValuePair key="User1" value="DEBUG"/>
    </DynamicThresholdFilter>
  </Filters>

DynamicThresholdFilter

DynamicThresholdFilter允许基于特定属性按日志级别进行过滤。 例如，如果在ThreadContext Map中捕获了用户的loginId，则可以仅对该用户启用调试日志记录。 如果日志事件不包含指定的ThreadContext项，则将返回NEUTRAL。

例如：

 public static void main(String[] args) throws InterruptedException {
        ThreadContext.put("debugMode", "false");
        log.info("Info should not show anywhere");
        log.debug("This shouldn't show anywhere");

        ThreadContext.put("debugMode", "true");
        log.debug("This should show in the log and console");
        log.info("This should also show in both");

        ThreadContext.put("debugMode", "false");
        log.info("This should not show anywhere");
        log.error("This error should show only in console.");


    }

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="warn">
    <Appenders>
        <Console name="console" target="SYSTEM_OUT">
            <filters>
                <DynamicThresholdFilter key="debugMode" defaultThreshold="ERROR" onMatch="ACCEPT" onMismatch="DENY">
                    <KeyValuePair key="true" value="DEBUG"/>
                    <KeyValuePair key="false" value="ERROR"/>
                </DynamicThresholdFilter>
            </filters>
            <PatternLayout pattern="%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg\n%n"/>
        </Console>
    </Appenders>
    <Loggers>
        <Root level="TRACE" additivity="false">
            <AppenderRef ref="console"/>
        </Root>
    </Loggers>
</Configuration>

输出：

22:54:41.416 [main] DEBUG [vsTenant] log4jstudy.TestFilter - This should show in the log and console

22:54:41.418 [main] INFO  [vsTenant] log4jstudy.TestFilter - This should also show in both

22:54:41.418 [main] ERROR [vsTenant] log4jstudy.TestFilter - This error should show only in console.

ThreadContextMapFilter (or ContextMapFilter)

ThreadContextMapFilter或ContextMapFilter允许对当前上下文中的数据元素进行过滤。默认情况下，这是ThreadContext映射。

例如：

        ThreadContext.put("User1", "error name");
        log.info("Info should not show anywhere");
        log.debug("This shouldn't show anywhere");

        ThreadContext.put("User2", "jane");
        log.debug("This should show in the log and console");
        log.info("This should also show in both");

        ThreadContext.put("User1", "nicole");
        log.info("This should show anywhere");
        log.error("This error should show only in console.");

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="warn">

    <ContextMapFilter onMatch="ACCEPT" onMismatch="NEUTRAL" operator="or">
        <KeyValuePair key="User1" value="nicole"/>
        <KeyValuePair key="User2" value="jane"/>
    </ContextMapFilter>

    <Appenders>
        <Console name="console" target="SYSTEM_OUT">
            <PatternLayout pattern="%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg\n%n"/>
        </Console>
    </Appenders>
    <Loggers>
        <Root level="WARN" additivity="false">
            <AppenderRef ref="console"/>
        </Root>
    </Loggers>
</Configuration>

输出：

23:22:58.977 [main] DEBUG log4jstudy.TestFilter - This should show in the log and console

23:22:58.980 [main] INFO  log4jstudy.TestFilter - This should also show in both

23:22:58.980 [main] INFO  log4jstudy.TestFilter - This should show anywhere

23:22:58.980 [main] ERROR log4jstudy.TestFilter - This error should show only in console.

当然这个过滤器也可以被放置在logger中：

<Loggers>
    <Root level="error">
      <AppenderRef ref="RollingFile"/>
      <ContextMapFilter onMatch="ACCEPT" onMismatch="NEUTRAL" operator="or">
        <KeyValuePair key="foo" value="bar"/>
        <KeyValuePair key="User2" value="Liming"/>
      </ContextMapFilter>
    </Root>
  </Loggers>

ThresholdFilter

如果LogEvent中的级别与配置的级别相同或更高，则此过滤器返回onMatch结果，否则返回onMismatch值。例如，你的日志事件为info，但是该过滤器配置了error，则这个事件将会被过滤掉即返回onMismatch。

例如：

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="warn">
    <Appenders>
        <Console name="console" target="SYSTEM_OUT">
            <ThresholdFilter level="WARN" onMatch="ACCEPT" onMismatch="DENY"/>
            <PatternLayout pattern="%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg\n%n"/>
        </Console>
    </Appenders>
    <Loggers>
        <Root level="INFO" additivity="false">
            <AppenderRef ref="console"/>
        </Root>
    </Loggers>
</Configuration>

log.error("error");

log.debug("hello debug");

输出

23:27:08.024 [main] ERROR log4jstudy.TestFilter - error

小结

过滤器不仅仅有上述这些还有诸如：TimeFilter，MapFilter ，MarkerFilter ，NoMarkerFilter，RegexFilter ，ScriptFilter ，StructuredDataFilter 这些。这里只是列举了可能常用的一些过滤器，如果有需要再翻阅官方文档进行配置。