JAVA之MAC详解以及子线程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中的信息
    通过普通代码、拦截器或者AOP在方法调用链最开始,设置MDC的值。例如:
java 复制代码
MDC.put("traceId","12345678");
MDC.put("requestId","request-998");
  1. 定义日志格式,其中%X{}代表去MDC取值,例如:
xml 复制代码
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %thread | %X{traceId} | %X{requestId} | %-5level %logger{50} %msg%n</pattern>
  1. 清除MDC中的信息
    当不再需要MDC中的信息时,可以通过调用MDC的remove方法来清除它们。例如:
java 复制代码
MDC.remove("traceId");
MDC.remove("requestId");

子线程MDC传递

既然我们知道MDC底层使用TreadLocal来实现,那根据TreadLocal的特点,它是可以让我们在同一个线程中共享数据的,但是往往我们在业务方法中,会开启多线程来执行程序,这样的话MDC就无法传递到其他子线程了。这时,我们需要使用额外的方法来传递存在TreadLocal里的值。MDC提供了一个叫getCopyOfContextMap的方法,很显然,该方法就是把当前线程TreadLocal绑定的Map获取出来,之后就是把该Map绑定到子线程中的ThreadLocal中了,具体代码如下:

java 复制代码
Map<String, String> copyOfContextMap = MDC.getCopyOfContextMap();
new Thread(() -> {
	if (copyOfContextMap != null) {
		MDC.setContextMap(copyOfContextMap);
	}
	log.info("这个是子线程的信息");
}).start();

也就是说,我们在主线程中获取MDC的值,然后在子线程中设置进去,这样,子线程打印的信息也会带有整个调用链共同的traceId了。

相关推荐
shuair1 小时前
idea 2023.3.7常用插件
java·ide·intellij-idea
小安同学iter1 小时前
使用Maven将Web应用打包并部署到Tomcat服务器运行
java·tomcat·maven
Yvonne9782 小时前
创建三个节点
java·大数据
不会飞的小龙人3 小时前
Kafka消息服务之Java工具类
java·kafka·消息队列·mq
是小崔啊3 小时前
java网络编程02 - HTTP、HTTPS详解
java·网络·http
brevity_souls4 小时前
Spring Boot 内置工具类
java·spring boot
小钊(求职中)4 小时前
Java开发实习面试笔试题(含答案)
java·开发语言·spring boot·spring·面试·tomcat·maven
shix .4 小时前
什么是tomcat
java·tomcat
java技术小馆4 小时前
Deepseek整合SpringAI
java·spring cloud
天荒地老笑话么4 小时前
Mac安装配置Tomcat 8
java·macos·tomcat