写在前面
通过本文将了解到什么是MDC、MDC应用中存在的问题、如何解决存在的问题
MDC介绍
简介:
MDC(Mapped Diagnostic Context,映射调试上下文)是 log4j 、logback及log4j2 提供的一种方便在多线程条件下记录日志的功能。MDC 可以看成是一个与当前线程绑定的哈希表,可以往其中添加键值对。MDC 中包含的内容可以被同一线程中执行的代码所访问。
当前线程的子线程会继承其父线程中的 MDC 的内容。当需要记录日志时,只需要从 MDC 中获取所需的信息即可。MDC 的内容则由程序在适当的时候保存进去。对于一个 Web 应用来说,通常是在请求被处理的最开始保存这些数据
API说明:
-
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)
暂时只能想到这一点
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 = 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将获取不到
图片
MDC 存在的问题
-
子线程中打印日志丢失traceId
-
HTTP调用丢失traceId
......丢失traceId的情况,来一个再解决一个,绝不提前优化
解决MDC存在的问题
子线程日志打印丢失traceId
子线程在打印日志的过程中traceId将丢失,解决方式为重写