JAVA之MDC的使用教程

文章目录

MDC简介
MDC原理
作用
整体流程
- 添加MDC依赖
- 配置MDC
基本使用过程

MDC简介

MDC(Mapped Diagnostic Context)是用于分布式系统中跟踪和诊断日志的重要概念。是一个在Java项目中用于日志跟踪的工具，它允许你在多线程环境下关联和传递特定的上下文信息。

MDC是一个线程本地的、可维护的、可传递的上下文环境。在Java中，MDC主要用于在应用程序的不同组件之间传递日志上下文信息，例如用户会话ID，请求ID，用户身份信息等。MDC让你可以将这些信息关联到特定的日志事件中，以便后续的日志处理器（如日志输出器）能够在日志中显示或处理这些信息。

MDC原理

MDC的实现原理通常基于线程本地变量（ThreadLocal），每个线程都有自己的MDC，线程在处理请求时可以将上下文信息设置到MDC中，这些信息会和该线程相关联。当日志事件发生时，日志框架会从MDC中获取相应的上下文信息，并将其包含在日志中。

作用

MDC的主要作用是在日志输出时，自动将当前线程的上下文信息，也就是设置在MDC中的信息，添加到日志中。这样可以帮助我们更好地理解系统的行为，特别是在跨线程、跨进程，甚至跨服务器的情况下，轻松地追踪某个请求的完整生命周期。

跟踪日志上下文信息：MDC允许在日志中添加额外的上下文信息，帮助理解日志事件发生的背景和环境；
诊断和调试：在多线程环境中，使用MDC可以将特定的上下文信息关联到日志中，有助于排查问题和调试程序。
日志过滤和路由：MDC中的上下文信息可以被日志处理器用来过滤，路由或分类日志事件，例如基金用户会话ID将日志事件路由到特定的日志文件或系统。

整体流程

以下是实现MDC的整体流程

步骤	描述
1	添加MDC依赖
2	配置MDC
3	在代码中使用MDC

下面让我们逐步详细说明每个步骤。

添加MDC依赖

首先，我们需要添加MDC的依赖项。在Java中，我么不可以使用Logback或Log4J作为日志框架，并通过依赖项来添加MDC支持，下面是Maven项目中添加Logback MDC的依赖项的示例。

首先，你需要在项目的依赖中添加Logback相关的依赖项，如果使用Maven，可以在pom.xml中添加以下依赖：

xml 复制代码

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

配置MDC

创建Logback配置文件：在项目的资源目录下创建一个名为logback.xml的配置文件。Logback会自动查找并加载这个文件作为配置。
编写Logback配置
下面展示一个简单的LogBack配置示例

xml 复制代码

<configuration>
    <!-- 定义日志输出格式 -->
    <conversionRule conversionWord="sessionId" converterClass="com.example.SessionIdConverter" />
    <!-- 定义日志输出器 -->
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg %sessionId%n</pattern>
        </encoder>
    </appender>
    <!-- 设置日志级别 -->
    <root level="DEBUG">
        <appender-ref ref="STDOUT" />
    </root>
</configuration>

conversionRule 元素定义了自定义的转换规则，这里示例中定义了一个名为 sessionId 的转换器，用于在日志中输出会话

ID。 appender 元素定义了日志输出器，这里使用 ConsoleAppender 将日志输出到控制台。 encoder

元素定义了日志的输出格式，这里使用 %pattern 来定义输出格式，包括时间、线程名、日志级别、日志名称、消息以及会话 ID。 root

元素指定了根日志记录器，并将其级别设置为 DEBUG，并将日志输出到名为 STDOUT 的输出器上。

设置上下文信息
在代码中，当需要记录日志时，你可以通过代码将相关的上下文信息设置到MDC中。例如，在请求开始时，你可以设置会话ID

java 复制代码

import org.slf4j.MDC;

// 设置用户会话 ID 到 MDC
MDC.put("sessionId", sessionId);

记录日志
当需要记录日志时，日志框架会自动将MDC中的上下文信息包含到日志中。你可以在日志消息中使用占位符来引用MDC中的上下文信息，具体使用方式取决于日志框架和日志输出格式。
清楚上下文信息
当请求处理结束后，记得清楚MDC中的上下文信息，以免影响后续请求的日志记录。

java 复制代码

//清除MDC的上下文信息
MDC.clear();

这样通过MDC你就可以在日志中记录和传递特定的上下文信息，从而更好地理解和分析应用程序中的日志。

基本使用过程

使用MDC的步骤通常如下：

设置MDC中的信息
可以在代码中通过MDC的put方法来讲需要记录的信息设置到MDC中，例如：

java 复制代码

MDC.put("transactionId","12345678");
MDC.put("userId","foo");

在日志中使用MDC
在日志输出中，我们可以使用占位符来引用MDC中的信息。例如，使用logback日志框架啊来输出日志，我们可以这样使用：

java 复制代码

logger.info("Some message with transactionId {} and userId {}",MDC.get("transactionId"),MDC.get("userId"));

清除MDC中的信息
当不再需要MDC中的信息时，可以通过调用MDC的remove方法来清除它们。例如：

java 复制代码

MDC.remove("transactionId");
MDC.remove("userId");