示例源碼地址：github.com/wudashan/slf

前言

在現網出現故障時，我們經常需要獲取一次請求流程裏的所有日誌進行定位。如果請求只在一個線程裏處理，則我們可以通過線程ID來過濾日誌，但如果請求包含非同步線程的處理，那麼光靠線程ID就顯得捉襟見肘了。

華為IoT平臺，提供了接收設備上報數據的能力， 當數據到達平臺後，平臺會進行一些複雜的業務邏輯處理，如數據存儲，規則引擎，數據推送，命令下發等等。由於這個邏輯之間沒有強耦合的關係，所以通常是非同步處理。如何將一次數據上報請求中包含的所有業務日誌快速過濾出來，就是本文要介紹的。

正文

SLF4J日誌框架提供了一個MDC(Mapped Diagnostic Contexts)工具類，谷歌翻譯為映射的診斷上下文，從字面上很難理解，我們可以先實戰一把。

public class Main {

private static final String KEY = "requestId";
private static final Logger logger = LoggerFactory.getLogger(Main.class);

public static void main(String[] args) {

// 入口傳入請求ID
 MDC.put(KEY, UUID.randomUUID().toString());

// 列印日誌
 logger.debug("log in main thread 1");
logger.debug("log in main thread 2");
logger.debug("log in main thread 3");

// 出口移除請求ID
 MDC.remove(KEY);

}

}

我們在main函數的入口調用MDC.put()方法傳入請求ID，在出口調用MDC.remove()方法移除請求ID。配置好log4j2.xml文件後，運行main函數，可以在控制檯看到以下日誌輸出：

2018-02-17 13:19:52.606 {requestId=f97ea0fb-2a43-40f4-a3e8-711f776857d0} [main] DEBUG cn.wudashan.Main - log in main thread 1
2018-02-17 13:19:52.609 {requestId=f97ea0fb-2a43-40f4-a3e8-711f776857d0} [main] DEBUG cn.wudashan.Main - log in main thread 2
2018-02-17 13:19:52.609 {requestId=f97ea0fb-2a43-40f4-a3e8-711f776857d0} [main] DEBUG cn.wudashan.Main - log in main thread 3

從日誌中可以明顯地看到花括弧中包含了（映射的）請求ID(requestId)，這其實就是我們定位（診斷）問題的關鍵字（上下文）。有了MDC工具，只要在介面或切面植入put()和remove()代碼，在現網定位問題時，我們就可以通過grep requestId=xxx *.log快速的過濾出某次請求的所有日誌。

進階

然而，MDC工具真的有我們所想的這麼方便嗎？回到我們開頭，一次請求可能涉及多線程非同步處理，那麼在多線程非同步的場景下，它是否還能正常運作呢？Talk is cheap, show me the code。

public class Main {

private static final String KEY = "requestId";
private static final Logger logger = LoggerFactory.getLogger(Main.class);

public static void main(String[] args) {

// 入口傳入請求ID
 MDC.put(KEY, UUID.randomUUID().toString());

// 主線程列印日誌
 logger.debug("log in main thread");

// 非同步線程列印日誌
 new Thread(new Runnable() {
@Override
public void run() {
logger.debug("log in other thread");
}
}).start();

// 出口移除請求ID
 MDC.remove(KEY);

}

}

代碼裏我們新起了一個非同步線程，並在匿名對象Runnable的run()方法列印日誌。運行main函數，可以在控制檯看到以下日誌輸出：

2018-02-17 14:05:43.487 {requestId=e6099c85-72be-4986-8a28-de6bb2e52b01} [main] DEBUG cn.wudashan.Main - log in main thread
2018-02-17 14:05:43.490 {} [Thread-1] DEBUG cn.wudashan.Main - log in other thread

不幸的是，請求ID在非同步線程裏不列印了。這是怎麼回事呢？要解決這個問題，我們就得知道MDC的實現原理。由於篇幅有限，這裡就暫不詳細介紹，MDC之所以在非同步線程中不生效是因為底層採用ThreadLocal作為數據結構，我們調用MDC.put()方法傳入的請求ID只在當前線程有效。感興趣的小夥伴可以自己深入一下代碼細節。

知道了原理那麼解決這個問題就輕而易舉了，我們可以使用裝飾器模式，新寫一個MDCRunnable類對Runnable介面進行一層裝飾。在創建MDCRunnable類時保存當前線程的MDC值，在執行run()方法時再將保存的MDC值拷貝到非同步線程中去。代碼實現如下：

public class MDCRunnable implements Runnable {

private final Runnable runnable;

private final Map<String, String> map;

public MDCRunnable(Runnable runnable) {
this.runnable = runnable;
// 保存當前線程的MDC值
 this.map = MDC.getCopyOfContextMap();
}

@Override
public void run() {
// 傳入已保存的MDC值
 for (Map.Entry<String, String> entry : map.entrySet()) {
MDC.put(entry.getKey(), entry.getValue());
}
// 裝飾器模式，執行run方法
 runnable.run();
// 移除已保存的MDC值
 for (Map.Entry<String, String> entry : map.entrySet()) {
MDC.remove(entry.getKey());
}
}

}

接著，我們需要對main函數裏創建的Runnable實現類進行裝飾：

public class Main {

private static final String KEY = "requestId";
private static final Logger logger = LoggerFactory.getLogger(Main.class);
private static final ExecutorService EXECUTOR = Executors.newSingleThreadExecutor();

public static void main(String[] args) {

// 入口傳入請求ID
 MDC.put(KEY, UUID.randomUUID().toString());

// 主線程列印日誌
 logger.debug("log in main thread");

// 非同步線程列印日誌，用MDCRunnable裝飾Runnable
 new Thread(new MDCRunnable(new Runnable() {
@Override
public void run() {
logger.debug("log in other thread");
}
})).start();

// 非同步線程池列印日誌，用MDCRunnable裝飾Runnable
 EXECUTOR.execute(new MDCRunnable(new Runnable() {
@Override
public void run() {
logger.debug("log in other thread pool");
}
}));
EXECUTOR.shutdown();

// 出口移除請求ID
 MDC.remove(KEY);

}

}

執行main函數，將會輸出以下日誌：

2018-03-04 23:44:05.343 {requestId=5ee2a117-e090-41d8-977b-cef5dea09d34} [main] DEBUG cn.wudashan.Main - log in main thread
2018-03-04 23:44:05.346 {requestId=5ee2a117-e090-41d8-977b-cef5dea09d34} [Thread-1] DEBUG cn.wudashan.Main - log in other thread
2018-03-04 23:44:05.347 {requestId=5ee2a117-e090-41d8-977b-cef5dea09d34} [pool-2-thread-1] DEBUG cn.wudashan.Main - log in other thread pool

Congratulations！經過我們的努力，最終在非同步線程和線程池中都有requestId列印了！

總結

本文講述瞭如何使用MDC工具來快速過濾一次請求的所有日誌，並通過裝飾器模式使得MDC工具在非同步線程裏也能生效。有了MDC，再通過AOP技術對所有的切面植入requestId，就可以將整個系統的任意流程的日誌過濾出來。使用MDC工具，在開發自測階段，可以極大地節省定位問題的時間，提升開發效率；在運維維護階段，可以快速地收集相關日誌信息，加快分析速度。

推薦閱讀(點擊文字可跳轉）

1. 深究Spring中Bean的生命週期

2. 深入SpringBoot核心註解原理

3.線上環境部署概覽

4.Springboot Vue shiro 實現前後端分離、許可權控制

作者：Wudashan

鏈接：uee.me/aVJhw

推薦閱讀：
相關文章