理解 MDC：如何更好地记录日志并追踪事件和问题

╰+哭是因爲堅強的太久メ 2024-03-23 14:04 60阅读 0赞

#### 目录 ####

*  一、MDC介绍
 *  二、常用方法及功能介绍
 *  三、部分源码介绍
 *  四、适用场景
 *  五、总结

## 一、MDC介绍 ##

MDC（Mapped Diagnostic Contexts）是SLF4J（Simple Logging Facade for Java）日志框架中非常重要的一个组件，用于在应用程序中记录上下文信息。MDC 可以将关键信息与当前线程进行绑定，从而使得这些信息在日志中的记录更加丰富和有用。

MDC 中最常用的方法是 put() 和 get() 方法。put() 方法用于将一个键值对存储到当前线程的 MDC 中，而 get() 方法用于从 MDC 中获取指定键的值。除此之外，还有一些其他的方法可以用于清除当前线程的 MDC 或者复制 MDC 中的数据到子线程中。

## 二、常用方法及功能介绍 ##

下面是 MDC 中常用的方法及其功能的介绍：

1.  put(String key, String value)  
    用于将一个键值对存储到当前线程的 MDC 中。MDC 中的数据是以 Map 的形式存储的，因此 key 和 value 都是字符串类型。当需要记录一些上下文信息时，可以使用 put() 方法将这些信息存储到 MDC 中，例如：

MDC.put("userId", "123456");
    MDC.put("requestId", UUID.randomUUID().toString());

1.  String get(String key)  
    用于从当前线程的 MDC 中获取指定键的值。如果指定键不存在，则返回 null。例如：

String userId = MDC.get("userId");
    String requestId = MDC.get("requestId");

1.  void remove(String key)  
    用于从当前线程的 MDC 中删除指定键的值。例如：

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

1.  void clear()  
    用于清空当前线程的 MDC 中的所有数据。例如：

MDC.clear();

除了上述方法之外，MDC 还提供了一些其他的方法，例如：

1.  void setContextMap(Map<String, String> contextMap)  
    用于将指定的 Map 对象中的数据复制到当前线程的 MDC 中。
2.  Map<String, String> getCopyOfContextMap()  
    用于获取当前线程的 MDC 中的数据的副本，以 Map 的形式返回。
3.  void setContextClassLoader(ClassLoader classLoader)  
    用于设置当前线程的上下文类加载器。

## 三、部分源码介绍 ##

MDC 的实现源码可以在 SLF4J 的官方 GitHub 仓库中找到。MDC 的核心实现代码位于 org.slf4j.MDC 类中，其中主要涉及到了 ThreadLocal 和 Map 数据结构的使用。

MDC 通过 ThreadLocal 存储每个线程的 MDC 上下文信息，以保证线程安全。在 MDC 类的静态代码块中，会初始化一个 ThreadLocal 对象：

private static final ThreadLocal<Map<String, String>> mdcAdapter = new ThreadLocal<Map<String, String>>() {
        
        @Override
        protected Map<String, String> initialValue() {
        
            return new HashMap<String, String>();
        }
    };

在put() 和 get() 方法中，MDC 会获取当前线程的 MDC 上下文信息，然后在这个 Map 对象中进行键值对的操作。例如，在 put() 方法中，MDC 会获取当前线程的 MDC 上下文信息，并将键值对存储到这个 Map 对象中：

public static void put(String key, String val) throws IllegalArgumentException {
        
        if (key == null) {
        
            throw new IllegalArgumentException("key cannot be null");
        }
    
        if (mdcAdapter.get() == null) {
        
            throw new IllegalStateException("MDCAdapter cannot be null. See also " + MDCAdapter.NULL_MDC_ADAPTER);
        }
    
        mdcAdapter.get().put(key, val);
    }

在 get() 方法中，MDC 会获取当前线程的 MDC 上下文信息，并从这个 Map 对象中获取指定键的值：

public static String get(String key) throws IllegalArgumentException {
        
        if (key == null) {
        
            throw new IllegalArgumentException("key cannot be null");
        }
    
        if (mdcAdapter.get() == null) {
        
            throw new IllegalStateException("MDCAdapter cannot be null. See also " + MDCAdapter.NULL_MDC_ADAPTER);
        }
    
        return mdcAdapter.get().get(key);
    }

需要注意的是，MDC 中的数据是以 Map 的形式存储的，因此在使用 put() 和 get() 方法时，键和值都必须是字符串类型。在 MDC 的实现中，MDCAdapter 接口是一个适配器接口，用于将 MDC 的实现绑定到具体的日志框架中。如果你使用的是 Log4j、Logback 或者其他的 SLF4J 实现框架，那么 MDC 的具体实现都是不同的，但是 MDC 的 API 接口是相同的。

## 四、适用场景 ##

MDC 可以用于各种场景，例如：

1.  在分布式系统中，使用 MDC 记录请求的唯一标识符和其他上下文信息，从而能够跨线程、跨进程地追踪请求的完整生命周期。
2.  在安全审计、性能分析等场景中，使用 MDC 记录关键信息，从而方便对系统的行为和性能进行分析和调优。
3.  在应用程序中，使用 MDC 记录一些调试信息，例如用户登录信息、请求参数、异常堆栈等，以方便问题的定位和解决。

## 五、总结 ##

总之，MDC 是一个非常重要的日志组件，可以帮助我们更好地记录上下文信息，并从日志中更加清晰地了解系统的行为和性能。在使用 MDC 时，我们需要注意线程安全和键值对的类型转换问题，以免出现错误和异常。