Log4j2如何添加运行时上下文以让所有日志包含该上下文？

问题本质 #

ThreadContext依赖线程本地存储（ThreadLocal）实现上下文传递，线程切换后新线程无法自动获取原线程的上下文数据，导致日志中丢失版本信息。

实用解决方案 #

1. 手动传递上下文到子线程 #

在提交异步任务时，主动复制原线程的ThreadContext数据到子线程：

// 原线程中获取当前上下文快照
Map<String, String> contextSnapshot = ThreadContext.getImmutableContext();

// 提交任务到线程池时携带上下文
executorService.submit(() -> {
    // 恢复上下文
    ThreadContext.putAll(contextSnapshot);
    try {
        // 执行业务逻辑，此时日志会包含version字段
        logger.info("异步任务执行中");
    } finally {
        // 任务结束后清理上下文，避免污染线程池中的线程
        ThreadContext.clearAll();
    }
});

2. 线程池自动上下文传递（推荐） #

如果使用Spring框架，可通过TaskDecorator实现线程池的上下文自动传递，无需手动处理每个任务：

@Bean
public Executor asyncTaskExecutor() {
    ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
    executor.setCorePoolSize(4);
    executor.setMaxPoolSize(8);
    executor.setQueueCapacity(16);
    
    // 配置任务装饰器，自动传递ThreadContext
    executor.setTaskDecorator(runnable -> {
        Map<String, String> currentContext = ThreadContext.getImmutableContext();
        return () -> {
            try {
                ThreadContext.putAll(currentContext);
                runnable.run();
            } finally {
                ThreadContext.clearAll();
            }
        };
    });
    
    executor.initialize();
    return executor;
}

非Spring环境也可以自定义线程池的任务包装逻辑，实现相同效果。

3. 开启Log4j 2的上下文继承特性 #

Log4j 2.9及以上版本支持通过系统属性开启线程上下文的自动继承：

# 在配置文件或JVM启动参数中添加
log4j2.threadContextMapInheritable=true

开启后子线程会自动继承父线程的ThreadContext数据，但要注意线程池复用线程时可能残留旧上下文，仍需在任务结束后清理。

关键注意点 #

• 务必在任务执行完成后调用ThreadContext.clearAll()，避免线程复用导致的上下文污染。
• Web应用中，建议在请求拦截器的入口设置ThreadContext.put("version", myAppVersion)，在请求结束时清理，配合线程池的上下文传递即可覆盖所有场景。

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