如何为每个Logger配置独立日志文件名且复用同一File Appender？

问题描述 #

我希望使用多个Logger，且它们共用同一个File Appender。同时我希望每个日志文件都能使用我自定义的特定名称（例如requests.log等）。请问如何在不为每个Logger单独创建File Appender的前提下，为每个Logger定义对应的日志文件名？

当前我的logback-spring.xml配置如下：

<?xml version="1.0" encoding="UTF-8"?>
<configuration>

    <property name="pattern" value="%d{dd-MM-yyyy HH:mm:ss.SSS} %-5level: %msg | request #%X{requestNumber}%n" />

    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>${pattern}</pattern>
        </encoder>
    </appender>

    <appender name="FILE" class="ch.qos.logback.core.FileAppender">
        <encoder>
            <pattern>${pattern}</pattern>
        </encoder>
    </appender>

    <logger name="request-logger">
        <appender-ref ref="STDOUT"/>
        <appender-ref ref="FILE"/>
    </logger>
</configuration>

解决方案 #

要实现这个需求，你可以使用Logback的SiftingAppender——它支持根据MDC（Mapped Diagnostic Context）中的动态值区分不同日志文件，无需为每个Logger单独创建File Appender。

具体配置步骤 #

1. 替换原有FileAppender为SiftingAppender，通过discriminator指定用于区分日志文件的MDC键，再用sift标签定义内部的FileAppender模板。
2. 在代码中，为对应Logger的日志操作设置MDC中指定的键值，SiftingAppender会自动将日志写入对应文件名的文件。

修改后的logback-spring.xml配置如下：

<?xml version="1.0" encoding="UTF-8"?>
<configuration>

    <property name="pattern" value="%d{dd-MM-yyyy HH:mm:ss.SSS} %-5level: %msg | request #%X{requestNumber}%n" />

    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>${pattern}</pattern>
        </encoder>
    </appender>

    <!-- 用SiftingAppender实现动态日志文件分配 -->
    <appender name="SIFTING_FILE" class="ch.qos.logback.classic.sift.SiftingAppender">
        <!-- 定义区分日志文件的MDC键 -->
        <discriminator>
            <key>logFileName</key>
            <!-- MDC无该值时，默认写入default.log -->
            <defaultValue>default</defaultValue>
        </discriminator>
        <!-- 不同logFileName对应独立的FileAppender实例 -->
        <sift>
            <appender name="FILE-${logFileName}" class="ch.qos.logback.core.FileAppender">
                <file>${logFileName}.log</file>
                <encoder>
                    <pattern>${pattern}</pattern>
                </encoder>
            </appender>
        </sift>
    </appender>

    <!-- 多个Logger共用同一个SiftingAppender -->
    <logger name="request-logger" additivity="false">
        <appender-ref ref="STDOUT"/>
        <appender-ref ref="SIFTING_FILE"/>
    </logger>

    <logger name="error-logger" additivity="false">
        <appender-ref ref="STDOUT"/>
        <appender-ref ref="SIFTING_FILE"/>
    </logger>
</configuration>

代码使用示例 #

在记录日志前设置MDC的logFileName值，即可指定对应的日志文件：

// 写入requests.log
MDC.put("logFileName", "requests");
requestLogger.info("这是一条请求日志");
MDC.remove("logFileName"); // 可选，避免影响后续日志

// 写入errors.log
MDC.put("logFileName", "errors");
errorLogger.error("这是一条错误日志");
MDC.remove("logFileName");

关键说明 #

• SiftingAppender会根据MDC中logFileName的动态值，自动创建并复用对应的FileAppender实例。
• 设置additivity="false"可防止日志重复输出到根Logger。

内容的提问来源于Stack Exchange，提问作者Elad Moshe