traceId 跨线程使用

目录

• 1. 为什么需要这个traceId
• 2.通过MDC设置traceId
  • 2.1 使用filter过滤器设置traceId
  • 2.2 使用JWT token过滤器的项目
  • 2.3 使用Interceptor拦截器设置traceId
• 3.logback.xml中配置traceId
• 4.补充异步方法带入上下文的traceId
• 5.在接口放回中，增加traceId返回

先看一张图：

有同学问：日志中[]中类似uuid的这个traceId是怎么实现的，这边文章就介绍下如何在springboot工程下用MDC实现日志文件中打印traceId。

1. 为什么需要这个traceId

我们在定位问题的时候需要去日志中查找对应的位置，当我们一个接口的请求同用唯一的一个traceId，那我们只需要知道这个traceId，使用 grep ‘traceId' xxx.log 语句就能准确的定位到目标日志。在这边文章会介绍如何去设置这个traceId，而后如何在接口返回这个traceId。

1 2 3 4 5 6 7 8

#接口返回： {     "code": "0",     "dealStatus": "1",     "TRACE_ID": "a10e6e8d-9953-4de9-b145-32eee6aa5562" } #查询日志  grep 'a10e6e8d-9953-4de9-b145-32eee6aa5562' xxxx.log

2.通过MDC设置traceId

笔者目前遇到的项目，可以有三种情况去设置traceId。先简单的介绍MDC

1 2 3 4 5 6 7 8

#MDC定义 Mapped Diagnostic Context，即：映射诊断环境。 MDC是 log4j 和 logback 提供的一种方便在多线程条件下记录日志的功能。 MDC 可以看成是一个与当前线程绑定的哈希表，可以往其中添加键值对。 #MDC的使用方法 向MDC中设置值：MDC.put(key, value); 从MDC中取值：MDC.get(key); 将MDC中内容打印到日志中：%X{key}

2.1 使用filter过滤器设置traceId

新建一个过滤器，实现Filter，重写init，doFilter，destroy方法，设置traceId放在doFilter中，在destroy中调用MDC.clear()方法。

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25

@Slf4j @WebFilter(filterName = "traceIdFilter",urlPatterns = "/*") public class traceIdFilter implements Filter {     /**      * 日志跟踪标识      */     private static final String TRACE_ID = "TRACE_ID";           @Override     public void init(FilterConfig filterConfig) throws ServletException {     }     @Override     public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain)             throws IOException, ServletException {         MDC.put(TRACE_ID, UUID.randomUUID().toString());         filterChain.doFilter(request, servletResponse);     }     @Override     public void destroy() {         MDC.clear();     } }

2.2 使用JWT token过滤器的项目

springboot项目经常使用spring security+jwt来做权限限制，在这种情况下，我们通过新建filter过滤器来设置traceId，那么在验证token这部分的日志就不会带上traceId，因此我们需要把代码放在jwtFilter中，如图：

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34

/**  * token过滤器 验证token有效性  *  * @author china  */ @Component public class JwtAuthenticationTokenFilter extends OncePerRequestFilter {     @Autowired     private TokenService tokenService;     /**      * 日志跟踪标识      */     private static final String TRACE_ID = "TRACE_ID";     @Override     protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain chain)             throws ServletException, IOException {         MDC.put(TRACE_ID, UUID.randomUUID().toString());         LoginUser loginUser = tokenService.getLoginUser(request);         if (StringUtils.isNotNull(loginUser) && StringUtils.isNull(SecurityUtils.getAuthentication())) {             tokenService.verifyToken(loginUser);             UsernamePasswordAuthenticationToken authenticationToken = new UsernamePasswordAuthenticationToken(loginUser, null, loginUser.getAuthorities());             authenticationToken.setDetails(new WebAuthenticationDetailsSource().buildDetails(request));             SecurityContextHolder.getContext().setAuthentication(authenticationToken);         }         chain.doFilter(request, response);     }           @Override     public void destroy() {         MDC.clear();     } }

2.3 使用Interceptor拦截器设置traceId

定义一个拦截器，重写preHandle方法，在方法中通过MDC设置traceId

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20

/**  * MDC设置traceId拦截器  *  * @author china  */ @Component public abstract class TraceIdInterceptor extends HandlerInterceptorAdapter {     private static final String UNIQUE_ID = "TRACE_ID";     @Override     public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) {         MDC.put(UNIQUE_ID, UUID.randomUUID().toString());         return true;     }     @Override     public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, @Nullable Exception ex) throws Exception {         MDC.clear();     } }

3.logback.xml中配置traceId

与之前的相比只是添加了[%X{TRACE_ID}]， [%X{***}]是一个模板，中间属性名是我们使用MDC put进去的。

1 2 3 4

#之前 <property name="log.pattern" value="%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{20} - [%method,%line] - %msg%n" /> #增加traceId后 <property name="log.pattern" value="%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{20} - [%method,%line] - [%X{TRACE_ID}] - %msg%n" />

4.补充异步方法带入上下文的traceId

异步方法会开启一个新线程，我们想要是异步方法和主线程共用同一个traceId，首先先新建一个任务适配器MdcTaskDecorator，如图：

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19

public class MdcTaskDecorator implements TaskDecorator     /**      * 使异步线程池获得主线程的上下文      * @param runnable      * @return      */     @Override     public Runnable decorate(Runnable runnable) {         Map<String,String> map = MDC.getCopyOfContextMap();         return () -> {             try{                 MDC.setContextMap(map);                 runnable.run();             } finally {                 MDC.clear();             }         };     } }

然后，在线程池配置中增加executor.setTaskDecorator(new MdcTaskDecorator())的设置

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26

/**  * 线程池配置  *  * @author china  **/ @EnableAsync @Configuration public class ThreadPoolConfig {     private int corePoolSize = 50;     private int maxPoolSize = 200;     private int queueCapacity = 1000;     private int keepAliveSeconds = 300;     @Bean(name = "threadPoolTaskExecutor")     public ThreadPoolTaskExecutor threadPoolTaskExecutor() {         ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();         executor.setMaxPoolSize(maxPoolSize);         executor.setCorePoolSize(corePoolSize);         executor.setQueueCapacity(queueCapacity);         executor.setKeepAliveSeconds(keepAliveSeconds);         executor.setTaskDecorator(new MdcTaskDecorator());         // 线程池对拒绝任务(无线程可用)的处理策略         executor.setRejectedExecutionHandler(new ThreadPoolExecutor.CallerRunsPolicy());         return executor;     } }

最后，在业务代码上使用@Async开启异步方法即可

1 2	@Async("threadPoolTaskExecutor") void testSyncMethod();

5.在接口放回中，增加traceId返回

在笔者项目中，接口返回都使用了一个叫AjaxResult自定义类来包装，所以只需要把这个类的构造器中增加traceId返回即可，相对简单。

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39

/**   * 日志跟踪标识   */  private static final String TRACE_ID = "TRACE_ID";     /**   * 初始化一个新创建的 AjaxResult 对象，使其表示一个空消息。   */  public AjaxResult() {      super.put(TRACE_ID, MDC.get(TRACE_ID));  }  /**   * 初始化一个新创建的 AjaxResult 对象   *   * @param code 状态码   * @param msg  返回内容   */  public AjaxResult(int code, String msg) {      super.put(CODE_TAG, code);      super.put(MSG_TAG, msg);      super.put(TRACE_ID, MDC.get(TRACE_ID));  }  /**   * 初始化一个新创建的 AjaxResult 对象   *   * @param code 状态码   * @param msg  返回内容   * @param data 数据对象   */  public AjaxResult(int code, String msg, Object data) {      super.put(CODE_TAG, code);      super.put(MSG_TAG, msg);      super.put(TRACE_ID, MDC.get(TRACE_ID));      if (StringUtils.isNotNull(data)) {          super.put(DATA_TAG, data);      }  }

转自：https://www.jb51.net/article/225488.htm