Springboot+MDC+traceId⽇志中打印唯⼀traceId
⽬录
1. 为什么需要这个traceId
2.通过MDC设置traceId
2.1 使⽤filter过滤器设置traceId
2.2 使⽤JWT token过滤器的项⽬
2.3 使⽤Interceptor设置traceId
l中配置traceId
4.补充异步⽅法带⼊上下⽂的traceId
5.在接⼝放回中，增加traceId返回
先看⼀张图：
有同学问：⽇志中[]中类似uuid的这个traceId是怎么实现的，这边⽂章就介绍下如何在springboot⼯程下⽤MDC实现⽇志⽂件中打印traceId。
1. 为什么需要这个traceId
我们在定位问题的时候需要去⽇志中查对应的位置，当我们⼀个接⼝的请求同⽤唯⼀的⼀个traceId，那我们只需要知道这个traceId，使⽤grep ‘traceId' xxx.log 语句就能准确的定位到⽬标⽇志。在这边⽂章会介绍如何去设置这个traceId，⽽后如何在接⼝返回这个traceId。
#接⼝返回：
{
"code": "0",
"dealStatus": "1",
"TRACE_ID": "a10e6e8d-9953-4de9-b145-32eee6aa5562"
}
#查询⽇志
grep 'a10e6e8d-9953-4de9-b145-32eee6aa5562' xxxx.log
2.通过MDC设置traceId
笔者⽬前遇到的项⽬，可以有三种情况去设置traceId。先简单的介绍MDC
#MDC定义
Mapped Diagnostic Context，即：映射诊断环境。
MDC是 log4j 和 logback 提供的⼀种⽅便在多线程条件下记录⽇志的功能。
MDC 可以看成是⼀个与当前线程绑定的哈希表，可以往其中添加键值对。
#MDC的使⽤⽅法
向MDC中设置值：MDC.put(key, value);
从MDC中取值：(key);
将MDC中内容打印到⽇志中：%X{key}
2.1 使⽤filter过滤器设置traceId
新建⼀个过滤器，实现Filter，重写init，doFilter，destroy⽅法，设置traceId放在doFilter中，在destroy中调⽤MDC.clear()⽅法。
@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中，如图：
/**
* 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 = LoginUser(request);
if (StringUtils.isNotNull(loginUser) && StringUtils.Authentication())) {
tokenService.verifyToken(loginUser);
UsernamePasswordAuthenticationToken authenticationToken = new UsernamePasswordAuthenticationToken(loginUser, null, Authorities());
authenticationToken.setDetails(new WebAuthenticationDetailsSource().buildDetails(request));
}
chain.doFilter(request, response);
}
@Override
public void destroy() {
MDC.clear();
}
}
2.3 使⽤Interceptor设置traceId
定义⼀个，重写preHandle⽅法，在⽅法中通过MDC设置traceId
/**
* 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();
}
}
l中配置traceId
与之前的相⽐只是添加了[%X{TRACE_ID}]， [%X{***}]是⼀个模板，中间属性名是我们使⽤MDC put进去的。
#之前
<property name="log.pattern" value="%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{20} - [%method,%line] - %msg%n" />log4j2过滤日志
#增加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，如图：public class MdcTaskDecorator implements TaskDecorator
/**
* 使异步线程池获得主线程的上下⽂
* @param runnable
* @return
*/
@Override
public Runnable decorate(Runnable runnable) {
Map<String,String> map = CopyOfContextMap();
return () -> {
try{
MDC.setContextMap(map);
runnable.run();
} finally {
MDC.clear();
}
};
}
}
然后，在线程池配置中增加executor.setTaskDecorator(new MdcTaskDecorator())的设置
/**
* 线程池配置
*
* @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开启异步⽅法即可
@Async("threadPoolTaskExecutor")
void testSyncMethod();
5.在接⼝放回中，增加traceId返回
在笔者项⽬中，接⼝返回都使⽤了⼀个叫AjaxResult⾃定义类来包装，所以只需要把这个类的构造器中增加traceId返回即可，相对简单。 /**
* ⽇志跟踪标识
*/
private static final String TRACE_ID = "TRACE_ID";
/**
* 初始化⼀个新创建的 AjaxResult 对象，使其表⽰⼀个空消息。
*/
public AjaxResult() {
super.put(TRACE_ID, (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, (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, (TRACE_ID));
if (StringUtils.isNotNull(data)) {
super.put(DATA_TAG, data);
}
}
以上就是Springboot+MDC+traceId⽇志中打印唯⼀traceId的详细内容，更多关于Springboot 打印唯⼀traceId的资料请关注其它相关⽂章！
版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。
发表评论