关于java:如何快速过滤出一次请求的所有日志

起源：wudashan.com/2018/02/15/Log-Request-In-MutiThread

在现网呈现故障时，咱们常常须要获取一次申请流程里的所有日志进行定位。如果申请只在一个线程里解决，则咱们能够通过线程 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());

        // 主线程打印 <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

可怜的是，申请 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 打印了！

本文讲述了如何应用 MDC 工具来疾速过滤一次申请的所有日志，并通过装璜器模式使得 MDC 工具在异步线程里也能失效。有了 MDC，再通过 AOP 技术对所有的切面植入 requestId，就能够将整个零碎的任意流程的日志过滤出来。

应用 MDC 工具，在开发自测阶段，能够极大地节俭定位问题的工夫，晋升开发效率；在运维维护阶段，能够疾速地收集相干日志信息，放慢剖析速度。

近期热文举荐：

1.1,000+ 道 Java 面试题及答案整顿(2021 最新版)

2. 别在再满屏的 if/ else 了，试试策略模式，真香！！

3. 卧槽！Java 中的 xx ≠ null 是什么新语法？

4.Spring Boot 2.6 正式公布，一大波新个性。。

5.《Java 开发手册（嵩山版）》最新公布，速速下载！

感觉不错，别忘了顺手点赞 + 转发哦！

关于java:如何快速过滤出一次请求的所有日志

01、前言

02、注释

03、进阶

04、总结