news 2026/3/1 14:53:00

实战！SpringBoot+MDC实现全链路调用日志跟踪~

作者头像

张小明

前端开发工程师

1.2k 24
文章封面图
实战！SpringBoot+MDC实现全链路调用日志跟踪~

之前有一篇文章简单的介绍过MDC，这次结合具体的案例、生产中的具体问题深入了解一下MDC。

MDC介绍

1、简介：

MDC（Mapped Diagnostic Context，映射调试上下文）是 log4j 、logback及log4j2 提供的一种方便在多线程条件下记录日志的功能。MDC 可以看成是一个与当前线程绑定的哈希表，可以往其中添加键值对。MDC 中包含的内容可以被同一线程中执行的代码所访问。

当前线程的子线程会继承其父线程中的 MDC 的内容。当需要记录日志时，只需要从 MDC 中获取所需的信息即可。MDC 的内容则由程序在适当的时候保存进去。对于一个 Web 应用来说，通常是在请求被处理的最开始保存这些数据

2、API说明：

  • clear()：移除所有MDC

  • get (String key)：获取当前线程MDC中指定key的值

  • getContext()：获取当前线程MDC的MDC

  • put(String key, Object o)：往当前线程的MDC中存入指定的键值对

  • remove(String key)：删除当前线程MDC中指定的键值对

3、优点：

代码简洁，日志风格统一，不需要在log打印中手动拼写traceId，即LOGGER.info("traceId:{} ", traceId)

MDC使用

1、添加拦截器

public class LogInterceptor implements HandlerInterceptor { @Override public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { //如果有上层调用就用上层的ID String traceId = request.getHeader(Constants.TRACE_ID); if (traceId == null) { traceId = TraceIdUtil.getTraceId(); } MDC.put(Constants.TRACE_ID, traceId); return true; } @Override public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception { } @Override public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception { //调用结束后删除 MDC.remove(Constants.TRACE_ID); } }

2、修改日志格式

<property name="pattern">[TRACEID:%X{traceId}] %d{HH:mm:ss.SSS} %-5level %class{-1}.%M()/%L - %msg%xEx%n</property>

重点是%X{traceId}，traceId和MDC中的键名称一致

简单使用就这么容易，但是在有些情况下traceId将获取不到

MDC 存在的问题

  • 子线程中打印日志丢失traceId

  • HTTP调用丢失traceId

丢失traceId的情况，来一个再解决一个，绝不提前优化

解决MDC存在的问题

子线程日志打印丢失traceId

子线程在打印日志的过程中traceId将丢失，解决方式为重写线程池，对于直接new创建线程的情况不考略【实际应用中应该避免这种用法】，重写线程池无非是对任务进行一次封装

线程池封装类：ThreadPoolExecutorMdcWrapper.java

public class ThreadPoolExecutorMdcWrapper extends ThreadPoolExecutor { public ThreadPoolExecutorMdcWrapper(int corePoolSize, int maximumPoolSize, long keepAliveTime, TimeUnit unit, BlockingQueue<Runnable> workQueue) { super(corePoolSize, maximumPoolSize, keepAliveTime, unit, workQueue); } public ThreadPoolExecutorMdcWrapper(int corePoolSize, int maximumPoolSize, long keepAliveTime, TimeUnit unit, BlockingQueue<Runnable> workQueue, ThreadFactory threadFactory) { super(corePoolSize, maximumPoolSize, keepAliveTime, unit, workQueue, threadFactory); } public ThreadPoolExecutorMdcWrapper(int corePoolSize, int maximumPoolSize, long keepAliveTime, TimeUnit unit, BlockingQueue<Runnable> workQueue, RejectedExecutionHandler handler) { super(corePoolSize, maximumPoolSize, keepAliveTime, unit, workQueue, handler); } public ThreadPoolExecutorMdcWrapper(int corePoolSize, int maximumPoolSize, long keepAliveTime, TimeUnit unit, BlockingQueue<Runnable> workQueue, ThreadFactory threadFactory, RejectedExecutionHandler handler) { super(corePoolSize, maximumPoolSize, keepAliveTime, unit, workQueue, threadFactory, handler); } @Override public void execute(Runnable task) { super.execute(ThreadMdcUtil.wrap(task, MDC.getCopyOfContextMap())); } @Override public <T> Future<T> submit(Runnable task, T result) { return super.submit(ThreadMdcUtil.wrap(task, MDC.getCopyOfContextMap()), result); } @Override public <T> Future<T> submit(Callable<T> task) { return super.submit(ThreadMdcUtil.wrap(task, MDC.getCopyOfContextMap())); } @Override public Future<?> submit(Runnable task) { return super.submit(ThreadMdcUtil.wrap(task, MDC.getCopyOfContextMap())); } }

说明：

  • 继承ThreadPoolExecutor类，重新执行任务的方法

  • 通过ThreadMdcUtil对任务进行一次包装

线程traceId封装工具类：ThreadMdcUtil.java

public class ThreadMdcUtil { public static void setTraceIdIfAbsent() { if (MDC.get(Constants.TRACE_ID) == null) { MDC.put(Constants.TRACE_ID, TraceIdUtil.getTraceId()); } } public static <T> Callable<T> wrap(final Callable<T> callable, final Map<String, String> context) { return () -> { if (context == null) { MDC.clear(); } else { MDC.setContextMap(context); } setTraceIdIfAbsent(); try { return callable.call(); } finally { MDC.clear(); } }; } public static Runnable wrap(final Runnable runnable, final Map<String, String> context) { return () -> { if (context == null) { MDC.clear(); } else { MDC.setContextMap(context); } setTraceIdIfAbsent(); try { runnable.run(); } finally { MDC.clear(); } }; } }

说明【以封装Runnable为例】：

  • 判断当前线程对应MDC的Map是否存在，存在则设置

  • 设置MDC中的traceId值，不存在则新生成，针对不是子线程的情况，如果是子线程，MDC中traceId不为null

  • 执行run方法

代码等同于以下写法，会更直观

public static Runnable wrap(final Runnable runnable, final Map<String, String> context) { return new Runnable() { @Override public void run() { if (context == null) { MDC.clear(); } else { MDC.setContextMap(context); } setTraceIdIfAbsent(); try { runnable.run(); } finally { MDC.clear(); } } }; }

重新返回的是包装后的Runnable，在该任务执行之前【runnable.run()】先将主线程的Map设置到当前线程中【 即MDC.setContextMap(context)】，这样子线程和主线程MDC对应的Map就是一样的了

  • 判断当前线程对应MDC的Map是否存在，存在则设置

  • 设置MDC中的traceId值，不存在则新生成，针对不是子线程的情况，如果是子线程，MDC中traceId不为null

  • 执行run方法

HTTP调用丢失traceId

在使用HTTP调用第三方服务接口时traceId将丢失，需要对HTTP调用工具进行改造，在发送时在request header中添加traceId，在下层被调用方添加拦截器获取header中的traceId添加到MDC中

HTTP调用有多种方式，比较常见的有HttpClient、OKHttp、RestTemplate，所以只给出这几种HTTP调用的解决方式

1、HttpClient：

实现HttpClient拦截器：

public class HttpClientTraceIdInterceptor implements HttpRequestInterceptor { @Override public void process(HttpRequest httpRequest, HttpContext httpContext) throws HttpException, IOException { String traceId = MDC.get(Constants.TRACE_ID); //当前线程调用中有traceId，则将该traceId进行透传 if (traceId != null) { //添加请求体 httpRequest.addHeader(Constants.TRACE_ID, traceId); } } }

实现HttpRequestInterceptor接口并重写process方法

如果调用线程中含有traceId，则需要将获取到的traceId通过request中的header向下透传下去

为HttpClient添加拦截器：

private static CloseableHttpClient httpClient = HttpClientBuilder.create() .addInterceptorFirst(new HttpClientTraceIdInterceptor()) .build();

通过addInterceptorFirst方法为HttpClient添加拦截器

2、OKHttp：

实现OKHttp拦截器：

public class OkHttpTraceIdInterceptor implements Interceptor { @Override public Response intercept(Chain chain) throws IOException { String traceId = MDC.get(Constants.TRACE_ID); Request request = null; if (traceId != null) { //添加请求体 request = chain.request().newBuilder().addHeader(Constants.TRACE_ID, traceId).build(); } Response originResponse = chain.proceed(request); return originResponse; } }

实现Interceptor拦截器，重写interceptor方法，实现逻辑和HttpClient差不多，如果能够获取到当前线程的traceId则向下透传

为OkHttp添加拦截器：

private static OkHttpClient client = new OkHttpClient.Builder() .addNetworkInterceptor(new OkHttpTraceIdInterceptor()) .build();

调用addNetworkInterceptor方法添加拦截器

3、RestTemplate：

实现RestTemplate拦截器：

public class RestTemplateTraceIdInterceptor implements ClientHttpRequestInterceptor { @Override public ClientHttpResponse intercept(HttpRequest httpRequest, byte[] bytes, ClientHttpRequestExecution clientHttpRequestExecution) throws IOException { String traceId = MDC.get(Constants.TRACE_ID); if (traceId != null) { httpRequest.getHeaders().add(Constants.TRACE_ID, traceId); } return clientHttpRequestExecution.execute(httpRequest, bytes); } }

实现ClientHttpRequestInterceptor接口，并重写intercept方法，其余逻辑都是一样的不重复说明

为RestTemplate添加拦截器：

restTemplate.setInterceptors(Arrays.asList(new RestTemplateTraceIdInterceptor()));

调用setInterceptors方法添加拦截器

4、第三方服务拦截器：

HTTP调用第三方服务接口全流程traceId需要第三方服务配合，第三方服务需要添加拦截器拿到request header中的traceId并添加到MDC中

public class LogInterceptor implements HandlerInterceptor { @Override public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { //如果有上层调用就用上层的ID String traceId = request.getHeader(Constants.TRACE_ID); if (traceId == null) { traceId = TraceIdUtils.getTraceId(); } MDC.put("traceId", traceId); return true; } @Override public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception { } @Override public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception { MDC.remove(Constants.TRACE_ID); } }

说明：

  • 先从request header中获取traceId

  • 从request header中获取不到traceId则说明不是第三方调用，直接生成一个新的traceId

  • 将生成的traceId存入MDC中

除了需要添加拦截器之外，还需要在日志格式中添加traceId的打印，如下：

<property name="pattern">[TRACEID:%X{traceId}] %d{HH:mm:ss.SSS} %-5level %class{-1}.%M()/%L - %msg%xEx%n</property>
“

注意：需要添加%X{traceId}

”

最后说一句（别白嫖，求关注）

如果这篇文章对你有所帮助，或者有所启发的话，帮忙点赞、在看、转发、收藏，你的支持就是我坚持下去的最大动力！

版权声明: 本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若内容造成侵权/违法违规/事实不符，请联系邮箱：809451989@qq.com进行投诉反馈，一经查实，立即删除！
网站建设 2026/2/27 9:30:56

Instinct模型：下一代AI代码编辑革命，6.4倍效率提升的智能编程助手

在当今快节奏的软件开发领域&#xff0c;每一次代码编辑都意味着宝贵时间的投入。传统IDE工具虽然提供了基础的自动补全功能&#xff0c;但在面对复杂的重构任务时往往显得力不从心。Continue团队推出的开源Instinct模型&#xff0c;正是为了解决这一痛点而生&#xff0c;通过A…

作者头像 李华
网站建设 2026/3/1 5:42:39

百度贴吧用户脚本：让你的贴吧体验飞升的实用工具箱

百度贴吧用户脚本&#xff1a;让你的贴吧体验飞升的实用工具箱 【免费下载链接】baidu-tieba-userscript 需要&#xff1a;支持扩展的浏览器&#xff0c;例如谷歌&#xff0c;yandex&#xff0c;火狐等&#xff1b;扩展&#xff1a;Tampermonkey脚本管理器; 项目地址: https:…

作者头像 李华
网站建设 2026/2/27 12:27:39

探索wgpu性能优化的实践之路

探索wgpu性能优化的实践之路 【免费下载链接】wgpu Cross-platform, safe, pure-rust graphics api. 项目地址: https://gitcode.com/GitHub_Trending/wg/wgpu 在图形编程的世界里&#xff0c;我们常常面临这样的困境&#xff1a;精心设计的渲染场景在运行时却出现帧率波…

作者头像 李华
网站建设 2026/2/28 7:57:08

Flutter音频可视化技术深度解析：从信号处理到沉浸式体验

在当今多媒体应用蓬勃发展的时代&#xff0c;音频可视化技术已成为提升用户体验的关键要素。Flutter Engine凭借其强大的图形渲染能力和灵活的架构设计&#xff0c;为开发者提供了实现专业级音频可视化效果的完整解决方案。本文将深入探讨Flutter音频可视化的技术原理、实现方法…

作者头像 李华
网站建设 2026/2/27 14:47:32

3步搞定Druid连接池容器化部署：从零到生产级配置

3步搞定Druid连接池容器化部署&#xff1a;从零到生产级配置 【免费下载链接】druid 阿里云计算平台DataWorks(https://help.aliyun.com/document_detail/137663.html) 团队出品&#xff0c;为监控而生的数据库连接池 项目地址: https://gitcode.com/gh_mirrors/druid/druid …

作者头像 李华
网站建设 2026/2/24 13:12:50

互联网大厂Java求职面试全场景模拟:核心技术与业务实战解析

第一轮:基础与核心技术 面试官:你好,谢飞机,我们先从Java SE和构建工具开始。请你简述一下Java 8和Java 11的主要区别,以及你平时用Maven还是Gradle? 谢飞机:Java 8引入了Lambda表达式和StreamAPI,Java 11增加了HttpClient等新特性。我平时用Maven,项目管理方便。 面试官:很好…

作者头像 李华