作者：Wudashan
连结：http://wudashan.com/2018/02/15/Log-Request-In-MutiThread/
示例源代码地址：https://github.com/wudashan/slf4j-mdc-muti-thread
前言
在现网出现故障时，我们经常需要获取一次请求流程里的所有日志进行定位。如果请求只在一个执行绪里处理，则我们可以通过执行绪ID来过滤日志，但如果请求包含异步执行绪的处理，那么光靠执行绪ID就显得捉襟见肘了。
华为IoT平台，提供了接收装置上报资料的能力， 当资料到达平台后，平台会进行一些复杂的业务逻辑处理，如资料储存，规则引擎，资料推送，命令下发等等。由于这个逻辑之间没有强耦合的关系，所以通常是异步处理。如何将一次资料上报请求中包含的所有业务日志快速过滤出来，就是本文要介绍的。
正文
SLF4J日志框架提供了一个MDC(Mapped Diagnostic Contexts)工具类，Google翻译为对映的诊断上下文，从字面上很难理解，我们可以先实战一把。
我们在main函式的入口呼叫MDC.put()方法传入请求ID，在出口呼叫MDC.remove()方法移除请求ID。配置好log4j2.xml档案后，执行main函式，可以在控制台看到以下日志输出：
从日志中可以明显地看到花括号中包含了（对映的）请求ID(requestId)，这其实就是我们定位（诊断）问题的关键字（上下文）。有了MDC工具，只要在界面或切面植入put()和remove()程式码，在现网定位问题时，我们就可以通过grep requestId=xxx *.log快速的过滤出某次请求的所有日志。
进阶
然而，MDC工具真的有我们所想的这么方便吗？回到我们开头，一次请求可能涉及多执行绪异步处理，那么在多执行绪异步的场景下，它是否还能正常运作呢？Talk is cheap, show me the code。
程式码里我们新起了一个异步执行绪，并在匿名物件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值拷贝到异步执行绪中去。程式码实现如下：
接着，我们需要对main函式里建立的Runnable实现类进行装饰：
执行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工具，在开发自测阶段，可以极大地节省定位问题的时间，提升开发效率；在运维维护阶段，可以快速地收集相关日志资讯，加快分析速度。
