Log4j2包级类级日志正则过滤技巧

本教程详细阐述了如何在Log4j2中配置复杂的日志过滤策略，以同时满足包级别和特定类级别的不同需求。通过结合Logger层级、RegexFilter和AppenderRef，文章展示了如何为整个包设置通用过滤规则，并为包内特定类应用独立且更精细的过滤条件，强调了AppenderRef的重要性及正则表达式语法的严谨性。

Log4j2日志过滤机制概览

在大型Java应用中，日志配置往往需要高度的灵活性，以满足不同模块或类的特定日志输出要求。Log4j2提供了强大的配置能力，通过其分层的Logger机制和各种Filter，可以实现非常精细的控制。核心概念包括：

• Logger层级（Logger Hierarchy）: Log4j2的Logger是分层的，例如com.app.package.one是com.app.package的子级，com.app.package.two.class7是com.app.package.two的子级。子级Logger会继承父级Logger的配置，但如果子级Logger有自己的显式配置，则其配置将优先应用。
• 过滤器（Filters）: Filter允许在日志事件被处理之前进行条件判断。RegexFilter是其中一种，它根据日志消息内容是否匹配正则表达式来决定是否接受或拒绝日志事件。
• Appender引用（AppenderRef）: Logger本身并不直接输出日志，它需要通过AppenderRef引用一个或多个Appender来将日志事件发送到实际的输出目的地（如控制台、文件等）。

复杂日志场景分析

假设我们面临以下日志需求：

1. 通用规则: 应用程序所有类的日志级别都设置为ERROR。
2. 通用内容过滤: 只有当日志消息中包含“exception”（不区分大小写）时，才打印日志。
3. 特定类例外: 对于com.app.package.two.class7这个类，除了满足上述通用条件外，如果日志消息中包含“sometext”（不区分大小写），也需要打印。

这意味着com.app.package.two.class7需要比其父级包com.app.package更宽松的日志内容过滤条件。

初始配置尝试与问题诊断

最初的配置尝试可能如下所示，它试图通过定义两个Logger来解决问题：一个针对整个包，另一个针对特定类。

<!-- 针对 com.app.package 包的通用配置 -->
<Logger name="com.app.package" level="error">
    <RegexFilter regex=".*(?i)exception(?-i).*" onMatch="ACCEPT" onMismatch="DENY"/>
    <!-- 缺少 AppenderRef -->
</Logger>

<!-- 针对 com.app.package.two.class7 的特定配置 -->
<Logger name="com.app.package.two.class7" level="error">
    <!-- 正则表达式中管道符 '|' 周围有空格，可能导致匹配失败 -->
    <RegexFilter regex=".*(?i)exception(?-i).* | .*(?i)sometext(?-i).*" onMatch="ACCEPT" onMismatch="DENY"/>
    <!-- 缺少 AppenderRef -->
</Logger>

这段配置存在两个关键问题，导致其无法按预期工作：

1. 缺少AppenderRef: 最重要的一个问题是，这两个Logger定义都没有包含<AppenderRef ref="YourAppenderName"/>。这意味着即使日志事件匹配了Logger的级别和过滤器条件，它们也无法被发送到任何实际的输出目的地（如控制台或文件）。Log4j2的Logger必须显式地引用一个Appender才能输出日志。
2. 正则表达式语法错误: 在针对class7的RegexFilter中，正则表达式.*(?i)exception(?-i).* | .*(?i)sometext(?-i).*在管道符|前后包含了空格。这些空格会被视为正则表达式的一部分，从而可能导致意外的匹配失败。正确的做法是紧凑地书写，即.*(?i)exception(?-i).*|.*(?i)sometext(?-i).*。

解决方案：正确的Log4j2配置

要同时满足所有条件，并确保日志能够正确输出，需要修正上述两个问题。以下是经过调整后的Log4j2 XML配置示例：

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="WARN">
    <Appenders>
        <!-- 定义一个名为 LogToConsole 的控制台 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>
        <!--
        1. 针对 com.app.package 包及其所有子类（不包括 class7，因为它有更具体的配置）
           - 日志级别为 ERROR
           - 消息内容必须包含 "exception" (不区分大小写)
           - 引用 LogToConsole Appender
           - additivity="false" 确保它不会将日志事件传递给其父级 Logger 的 Appender
        -->
        <Logger name="com.app.package" level="error" additivity="false">
            <RegexFilter regex=".*(?i)exception(?-i).*" onMatch="ACCEPT" onMismatch="DENY"/>
            <AppenderRef ref="LogToConsole"/>
        </Logger>

        <!--
        2. 针对 com.app.package.two.class7 类
           - 日志级别为 ERROR
           - 消息内容必须包含 "exception" 或 "sometext" (不区分大小写)
           - 引用 LogToConsole Appender
           - additivity="false" 确保它不会将日志事件传递给其父级 Logger 的 Appender
        -->
        <Logger name="com.app.package.two.class7" level="error" additivity="false">
            <!-- 修正了正则表达式，移除了管道符两侧的空格 -->
            <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>

配置说明：

• Appenders 定义: 首先，我们定义了一个名为LogToConsole的ConsoleAppender。这是所有Logger将日志事件发送到的目的地。
• Logger name="com.app.package": 这个Logger配置应用于com.app.package包下的所有类，除非这些类有更具体的Logger定义。
  • level="error": 设置日志级别为ERROR。
  • RegexFilter: 只接受包含“exception”的日志消息。
  • AppenderRef ref="LogToConsole": 将符合条件的日志事件发送到LogToConsole。
  • additivity="false": 这是一个重要的属性。它表示此Logger的日志事件不会传递给其祖先Logger的Appender。将其设置为false可以避免重复日志输出，并确保每个Logger只通过其自身的AppenderRef进行输出。
• Logger name="com.app.package.two.class7": 这个Logger配置专门针对com.app.package.two.class7这个类。由于其名称比com.app.package更具体，Log4j2会优先应用此配置。
  • level="error": 同样设置日志级别为ERROR。
  • RegexFilter: 接受包含“exception”或“sometext”的日志消息。注意，这里的正则表达式.*(?i)exception(?-i).*|.*(?i)sometext(?-i).*已经修正，移除了管道符|两侧的空格，确保了正确的匹配行为。
  • AppenderRef ref="LogToConsole": 将符合条件的日志事件发送到LogToConsole。
  • additivity="false": 同样设置为false，以避免class7的日志事件向上冒泡到com.app.package的Logger并可能导致重复输出或不必要的处理。
• Root Logger: 根Logger是所有Logger的最终父级。它捕获所有未被特定