MDC-Mapped Diagnostic Context（映射诊断上下文）

NEUMaple

于 2025-03-20 14:56:13 发布

阅读量526

点赞数 6

分类专栏：微服务文章标签： spring boot java MDC

本文链接：https://blog.csdn.net/weixin_45734473/article/details/146397277

版权

微服务专栏收录该内容

13 篇文章

订阅专栏

MDC，全称为Mapped Diagnostic Context（映射诊断上下文），是SLF4J（Simple Logging Facade for Java）提供的一种机制，用于在多线程应用中存储和管理与特定线程相关的上下文信息。这种机制特别适用于需要跨多个方法调用或服务边界传递诊断信息的场景，例如跟踪分布式系统中的请求流。

MDC的主要用途

日志关联：在分布式系统或多线程应用中，MDC可以用来携带一些上下文信息（如用户ID、请求ID、跟踪ID等），使得这些信息可以在整个请求处理过程中被记录到日志中。这样，当查看日志时，可以通过这些上下文信息快速地将相关日志条目关联起来，便于问题排查和性能分析。
调试和监控：通过在MDC中添加关键的诊断信息，开发人员可以更容易地进行调试和监控。比如，在微服务架构中，一个外部请求可能会经过多个服务，如果每个服务都能记录相同的跟踪ID，那么就可以轻松地追踪这个请求在整个系统中的流动情况。

使用MDC的基本步骤

添加依赖：确保你的项目中包含了SLF4J及其具体实现（如Logback）的依赖。

设置MDC数据：通常在请求开始的地方（如Servlet过滤器、Spring拦截器等）设置MDC数据。

import org.slf4j.MDC;

public class RequestFilter {
    public void doFilter() {
        MDC.put("traceId", UUID.randomUUID().toString());
        // 处理请求...
        MDC.clear(); // 请求结束时清除MDC数据
    }
}

在日志格式中引用MDC数据：如前面提到的日志模式配置所示，可以通过%X{key}语法在日志格式中引用MDC中的数据。
```
<property name="log.pattern"
          value="%d{yyyy-MM-dd HH:mm:ss} %-5level [%X{traceId:-}] [%thread] %logger{36}  :  %msg%n"/>
```
在这个例子中，%X{traceId}表示从MDC中获取名为traceId的值，并将其包含在日志输出中。

示例

假设你有一个简单的Web应用程序，每当收到一个新的HTTP请求时，你想为该请求分配一个唯一的跟踪ID，并确保这个ID出现在所有相关的日志条目中。你可以这样做：

在请求到达时设置跟踪ID：

import javax.servlet.Filter;
import javax.servlet.FilterChain;
import javax.servlet.FilterConfig;
import javax.servlet.ServletException;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;
import java.io.IOException;
import org.slf4j.MDC;

public class TraceIdFilter implements Filter {

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
            throws IOException, ServletException {
        String traceId = java.util.UUID.randomUUID().toString();
        MDC.put("traceId", traceId);
        try {
            chain.doFilter(request, response);
        } finally {
            MDC.clear(); // 确保清除MDC数据，避免内存泄漏
        }
    }

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {}

    @Override
    public void destroy() {}
}

在日志中使用跟踪ID：当你在代码中记录日志时，不需要做任何特殊的事情来包含跟踪ID，因为日志框架会自动根据配置文件中的格式解析并包含它。

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

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

    public void performTask() {
        logger.info("Performing task...");
    }
}

这样一来，所有的日志都会自动包含这个请求的跟踪ID，方便后续的问题排查和日志分析。