MDC是什么

MDC（Mapped Diagnostic Context）是一种日志上下文映射工具，用于在分布式系统中存储和传递与请求相关的上下文信息（如TraceID、用户ID等），从而在日志中实现更细致的请求追踪和问题定位。它是SLF4J（Simple Logging Facade for Java）和Log4j等日志框架的核心组件之一。

核心作用

1. 请求级日志隔离
   在多线程或异步环境中，将同一请求的所有日志关联起来，避免不同请求的日志混淆。

2. 上下文信息透明传递
   无需在每个方法参数中显式传递TraceID、用户ID等信息，日志框架自动将上下文信息注入到日志中。

3. 简化问题排查
   通过统一的标识（如TraceID），快速筛选和聚合特定请求的所有日志，缩短故障定位时间。

工作原理

MDC 基于 ThreadLocal 实现，在当前线程的上下文中维护一个 键值对映射表。当线程处理请求时：

1. 初始化：在请求入口处（如Filter、Interceptor）将 TraceID、用户ID 等信息放入 MDC。
2. 自动注入：日志框架在生成日志时，自动从 MDC 中提取这些信息并添加到日志格式中。
3. 清理：在请求处理结束时，清除 MDC 中的信息，避免内存泄漏和上下文污染。

代码示例

1. 使用 SLF4J MDC

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.slf4j.MDC;

public class MDCExample {
    private static final Logger logger = LoggerFactory.getLogger(MDCExample.class);

    public static void main(String[] args) {
        try {
            // 在请求入口设置MDC
            MDC.put("traceId", "TRACE-12345");
            MDC.put("userId", "USER-007");
            
            // 日志会自动包含MDC中的信息
            logger.info("Processing request...");
            
            // 调用其他方法，无需显式传递traceId
            processBusinessLogic();
            
        } finally {
            // 清理MDC，避免线程复用导致上下文污染
            MDC.clear();
        }
    }

    private static void processBusinessLogic() {
        // 方法内部可以直接使用MDC中的信息
        logger.debug("Handling business logic with traceId: {}", MDC.get("traceId"));
    }
}

2. 配置日志格式

在 logback.xml 中配置 MDC 变量的输出：

<appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
    <encoder>
        <!-- 在日志格式中添加%X{key}来输出MDC中的值 -->
        <pattern>%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{36} [%X{traceId}] [%X{userId}] - %msg%n</pattern>
    </encoder>
</appender>

3. 输出效果

2023-01-01 12:00:00 [main] INFO  MDCExample [TRACE-12345] [USER-007] - Processing request...
2023-01-01 12:00:01 [main] DEBUG MDCExample [TRACE-12345] [USER-007] - Handling business logic with traceId: TRACE-12345

异步环境中的挑战与解决方案

在多线程或异步场景中，MDC 基于 ThreadLocal 的实现会失效，因为子线程无法获取父线程的 MDC 上下文。解决方案包括：

1. 手动传递 MDC

public void submitAsyncTask() {
    // 捕获当前线程的MDC
    Map<String, String> context = MDC.getCopyOfContextMap();
    
    executor.submit(() -> {
        try {
            // 在子线程中恢复MDC
            if (context != null) {
                MDC.setContextMap(context);
            }
            // 执行异步任务
            logger.info("Async task with traceId: {}", MDC.get("traceId"));
        } finally {
            // 清理MDC
            MDC.clear();
        }
    });
}

2. 使用支持 MDC 的线程池

通过包装线程池，自动传递 MDC：

import org.slf4j.MDC;
import java.util.Map;
import java.util.concurrent.*;

public class MDCAwareExecutorService {
    public static ExecutorService wrap(ExecutorService executor) {
        return new ThreadPoolExecutor(
            executor.getCorePoolSize(),
            executor.getMaximumPoolSize(),
            executor.getKeepAliveTime(TimeUnit.MILLISECONDS),
            TimeUnit.MILLISECONDS,
            new LinkedBlockingQueue<>(),
            r -> {
                // 捕获提交任务线程的MDC
                Map<String, String> parentContext = MDC.getCopyOfContextMap();
                return new Thread(() -> {
                    // 在工作线程中恢复MDC
                    if (parentContext != null) {
                        MDC.setContextMap(parentContext);
                    }
                    try {
                        r.run();
                    } finally {
                        // 清理MDC
                        MDC.clear();
                    }
                });
            }
        );
    }
}

与链路追踪工具的结合

MDC 常与 SkyWalking、Zipkin 等链路追踪工具配合使用：

• 自动注入 TraceID：链路追踪工具在生成 TraceID 后，自动将其放入 MDC。
• 日志与追踪数据关联：通过 MDC 中的 TraceID，可快速关联日志与分布式追踪系统中的调用链。

例如，在 Spring Boot 中结合 Sleuth 和 Logback：

// Sleuth会自动将TraceID放入MDC
@RestController
public class HelloController {
    private static final Logger logger = LoggerFactory.getLogger(HelloController.class);

    @GetMapping("/hello")
    public String hello() {
        // 日志会自动包含Sleuth生成的TraceID和SpanID
        logger.info("Handling /hello request");
        return "Hello World!";
    }
}

总结

MDC 是日志增强的重要工具，通过透明地传递上下文信息，显著提升了分布式系统中日志的可追溯性。在使用时需注意：

• 线程安全：在异步场景中需手动传递或使用增强型线程池。
• 资源清理：确保在请求结束时清除 MDC，避免内存泄漏。
• 与链路追踪集成：结合 SkyWalking、Sleuth 等工具，实现全链路的日志关联。