Java SLF4J

1、前言

在现网出现故障时，经常需要获取一次请求流程里的所有日志进行定位。如果请求只在一个线程里处理，则可以通过线程ID来过滤日志，但如果请求包含异步线程的处理，那么光靠线程ID就显得捉襟见肘了。

2、正文

SLF4J日志框架提供了一个MDC(Mapped Diagnostic Contexts)工具类，谷歌翻译为映射的诊断上下文 ，从字面上很难理解，可以先实战一把。

  1. public class Main {
  3.     private static final String KEY = "requestId";
  4.     private static final Logger logger = LoggerFactory.getLogger(Main.class);
  6.     public static void main(String[] args) {
  8.         // 入口传入请求ID
  9.         MDC.put(KEY, UUID.randomUUID().toString());
  11.         // 打印日志
  12.         logger.debug("log in main thread 1");
  13.         logger.debug("log in main thread 2");
  14.         logger.debug("log in main thread 3");
  16.         // 出口移除请求ID
  17.         MDC.remove(KEY);
  19.     }
  21. }

在main函数的入口调用MDC.put()方法传入请求ID，在出口调用MDC.remove()方法移除请求ID。配置好log4j2.xml 文件后，运行main函数，可以在控制台看到以下日志输出：

  1. 2018-02-17 13:19:52.606 {requestId=f97ea0fb-2a43-40f4-a3e8-711f776857d0} [main] DEBUG cn.wudashan.Main - log in main thread 1
  2. 2018-02-17 13:19:52.609 {requestId=f97ea0fb-2a43-40f4-a3e8-711f776857d0} [main] DEBUG cn.wudashan.Main - log in main thread 2
  3. 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快速的过滤出某次请求的所有日志。

3、进阶

然而，MDC工具真的有所想的这么方便吗？回到开头，一次请求可能涉及多线程异步处理，那么在多线程异步的场景下，它是否还能正常运作呢？Talk is cheap, show me the code。

  1. public class Main {
  3.     private static final String KEY = "requestId";
  4.     private static final Logger logger = LoggerFactory.getLogger(Main.class);
  6.     public static void main(String[] args) {
  7.         // 入口传入请求ID
  8.         MDC.put(KEY, UUID.randomUUID().toString());
  9.         // 主线程打印<font style="color: #1e6bb8;word-wrap: break-word;font-weight: bold;border-bottom: 1px solid">日志</font>
  10.         logger.debug("log in main thread");
  11.         // 异步线程打印<font style="color: #1e6bb8;word-wrap: break-word;font-weight: bold;border-bottom: 1px solid">日志</font>
  12.         new Thread(new Runnable() {
  13.             @Override
  14.             public void run() {
  15.                 logger.debug("log in other thread");
  16.             }
  17.         }).start();
  18.         // 出口移除请求ID
  19.         MDC.remove(KEY);
  20.     }
  21. }

代码里新起了一个异步线程，并在匿名对象Runnable的run()方法打印日志。运行main函数，可以在控制台看到以下日志输出：

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

不幸的是，请求ID在异步线程里不打印了。这是怎么回事呢？MDC之所以在异步线程中不生效是因为底层采用ThreadLocal 作为数据结构，调用MDC.put()方法传入的请求ID只在当前线程有效。
知道了原理那么解决这个问题就轻而易举了，可以使用装饰器模式 ，新写一个MDCRunnable类对Runnable接口进行一层装饰。在创建MDCRunnable类时保存当前线程的MDC值，在执行run()方法时再将保存的MDC值拷贝到异步线程中去。代码实现如下：

  1. public class MDCRunnable implements Runnable {
  3.     private final Runnable runnable;
  5.     private final Map<String, String> map;
  7.     public MDCRunnable(Runnable runnable) {
  8.         this.runnable = runnable;
  9.         // 保存当前线程的MDC值
  10.         this.map = MDC.getCopyOfContextMap();
  11.     }
  13.     @Override
  14.     public void run() {
  15.         // 传入已保存的MDC值
  16.         for (Map.Entry<String, String> entry : map.entrySet()) {
  17.             MDC.put(entry.getKey(), entry.getValue());
  18.         }
  19.         // 装饰器模式，执行run方法
  20.         runnable.run();
  21.         // 移除已保存的MDC值
  22.         for (Map.Entry<String, String> entry : map.entrySet()) {
  23.             MDC.remove(entry.getKey());
  24.         }
  25.     }
  27. }

接着，需要对main函数里创建的Runnable实现类进行装饰：

  1. public class Main {
  3.     private static final String KEY = "requestId";
  4.     private static final Logger logger = LoggerFactory.getLogger(Main.class);
  5.     private static final ExecutorService EXECUTOR = Executors.newSingleThreadExecutor();
  7.     public static void main(String[] args) {
  9.         // 入口传入请求ID
  10.         MDC.put(KEY, UUID.randomUUID().toString());
  12.         // 主线程打印<font style="color: #1e6bb8;word-wrap: break-word;font-weight: bold;border-bottom: 1px solid">日志</font>
  13.         logger.debug("log in main thread");
  15.         // 异步线程打印<font style="color: #1e6bb8;word-wrap: break-word;font-weight: bold;border-bottom: 1px solid">日志</font>，用MDCRunnable装饰Runnable
  16.         new Thread(new MDCRunnable(new Runnable() {
  17.             @Override
  18.             public void run() {
  19.                 logger.debug("log in other thread");
  20.             }
  21.         })).start();
  23.         // 异步线程池打印日志，用MDCRunnable装饰Runnable
  24.         EXECUTOR.execute(new MDCRunnable(new Runnable() {
  25.             @Override
  26.             public void run() {
  27.                 logger.debug("log in other thread pool");
  28.             }
  29.         }));
  30.         EXECUTOR.shutdown();
  31.         // 出口移除请求ID
  32.         MDC.remove(KEY);
  33.     }
  34. }

执行main函数，将会输出以下日志：

  1. 2018-03-04 23:44:05.343 {requestId=5ee2a117-e090-41d8-977b-cef5dea09d34} [main] DEBUG cn.wudashan.Main - log in main thread
  2. 2018-03-04 23:44:05.346 {requestId=5ee2a117-e090-41d8-977b-cef5dea09d34} [Thread-1] DEBUG cn.wudashan.Main - log in other thread
  3. 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打印了！

4、总结

如何使用MDC工具来快速过滤一次请求的所有日志，并通过装饰器模式使得MDC工具在异步线程里也能生效。有了MDC，再通过AOP技术对所有的切面植入requestId，就可以将整个系统的任意流程的日志过滤出来。使用MDC工具，在开发自测阶段，可以极大地节省定位问题的时间，提升开发效率；在运维维护阶段，可以快速地收集相关日志信息，加快分析速度。