Springboot+MDC+traceId日志中打印唯一traceId
更新時間：2021年10月17日 11:25:07 作者：W3C_0101
本文主要介紹了Springboot+MDC+traceId日志中打印唯一traceId，文中通過示例代碼介紹的非常詳細，具有一定的參考價值，感興趣的小伙伴們可以參考一下
先看一張圖：
有同學問：日志中[]中類似uuid的這個traceId是怎么實現(xiàn)的，這邊文章就介紹下如何在springboot工程下用MDC實現(xiàn)日志文件中打印traceId。
1. 為什么需要這個traceId
我們在定位問題的時候需要去日志中查找對應的位置，當我們一個接口的請求同用唯一的一個traceId，那我們只需要知道這個traceId，使用 grep ‘traceId' xxx.log 語句就能準確的定位到目標日志。在這邊文章會介紹如何去設置這個traceId，而后如何在接口返回這個traceId。
#接口返回：
{
"code": "0",
"dealStatus": "1",
"TRACE_ID": "a10e6e8d-9953-4de9-b145-32eee6aa5562"
}
#查詢?nèi)罩?
grep 'a10e6e8d-9953-4de9-b145-32eee6aa5562' xxxx.log
2.通過MDC設置traceId
筆者目前遇到的項目，可以有三種情況去設置traceId。先簡單的介紹MDC
#MDC定義
Mapped Diagnostic Context，即：映射診斷環(huán)境。
MDC是 log4j 和 logback 提供的一種方便在多線程條件下記錄日志的功能。
MDC 可以看成是一個與當前線程綁定的哈希表，可以往其中添加鍵值對。
#MDC的使用方法
向MDC中設置值：MDC.put(key, value);
從MDC中取值：MDC.get(key);
將MDC中內(nèi)容打印到日志中：%X{key}
2.1 使用filter過濾器設置traceId
新建一個過濾器，實現(xiàn)Filter，重寫init，doFilter，destroy方法，設置traceId放在doFilter中，在destroy中調(diào)用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項目經(jīng)常使用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;
}
}
最后，在業(yè)務代碼上使用@Async開啟異步方法即可
@Async("threadPoolTaskExecutor")
void testSyncMethod();
5.在接口放回中，增加traceId返回
在筆者項目中，接口返回都使用了一個叫AjaxResult自定義類來包裝，所以只需要把這個類的構造器中增加traceId返回即可，相對簡單。
/**
* 日志跟蹤標識
*/
private static final String TRACE_ID = "TRACE_ID";
/**
* 初始化一個新創(chuàng)建的 AjaxResult 對象，使其表示一個空消息。
*/
public AjaxResult() {
super.put(TRACE_ID, MDC.get(TRACE_ID));
}
/**
* 初始化一個新創(chuàng)建的 AjaxResult 對象
*
* @param code 狀態(tài)碼
* @param msg 返回內(nèi)容
*/
public AjaxResult(int code, String msg) {
super.put(CODE_TAG, code);
super.put(MSG_TAG, msg);
super.put(TRACE_ID, MDC.get(TRACE_ID));
}
/**
* 初始化一個新創(chuàng)建的 AjaxResult 對象
*
* @param code 狀態(tài)碼
* @param msg 返回內(nèi)容
* @param data 數(shù)據(jù)對象
*/
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的詳細內(nèi)容，更多關于Springboot 打印唯一traceId的資料請關注腳本之家其它相關文章！
相關文章
SpringBoot Actuator監(jiān)控的項目實踐
本文主要結合 Spring Boot Actuator,跟大家一起分享微服務Spring Boot Actuator 的常見用法,方便我們在日常中對我們的微服務進行監(jiān)控治理,感興趣的可以了解一下2024-01-01
Java實現(xiàn)通過IP獲取IP歸屬地的方法(離線+在線)
我們都知道安全攻擊都是在某臺客戶機上執(zhí)行某些惡意操作致使服務端響應異常崩潰亦或響應數(shù)據(jù)被篡改,首先我想到的是對訪問的web端做一個IP的校驗,那么我們首先得知道客戶端的IP是多少,接下來此文重點介紹如何獲得,需要的朋友可以參考下2023-10-10
這篇文章主要介紹了Java中常見死鎖與活鎖的實例詳解，小編覺得挺不錯的，現(xiàn)在分享給大家，也給大家做個參考。一起跟隨小編過來看看吧2018-11-11
本文將詳細介紹redisson實現(xiàn)分布式鎖原理。具有很好的參考價值，下面跟著小編一起來看下吧2017-02-02
feignclient?https?接口調(diào)用報證書錯誤的解決方案
這篇文章主要介紹了feignclient?https?接口調(diào)用報證書錯誤的解決方案，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2022-03-03
在Java中,原子操作尤為重要,尤其是在多線程環(huán)境中,想象一下,如果小黑在操作一個共享變量時,這個操作被其他線程打斷,那會發(fā)生什么？可能會導致數(shù)據(jù)不一致,或者更糟糕的情況,本文將給大家詳細介紹一下Java中的原子操作2024-01-01
這篇文章主要介紹了java中的IO流的相關資料,需要的朋友可以參考下文2021-08-08
Windows安裝兩個或多個JDK并實現(xiàn)自由切換的方法
最近新接手一個項目,啟動的時候,發(fā)現(xiàn)有些jar和現(xiàn)在正在使用的JDK版本不一致,一直啟動有問題,想著就多裝一個JDK,由于為了保證java的運行環(huán)境和編譯環(huán)境保持一致,就需要我們設置jdk的環(huán)境變量,所以本文給大家介紹了Windows安裝兩個或多個JDK并實現(xiàn)自由切換的方法2025-03-03
本文主要介紹了mybatis中#{}和${}的區(qū)別詳解，文中通過示例代碼介紹的非常詳細，具有一定的參考價值，感興趣的小伙伴們可以參考一下2022-01-01
微信公眾號支付（二）實現(xiàn)統(tǒng)一下單接口
本篇文章主要給大家介紹調(diào)用微信公眾支付的統(tǒng)一下單API，通過參數(shù)封裝為xml格式并發(fā)送到微信給的接口地址就可以獲得返回內(nèi)容，需要的朋友可以參考下本文2015-09-09