MDC介绍

MDC（Mapped Diagnostic Context，映射诊断上下文）是一种在日志记录中用于传递和管理上下文信息的工具，在Java的日志框架中广泛应用，如Log4j、Logback等。以下是关于MDC的详细介绍：

基本概念

MDC是一个与当前执行线程绑定的上下文对象，它允许开发者在应用程序的不同部分（例如不同的方法、不同的类）中设置和获取与当前操作相关的上下文信息。这些信息可以包括用户ID、请求ID、事务ID、操作时间等，并且会随着日志记录一起输出，有助于在复杂的分布式系统或多线程环境中跟踪和诊断问题。

工作原理

• 存储数据：MDC本质上是一个基于线程的本地存储（Thread Local Storage）。当一个线程在执行过程中向MDC中放入数据时，这些数据会与该线程绑定。例如，在处理一个HTTP请求的线程中设置了请求ID到MDC，那么这个请求ID就会与该线程关联起来。
• 日志关联：在日志记录过程中，日志框架会从当前线程的MDC中获取相关信息，并将其添加到日志消息中。这样，每条日志都会包含与之相关的上下文信息，方便开发人员在查看日志时能够快速定位问题所在的请求或操作。

主要作用

• 请求跟踪：在分布式系统中，一个请求可能会经过多个服务或模块，通过在每个服务中设置和传递相同的请求ID到MDC，开发人员可以在不同服务的日志中快速找到与该请求相关的所有记录，从而更好地理解请求的处理流程和排查问题。
• 多线程区分：在多线程应用程序中，不同线程可能会执行相同的代码逻辑，但需要区分不同线程的操作。MDC可以为每个线程设置独特的上下文信息，使得日志能够清晰地显示每个线程的执行情况。
• 业务信息记录：可以将一些重要的业务信息（如用户ID、订单ID等）放入MDC，以便在日志中快速了解与业务操作相关的信息，有助于进行业务分析和问题定位。

使用示例（以Logback为例）

• 添加依赖
  在Maven项目中，需要添加Logback的相关依赖：

  <dependency>
  <groupId>ch.qos.logback</groupId>
  <artifactId>logback-classic</artifactId>
  <version>1.2.3</version>
  </dependency>

• 代码中使用

  import ch.qos.logback.classic.Logger;
  import org.slf4j.LoggerFactory;
  import org.slf4j.MDC;
  public class MDCExample {
  public static void main(String[] args) {
      // 设置MDC中的信息
      MDC.put("requestId", "123456");
      MDC.put("userId", "user001");
  
      Logger logger = (Logger) LoggerFactory.getLogger(MDCExample.class);
      logger.info("This is an info message.");
  
      // 清除MDC中的信息
      MDC.clear();
  }
  }

• 配置文件设置
  在 logback.xml 配置文件中，可以通过 %X{key} 的形式来输出MDC中的信息：

  <configuration>
  <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
      <encoder>
          <pattern>%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{36} [%X{requestId}] [%X{userId}] - %msg%n</pattern>
      </encoder>
  </appender>
  
  <root level="info">
      <appender-ref ref="CONSOLE" />
  </root>
  </configuration>

除非注明，否则均为李锋镝的博客原创文章，转载必须以链接形式标明本文链接

本文链接：https://www.lifengdi.com/article/4230