Springboot+MDC+traceId日志中打印唯一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中取值：MDC.get(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 = 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
/**
* 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進去的。
#之前
<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，如圖：
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())的設置
/**
* 線程池配置
*
* @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, 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);
}
}
以上就是Springboot+MDC+traceId日志中打印唯一traceId的詳細內容，更多關於Springboot 打印唯一traceId的資料請關註WalkonNet其它相關文章！
推薦閱讀：
- 全局請求添加TraceId輕松看日志
- java多線程使用mdc追蹤日志方式
- Java中使用Filter過濾器的方法
- Sleuth+logback 設置traceid 及自定義信息方式
- SpringBoot 異步線程間傳遞上下文方式