Log4j2 结合正则表达式实现包级与类级日志过滤策略

Log4j2 日志过滤机制概述

在 java 应用程序中，log4j2 是一个功能强大且高度可配置的日志框架。它允许开发者通过 xml、json 或 yaml 等配置文件精细控制日志的输出行为。其中，<logger> 元素用于定义特定包或类的日志行为，而 <filter> 元素则提供了在日志事件被处理前进行筛选的能力。regexfilter 是一种常用的过滤器，它允许根据日志消息内容是否匹配某个正则表达式来决定日志事件的接受或拒绝。

本文将探讨一个常见但略复杂的场景：如何为整个包定义一个通用过滤规则，同时又为该包内的某个特定类设置一个不同的、更具体的过滤规则。

场景描述与挑战

假设我们有一个 Java 项目，其包结构如下：

com.app.package.one
  - class1.java
  - class2.java
  - class3.java
  - class4.java

com.app.package.two
  - class5.java
  - class6.java
  - class7.java
  - class8.java

我们希望 Log4j2 的日志输出满足以下三项条件：

1. 通用条件： 所有类的日志级别至少为 ERROR。
2. 消息过滤（通用）： 只有当日志消息中包含“exception”（不区分大小写）时，才打印日志。此规则适用于 com.app.package 下的所有类。
3. 消息过滤（特定类）： 对于 com.app.package.two.class7 这个特定类，除了满足上述通用条件外，其日志消息中只要包含“exception”或“sometext”（不区分大小写），就应该被打印。

最初的尝试可能包括为包定义一个 Logger，再为特定类定义另一个 Logger。例如：

<!-- 尝试配置：通用规则 -->
<Logger name="com.app.package" level="error">
    <RegexFilter regex=".*(?i)exception(?-i).*" onMatch="ACCEPT" onMismatch="DENY"/>
</Logger>

<!-- 尝试配置：特定类规则 -->
<Logger name="com.app.package.two.class7" level="error">
    <RegexFilter regex=".*(?i)exception(?-i).* | .*(?i)sometext(?-i).*" onMatch="ACCEPT" onMismatch="DENY"/>
</Logger>

然而，这种配置可能无法按预期工作，主要原因在于 Log4j2 配置的两个关键点：AppenderRef 的缺失以及正则表达式语法中的细微差别。

解决方案与正确配置

要实现上述复杂的日志过滤策略，我们需要确保每个 Logger 元素都明确指定了其日志输出到哪个或哪些 Appender，并且正则表达式的语法必须是正确的。

一键职达

AI全自动批量代投简历软件，自动浏览招聘网站从海量职位中用AI匹配职位并完成投递的全自动操作，真正实现'一键职达'的便捷体验。

79

查看详情

以下是能够满足所有条件的 Log4j2 XML 配置示例：

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="WARN">
    <Appenders>
        <!-- 定义一个控制台 Appender -->
        <Console name="LogToConsole" target="SYSTEM_OUT">
            <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/>
        </Console>
        <!-- 可以根据需要添加其他 Appender，例如文件 Appender -->
    </Appenders>

    <Loggers>
        <!-- 定义 com.app.package 包的通用日志规则 -->
        <!-- 级别为 ERROR，消息必须包含 "exception" (不区分大小写) -->
        <Logger name="com.app.package" level="error" additivity="true">
            <RegexFilter regex=".*(?i)exception(?-i).*" onMatch="ACCEPT" onMismatch="DENY"/>
            <AppenderRef ref="LogToConsole"/>
        </Logger>

        <!-- 定义 com.app.package.two.class7 的特定日志规则 -->
        <!-- 级别为 ERROR，消息必须包含 "exception" 或 "sometext" (不区分大小写) -->
        <!-- additivity="false" 可以确保此 Logger 不会继承父 Logger 的 Appender，
             从而只应用自己的过滤和 Appender。
             如果希望同时应用父 Logger 的 Appender，则设置为 true 或省略。
             在此场景下，我们希望它有自己的特定行为，因此通常会明确指定 Appender。
             由于这里是更具体的规则，并且我们希望它能独立工作，
             所以即使 additivity 默认为 true，它也会将日志发送到其明确引用的 Appender。
             这里为了演示，两个 Logger 都引用了同一个 Appender。
        -->
        <Logger name="com.app.package.two.class7" level="error" additivity="true">
            <!-- 注意：正则表达式中 | 符号前后不能有空格，否则会被视为字面量而非逻辑或操作符 -->
            <RegexFilter regex=".*(?i)exception(?-i).*|.*(?i)sometext(?-i).*" onMatch="ACCEPT" onMismatch="DENY"/>
            <AppenderRef ref="LogToConsole"/>
        </Logger>

        <!-- 根 Logger：如果没有更具体的 Logger 匹配，则使用此配置 -->
        <Root level="info">
            <AppenderRef ref="LogToConsole"/>
        </Root>
    </Loggers>
</Configuration>

关键点解析

1. AppenderRef 的重要性： 每个 Logger 元素（包括 Root Logger）都必须通过 <AppenderRef ref="AppenderName"/> 来引用一个或多个已定义的 Appender。如果没有 AppenderRef，即使日志事件被 Logger 接受，它也无处可去，最终不会被输出。这是许多新手在配置 Log4j2 时常犯的错误。

2. 正则表达式 | 符号的使用： 在正则表达式中，| 符号表示逻辑或（OR）操作。在 Log4j2 的 RegexFilter 中使用时，| 符号前后不应有空格，否则这些空格会被视为正则表达式的一部分，导致匹配失败。例如，A | B 会尝试匹配 "A " 或 " B"，而不是 "A" 或 "B"。正确的写法是 A|B。 示例中的 .*(?i)exception(?-i).*|.*(?i)sometext(?-i).* 正确地表达了“匹配包含 'exception' 或 'sometext' 的任意字符串”。

3. Logger 的层级与特异性： Log4j2 的 Logger 具有层级结构。当一个日志事件发生时，Log4j2 会从最具体的 Logger（例如 com.app.package.two.class7）开始查找匹配的配置。如果找到，则应用该 Logger 的配置。

   • 对于 com.app.package.two.class7 发出的日志，Log4j2 会首先匹配到名为 com.app.package.two.class7 的 Logger。它会应用自己的 level 和 RegexFilter。
   • 对于 com.app.package.one.class1 发出的日志，它不会匹配到 com.app.package.two.class7，而是会匹配到 com.app.package 这个 Logger。因此，它将应用 com.app.package 的 level 和 RegexFilter。

4. additivity 属性：additivity 属性（默认为 true）控制一个 Logger 是否会将日志事件传递给其父 Logger 的 Appender。

   • 当 additivity="true" 时，子 Logger 的日志事件会先经过自己的 AppenderRef，然后向上级 Logger 传递，最终也会被父 Logger 的 Appender 处理。
   • 当 additivity="false" 时，子 Logger 的日志事件只会被自己的 Appender 处理，不会传递给父 Logger。 在本示例中，由于我们为两个 Logger 都明确指定了 AppenderRef，并且希望它们独立过滤，即使 additivity 默认为 true，它们也会将日志发送到自己的 Appender。如果需要完全隔离子 Logger 的输出，不希望它受到任何父 Logger Appender 的影响，则应显式设置 additivity="false"。在我们的场景中，由于每个 Logger 都定义了自己的过滤规则，并引用了同一个 Appender，所以 additivity 属性的影响不大，但理解其作用对于更复杂的配置至关重要。

总结与注意事项

通过上述配置，我们成功实现了为整个包定义通用日志过滤规则，并为特定类设置了独立的、更精细的过滤条件。

主要注意事项包括：

• 完整性： 确保 Log4j2 配置中包含了 <Configuration>、<Appenders> 和 <Loggers> 这三个顶级元素，并且每个 Logger 都至少有一个 AppenderRef。
• 正则表达式准确性： 仔细检查正则表达式的语法，特别是 |（或）操作符前后不应有空格，以及括号 () 用于分组或修饰符（如 (?i) 不区分大小写）。
• 层级与特异性： 理解 Log4j2 Logger 的层级结构和匹配规则，确保最具体的 Logger 能够覆盖或补充其父 Logger 的配置。
• 测试验证： 在实际部署前，务必通过编写测试用例，打印不同内容和来源的日志消息，来验证 Log4j2 配置是否按预期工作。

掌握 Log4j2 的这些配置细节，将帮助开发者构建出更健壮、更灵活的日志系统，从而更好地监控和调试应用程序。

以上就是Log4j2 结合正则表达式实现包级与类级日志过滤策略的详细内容，更多请关注php中文网其它相关文章！