Log4j2在RoutingAppender中无法读取ThreadContext变量求助

核心原因 #

Log4j2的文件名解析逻辑和PatternLayout的消息解析逻辑相互独立：文件名默认由StrSubstitutor处理，仅支持有限变量（如${date}、${instance}）；%X{key}是PatternLayout专属语法，不能直接用于文件名。早期版本的Log4j2对文件名中的MDC变量支持不完善，需通过特定配置触发解析。

具体解决步骤 #

1. 用RoutingAppender的pattern属性传递MDC值 #

在Routes节点通过pattern指定MDC变量作为路由键，再在RollingFile的文件名中引用该键，注意用$$转义$避免提前解析：

<Routing name="Routing">
  <Routes pattern="$${mdc:User}_$${mdc:Channel}">
    <Route>
      <RollingFile name="Rolling-${mdc:User}-${mdc:Channel}"
                   fileName="logs/${mdc:User}_${mdc:Channel}.log"
                   filePattern="logs/archive/${mdc:User}_${mdc:Channel}_%d{yyyyMMdd}.log.gz">
        <PatternLayout pattern="%d %X{User} %X{Channel} %m%n"/>
        <SizeBasedTriggeringPolicy size="10MB"/>
      </RollingFile>
    </Route>
  </Routes>
</Routing>

2. 升级Log4j2版本到2.9及以上 #

2.8及以下版本对文件名MDC变量解析存在缺陷，升级到2.9+版本可直接修复该问题，无需额外配置。

3. 用${ctx:key}替代${mdc:key} #

Log4j2中${ctx:key}是ThreadContext（MDC的实现类）的变量引用语法，可直接用于文件名，前提是日志输出前已在ThreadContext中绑定变量：

<RollingFile name="Rolling-User"
             fileName="logs/${ctx:User}_${ctx:Channel}.log"
             filePattern="logs/archive/${ctx:User}_${ctx:Channel}_%d{yyyyMMdd}.log.gz">
  <PatternLayout pattern="%d %X{User} %X{Channel} %m%n"/>
  <SizeBasedTriggeringPolicy size="10MB"/>
</RollingFile>

代码中绑定变量示例：

ThreadContext.put("User", currentUser);
ThreadContext.put("Channel", currentChannel);
logger.info("日志内容");
// 线程池环境下记得清理变量，避免上下文污染
ThreadContext.remove("User");
ThreadContext.remove("Channel");

4. 开启调试日志排查 #

在配置根节点添加status="debug"，查看启动日志中的变量解析过程，确认MDC变量是否被正确识别：

<Configuration status="debug">
  <!-- 其他配置节点 -->
</Configuration>

内容的提问来源于stack exchange，提问作者user1079475