如何快速過濾出一次請求的所有日志？

01、前言

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

華為IoT平台，提供了接收裝置上報資料的能力， 當資料到達平台後，平台會進行一些複雜的業務邏輯處理，如資料存儲，規則引擎，資料推送，指令下發等等。由于這個邏輯之間沒有強耦合的關系，是以通常是異步處理。如何将一次資料上報請求中包含的所有業務日志快速過濾出來，就是本文要介紹的。

02、正文

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函數，可以在控制台看到以下日志輸出：

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());

        // 主線程列印<font style="color: #1e6bb8;word-wrap: break-word;font-weight: bold;border-bottom: 1px solid">日志</font>
        logger.debug("log in main thread");

        // 異步線程列印<font style="color: #1e6bb8;word-wrap: break-word;font-weight: bold;border-bottom: 1px solid">日志</font>
        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

1

不幸的是，請求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());

        // 主線程列印<font style="color: #1e6bb8;word-wrap: break-word;font-weight: bold;border-bottom: 1px solid">日志</font>
        logger.debug("log in main thread");

        // 異步線程列印<font style="color: #1e6bb8;word-wrap: break-word;font-weight: bold;border-bottom: 1px solid">日志</font>，用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列印了！

04、總結

本文講述了如何使用MDC工具來快速過濾一次請求的所有日志，并通過裝飾器模式使得MDC工具在異步線程裡也能生效。有了MDC，再通過AOP技術對所有的切面植入requestId，就可以将整個系統的任意流程的日志過濾出來。

使用MDC工具，在開發自測階段，可以極大地節省定位問題的時間，提升開發效率；在運維維護階段，可以快速地收集相關日志資訊，加快分析速度。