Log4j2多Appender配置：避免日志重复写入的策略

在log4j2中，当多个文件appender被配置为写入同一个日志文件，并同时关联到同一个logger（尤其是root logger）时，会导致日志事件被重复记录。解决此问题的核心在于确保每个文件appender都指定一个唯一的日志文件路径，从而实现日志内容的正确分流和记录，避免不必要的冗余。

Log4j2多Appender配置与日志重复写入问题解析

Log4j2作为一款高性能、灵活的日志框架，允许开发者通过配置多个Appender来将日志事件发送到不同的目的地，例如控制台、文件、数据库或远程服务器。然而，不当的配置，特别是涉及多个文件Appender时，可能导致日志内容重复写入的问题。本教程将深入探讨这一问题的原因及解决方案。

理解Log4j2的Appender与Logger机制

在Log4j2中，Logger负责接收应用程序生成的日志消息，并根据其级别和配置决定是否处理这些消息。Appender则负责将这些已处理的日志事件发送到具体的输出目标。一个Logger可以关联一个或多个Appender。当一个日志事件被Logger处理时，它会依次将该事件传递给所有关联的Appender。

问题重现：多Appender写入同一文件

当开发者希望将日志输出到不同的文件，但错误地配置了多个RollingFile Appender，并且这些Appender都指向了同一个fileName，同时又将它们全部关联到同一个Root Logger时，就会出现日志重复写入的问题。

考虑以下Log4j2配置示例：

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="WARN">
    <Appenders>
        <RollingFile name="service1" fileName="${sys:catalina.base}/test.log"
                     filePattern="${sys:catalina.base}/test-%d{yyyy-MM-dd}-%i.log.gz">
            <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n" />
            <Policies>
                <SizeBasedTriggeringPolicy size="100MB" />
            </Policies>
            <DefaultRolloverStrategy max="10" />
        </RollingFile>

        <RollingFile name="service2" fileName="${sys:catalina.base}/test.log"
                     filePattern="${sys:catalina.base}/test-%d{yyyy-MM-dd}-%i.log.gz">
            <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n" />
            <Policies>
                <SizeBasedTriggeringPolicy size="100MB" />
            </Policies>
            <DefaultRolloverStrategy max="10" />
        </RollingFile>
    </Appenders>

    <Loggers>
        <Root level="info">
            <AppenderRef ref="service1"/>
            <AppenderRef ref="service2" />
        </Root>
    </Loggers>
</Configuration>

登录后复制

在这个配置中，service1和service2两个RollingFile Appender都尝试将日志写入名为test.log的文件。当一个日志事件（例如 logger.info("Debugging data1");）被Root Logger接收时，它会首先传递给service1 Appender，service1会将该事件写入test.log。随后，同一个事件又会被传递给service2 Appender，service2也会将该事件写入test.log。结果就是，日志文件test.log中会包含每一条日志消息的两个副本，如下所示：

Debugging data1
Debugging data1
Debugging data2
Debugging data2

登录后复制

这种重复不仅浪费存储空间，还可能增加日志分析的复杂性。

解决方案：为每个文件Appender指定唯一文件

解决此问题的核心非常直观：确保每个旨在写入文件的Appender都拥有一个独一无二的fileName。这样，每个Appender就能将日志事件写入其各自的目标文件，从而避免冲突和重复。

修改后的Log4j2配置应如下所示：

标签： app yy