SpringBoot+MDC实现全链路调用日志跟踪 在前面写的一篇 文章 中，热心网友【地藏Kelvin】评论说在多线程中还是有可能会乱掉，建议通过MDC打印traceId来个全链路调用跟踪。掘金里个个都是人才，说话又好听，超喜欢在里面。掘金使我进步，热心网友总能提出改进意见 通过本文将了解到什么是MDC、MDC应用中存在的问题、如何解决存在的问题 MDC（Mapped Diagnostic Context，映射调试上下文）是 log4j 、logback及log4j2 提供的一种方便在多线程条件下记录日志的功能。 MDC 可以看成是一个 与当前线程绑定的哈希表 ，可以往其中添加键值对。MDC 中包含的内容可以 被同一线程中执行的代码所访问 。当前线程的子线程会继承其父线程中的 MDC 的内容。当需要记录日志时，只需要从 MDC 中获取所需的信息即可。MDC 的内容则由程序在适当的时候保存进去。对于一个 Web 应用来说，通常是在请求被处理的最开始保存这些数据 clear() => 移除所有MDC get (String key) => 获取当前线程MDC中指定key的值 getContext() => 获取当前线程MDC的MDC put(String key, Object o) => 往当前线程的MDC中存入指定的键值对 remove(String key) => 删除当前线程MDC中指定的键值对 代码简洁，日志风格统一，不需要在log打印中手动拼写traceId，即LOGGER.info("traceId:{} ", traceId) 添加拦截器 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); } } 修改日志格式 <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将获取不到 重点是 %X{traceId} ，traceId和MDC中的键名称一致 简单使用就这么容易，但是在有些情况下traceId将获取不到 子线程中打印日志丢失traceId HTTP调用丢失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对任务进行一次包装 线程池封装类：ThreadPoolExecutorMdcWrapper.java 继承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就是一样的了 线程traceId封装工具类：ThreadMdcUtil.java 说明【以封装Runnable为例】： 判断当前线程对应MDC的Map是否存在，存在则设置 设置MDC中的traceId值，不存在则新生成，针对不是子线程的情况，如果是子线程，MDC中traceId不为null 重新返回的是包装后的Runnable，在该任务执行之前【runnable.run()】先将主线程的Map设置到当前线程中【 即MDC.setContextMap(context)】，这样子线程和主线程MDC对应的Map就是一样的了 在使用HTTP调用第三方服务接口时traceId将丢失，需要对HTTP调用工具进行改造，在发送时在request header中添加traceId，在下层被调用方添加拦截器获取header中的traceId添加到MDC中 HTTP调用有多种方式，比较常见的有HttpClient、OKHttp、RestTemplate，所以只给出这几种HTTP调用的解决方式 实现HttpClient拦截器 ​ 实现HttpRequestInterceptor接口并重写process方法 ​ 如果调用线程中含有traceId，则需要将获取到的traceId通过request中的header向下透传下去 为HttpClient添加拦截器 private static CloseableHttpClient httpClient = HttpClientBuilder.create() .addInterceptorFirst(new HttpClientTraceIdInterceptor()) .build(); 通过addInterceptorFirst方法为HttpClient添加拦截器 为HttpClient添加拦截器 通过addInterceptorFirst方法为HttpClient添加拦截器 实现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则向下透传 实现Interceptor拦截器，重写interceptor方法，实现逻辑和HttpClient差不多，如果能够获取到当前线程的traceId则向下透传 为OkHttp添加拦截器 private static OkHttpClient client = new OkHttpClient.Builder() .addNetworkInterceptor(new OkHttpTraceIdInterceptor()) .build(); 调用addNetworkInterceptor方法添加拦截器 调用addNetworkInterceptor方法添加拦截器 实现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拦截器 实现ClientHttpRequestInterceptor接口，并重写intercept方法，其余逻辑都是一样的不重复说明 为RestTemplate添加拦截器 restTemplate.setInterceptors(Arrays.asList(new RestTemplateTraceIdInterceptor())); 调用setInterceptors方法添加拦截器 为RestTemplate添加拦截器

调用setInterceptors方法添加拦截器 HTTP调用第三方服务接口全流程traceId需要第三方服务配合，第三方服务需要添加拦截器拿到request header中的traceId并添加到MDC中 先从request header中获取traceId 从request header中获取不到traceId则说明不是第三方调用，直接生成一个新的traceId 将生成的traceId存入MDC中 除了需要添加拦截器之外，还需要在日志格式中添加traceId的打印，如下： 需要添加 %X{traceId} 最后附： 项目代码 ，欢迎 fork 与 star ，涨点小星星，卑微乞讨 1.写个日志请求切面，前后端甩锅更方便 2.为什么阿里巴巴要禁用Executors创建线程池？ 参考文章： 1.在Java项目中使用traceId跟踪请求全流程日志 2.MDC介绍 -- 一种多线程下日志管理实践方式 日志排查问题困难？分布式日志链路跟踪来帮你 作者：朱乐陶，软件架构师，具备多年Java开发及架构设计经验，擅长微服务领域 作者博客：https://blog.... 没想好像 阅读 821 评论 0 赞 7 2018-06-13 第三十八天 一、wait--notify--sleep Object obj = new Object(); obj.wait... fe0180bd6eaf 阅读 430 评论 0 赞 1 多线程之线程池-各个参数的含义- 阿里，美团，京东面试题目 阿里的面试官问了个问题，如果corepollSize=10,MaxPollSize=20,如果来了25个线程 怎么... Java面试指南 阅读 1,279 评论 0 赞 1 【死磕Java并发】-----J.U.C之线程池：ThreadPoolExecutor 原文出处http://cmsblogs.com/ 『chenssy』 作为Executor框架中最核心的类，Thr... 踩在浪花上看浪 阅读 1,352 评论 0 赞 4 《好好生活》 《好好生活》 令你痛苦的 不是生活 是生存 读万卷书不如行千里路 ... 牧羊人c艾诺 阅读 654 评论 0 赞 0 你知道煮鸡蛋时加盐能让蛋壳更好剥吗？ 真我香水多少钱？价格与性价比全解析 家常兔肉的做法有哪些？简单易学的兔肉菜谱分享 93年毛泽东邮票为何成为收藏界的热门珍品？ 鸡蛋干面条怎么做才好吃又简单？ 3D蚕丝面膜真的比普通面膜更好用吗？ 家常皮冻的做法大全，怎样做才能Q弹爽口？ 核桃蛋糕怎么做才能松软又美味？ 化妆品到底是什么？揭秘它的真实定义与作用！ 香椿炒鸡蛋怎么做？简单几步教你轻松搞定！ 奥斯卡护肤品集团的明星产品真的值得入手吗？ 毛豆烧带鱼有哪些简单又美味的烹饪窍门？ 专柜化妆品的价格到底值不值得买？ 辽金玛瑙珠子应该如何正确盘玩与保养？ 柑橘保湿面膜真的能让肌肤水润透亮吗？ 如何在家做出美味的小鸡炖蘑菇土豆粉皮？ 如何判断玛瑙的品质与合理价位？ 全集《图书馆的女朋友》高清完整版免费在线观看_樱花动漫_《图书馆的女朋友》全集无删减原版_动漫全集_免费在线点播 - 风车动漫网_《图书馆的女朋友》全集高清在线播放_VS 影院 欲牛影评：这部电影为何成为年度黑马？ 戈壁闪光玛瑙究竟有哪些不为人知的收藏价值？ 闪婚题材电影真的能反映现实爱情吗？ 前导精华真的好用吗？实测分享你的护肤第一步！ 莎绿化妆品真的好用吗？真实测评告诉你答案！ 瘦脸精华真的有效吗？揭秘紧致轮廓的秘诀！ 民国时期的玛瑙饰品现在值钱吗？ 玛瑙圆佛头的市场价格是多少？如何鉴别其收藏价值？ 家常科技：如何用智能厨具轻松做出美味大餐？ 最新5号香水究竟有什么特别之处？