自拍偷在线精品自拍偷,亚洲欧美中文日韩v在线观看不卡

如何快速過濾出一次請(qǐng)求的所有日志？

作者：佚名
開發(fā) 后端
本文講述了如何使用MDC工具來快速過濾一次請(qǐng)求的所有日志，并通過裝飾器模式使得MDC工具在異步線程里也能生效。

[[436935]]

 01、前言

在現(xiàn)網(wǎng)出現(xiàn)故障時(shí)，我們經(jīng)常需要獲取一次請(qǐng)求流程里的所有日志進(jìn)行定位。如果請(qǐng)求只在一個(gè)線程里處理，則我們可以通過線程ID來過濾日志，但如果請(qǐng)求包含異步線程的處理，那么光靠線程ID就顯得捉襟見肘了。

華為IoT平臺(tái)，提供了接收設(shè)備上報(bào)數(shù)據(jù)的能力， 當(dāng)數(shù)據(jù)到達(dá)平臺(tái)后，平臺(tái)會(huì)進(jìn)行一些復(fù)雜的業(yè)務(wù)邏輯處理，如數(shù)據(jù)存儲(chǔ)，規(guī)則引擎，數(shù)據(jù)推送，命令下發(fā)等等。由于這個(gè)邏輯之間沒有強(qiáng)耦合的關(guān)系，所以通常是異步處理。如何將一次數(shù)據(jù)上報(bào)請(qǐng)求中包含的所有業(yè)務(wù)日志快速過濾出來，就是本文要介紹的。

02、正文

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

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

我們?cè)趍ain函數(shù)的入口調(diào)用MDC.put()方法傳入請(qǐng)求ID，在出口調(diào)用MDC.remove()方法移除請(qǐng)求ID。配置好log4j2.xml 文件后，運(yùn)行main函數(shù)，可以在控制臺(tái)看到以下日志輸出： 

  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  

從日志中可以明顯地看到花括號(hào)中包含了 （映射的）請(qǐng)求ID(requestId)，這其實(shí)就是我們定位（診斷）問題的關(guān)鍵字（上下文） 。最新面試題整理好了，點(diǎn)擊Java面試庫(kù)小程序在線刷題。

有了MDC工具，只要在接口或切面植入put()和remove()代碼，在現(xiàn)網(wǎng)定位問題時(shí)，我們就可以通過grep requestId=xxx *.log快速的過濾出某次請(qǐng)求的所有日志。

03、進(jìn)階

然而，MDC工具真的有我們所想的這么方便嗎？回到我們開頭，一次請(qǐng)求可能涉及多線程異步處理，那么在多線程異步的場(chǎng)景下，它是否還能正常運(yùn)作呢？Talk is cheap, show me the code。

推薦一個(gè) Spring Boot 基礎(chǔ)教程及實(shí)戰(zhàn)示例：

https://github.com/javastacks/spring-boot-best-practice 

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

代碼里我們新起了一個(gè)異步線程，并在匿名對(duì)象Runnable的run()方法打印日志。運(yùn)行main函數(shù)，可以在控制臺(tái)看到以下日志輸出： 

  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 

不幸的是，請(qǐng)求ID在異步線程里不打印了。這是怎么回事呢？要解決這個(gè)問題，我們就得知道MDC的實(shí)現(xiàn)原理。最新面試題整理好了，點(diǎn)擊Java面試庫(kù)小程序在線刷題。

由于篇幅有限，這里就暫不詳細(xì)介紹，MDC之所以在異步線程中不生效是因?yàn)榈讓硬捎肨hreadLocal 作為數(shù)據(jù)結(jié)構(gòu)，我們調(diào)用MDC.put()方法傳入的請(qǐng)求ID只在當(dāng)前線程有效。感興趣的小伙伴可以自己深入一下代碼細(xì)節(jié)。

知道了原理那么解決這個(gè)問題就輕而易舉了，我們可以使用裝飾器模式 ，新寫一個(gè)MDCRunnable類對(duì)Runnable接口進(jìn)行一層裝飾。在創(chuàng)建MDCRunnable類時(shí)保存當(dāng)前線程的MDC值，在執(zhí)行run()方法時(shí)再將保存的MDC值拷貝到異步線程中去。

代碼實(shí)現(xiàn)如下： 

  1. public class MDCRunnable implements Runnable {  
  2.     private final Runnable runnable;  
  3.     private final Map<String, String> map;  
  4.     public MDCRunnable(Runnable runnable) {  
  5.         this.runnable = runnable;  
  6.         // 保存當(dāng)前線程的MDC值  
  7.         this.map = MDC.getCopyOfContextMap();  
  8.     }  
  9.     @Override  
  10.     public void run() {  
  11.         // 傳入已保存的MDC值  
  12.         for (Map.Entry<String, String> entry : map.entrySet()) {  
  13.             MDC.put(entry.getKey(), entry.getValue());  
  14.         }  
  15.         // 裝飾器模式，執(zhí)行run方法  
  16.         runnable.run();  
  17.         // 移除已保存的MDC值  
  18.         for (Map.Entry<String, String> entry : map.entrySet()) {  
  19.             MDC.remove(entry.getKey());  
  20.         }  
  21.     }     
  22. } 

接著，我們需要對(duì)main函數(shù)里創(chuàng)建的Runnable實(shí)現(xiàn)類進(jìn)行裝飾： 

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

執(zhí)行main函數(shù)，將會(huì)輸出以下日志： 

  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！ 經(jīng)過我們的努力，最終在異步線程和線程池中都有requestId打印了！

04、總結(jié)

本文講述了如何使用MDC工具來快速過濾一次請(qǐng)求的所有日志，并通過裝飾器模式使得MDC工具在異步線程里也能生效。有了MDC，再通過AOP技術(shù)對(duì)所有的切面植入requestId，就可以將整個(gè)系統(tǒng)的任意流程的日志過濾出來。

使用MDC工具，在開發(fā)自測(cè)階段，可以極大地節(jié)省定位問題的時(shí)間，提升開發(fā)效率；在運(yùn)維維護(hù)階段，可以快速地收集相關(guān)日志信息，加快分析速度。 

 

責(zé)任編輯：龐桂玉 來源： Java技術(shù)棧
日志Java代碼
相關(guān)推薦

2022-11-18 08:31:56

Spring日志工具

2020-10-10 08:49:02

JS

2020-10-10 08:01:38

JS HTML 表單

2019-12-27 10:24:43

瀏覽器底層DNS

2020-08-24 07:34:39

網(wǎng)絡(luò)超時(shí)請(qǐng)求

2024-02-28 08:18:13

Java日志項(xiàng)目

2011-06-28 10:41:50

DBA

2022-05-12 09:52:09

網(wǎng)絡(luò)架構(gòu)HTTP跨域保護(hù)機(jī)制

2021-12-27 10:08:16

Python編程語(yǔ)言庫(kù)

2020-10-24 13:50:59

Python庫(kù)編程語(yǔ)言

2020-03-19 15:32:47

手機(jī)消毒病毒

2019-04-18 10:55:00

故障演練流量

2025-02-24 12:00:00

開發(fā)SpringBootJava

2012-08-28 09:21:59

Ajax查錯(cuò)經(jīng)歷Web

2021-11-01 17:29:02

Windows系統(tǒng)Fork

2011-04-07 11:20:21

SQLServer

2021-05-31 10:08:44

工具腳本主機(jī)

2021-05-31 10:23:10

惡意軟件攻擊網(wǎng)絡(luò)安全

2009-06-08 09:39:46

2010-09-07 11:09:33

SQL語(yǔ)句
點(diǎn)贊
收藏

51CTO技術(shù)棧公眾號(hào)