【日志框架】MDC实现日志中增加自定义参数

柔光的暖阳◎ 2022-12-18 11:58 421阅读 0赞

## 1、MDC ##

MDC（Mapped Diagnostic Contexts）映射调试上下文，主要用在做日志链路跟踪时，动态配置用户自定义的一些信息，比如requestId、sessionId等等。MDC使用的容器支持多线程操作，满足线程安全。

## 2、log4j2实现 ##

代码中调用MDC.put

log4j2.properties中，pattern增加\[%X\{username\}\]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zNjE0MjA0Mg_size_16_color_FFFFFF_t_70_pic_center]  
效果：  
![在这里插入图片描述][20201026205116199.png_pic_center]

## 3、logback实现 ##

同样java代码中调用MDC.put

public class LogbackTest { 
    
        private static final Logger log = LoggerFactory.getLogger(LogbackTest.class);
    
        public static void main(String[] args) { 
            MDC.put("custom1", "test122");
            log.info("logback test1234-----------------------");
        }
    }

logback.xml中增加自定义参数  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zNjE0MjA0Mg_size_16_color_FFFFFF_t_70_pic_center 1]  
效果：  
![在这里插入图片描述][2020102620532218.png_pic_center]

## 4、org.slf4j.MDC ##

org.slf4j.MDC通过接口MDCAdapter来适配不同的日志框架，MDCAdapter是一个单例对象。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zNjE0MjA0Mg_size_16_color_FFFFFF_t_70_pic_center 2]  
多种不同的实现类  
![在这里插入图片描述][20201026205831381.png_pic_center]  
LogbackMDCAdapter：本质上是ThreadLocal<Map<String, String>>

public class LogbackMDCAdapter implements MDCAdapter { 
        final ThreadLocal<Map<String, String>> copyOnThreadLocal = new ThreadLocal();
        private static final int WRITE_OPERATION = 1;
        private static final int MAP_COPY_OPERATION = 2;
        final ThreadLocal<Integer> lastOperation = new ThreadLocal();
        // ......
        public void put(String key, String val) throws IllegalArgumentException { 
            if (key == null) { 
                throw new IllegalArgumentException("key cannot be null");
            } else { 
                Map<String, String> oldMap = (Map)this.copyOnThreadLocal.get();
                Integer lastOp = this.getAndSetLastOperation(1);
                if (!this.wasLastOpReadOrNull(lastOp) && oldMap != null) { 
                    oldMap.put(key, val);
                } else { 
                    Map<String, String> newMap = this.duplicateAndInsertNewMap(oldMap);
                    newMap.put(key, val);
                }
    
            }
        }    
        // ......
    }

Log4jMDCAdapter

public class Log4jMDCAdapter implements MDCAdapter { 
        public Log4jMDCAdapter() { 
        }
    
        public void put(String key, String val) { 
            ThreadContext.put(key, val);
        }
        // ......
    }

ThreadContext  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zNjE0MjA0Mg_size_16_color_FFFFFF_t_70_pic_center 3]  
![在这里插入图片描述][20201026210806813.png_pic_center]

DefaultThreadContextMap：和LogbackMDCAdapter一样，本质上还是ThreadLocal<Map<String, String>>  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zNjE0MjA0Mg_size_16_color_FFFFFF_t_70_pic_center 4]

## 5、测试子父线程能否继承 ##

MDC底层使用ThreadLocal实现，可以做到线程隔离，非常适用于C/S、B/S架构这种为每个请求开一个线程去处理的场景，每个请求的处理过程都是一个独立的线程。但是通常复杂的业务需要异步处理，在某个请求处理过程，异步调用其他服务，这个异步过程中的日志还能读到父线程的MDC吗？其实这子父线程加起来才是完整的处理流程，我们需要在这种子线程中读取父线程的MDC。  
以log4j2为例，首先看看直接新起线程，能否在新线程中读到父线程的MDC

public class Log4j2Test { 
    
        private static final Logger log = LoggerFactory.getLogger(Log4j2Test.class);
    
        public static void main(String[] args) { 
            log.info("test");
            MDC.put("username", "test123");
            log.info("hello world");
            new Thread(new Runnable() { 
                public void run() { 
                    log.info("test Runnable");
                }
            }).start();
        }
    }

结果当然不能跨线程读取到username  
![在这里插入图片描述][20201026211517668.png_pic_center]  
不过既然底层是ThraedLocal，那就是有办法可以跨线程使用的，DefaultThreadContextMap中的开关inheritableMap决定着localMap能否在子父线程之间集成  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zNjE0MjA0Mg_size_16_color_FFFFFF_t_70_pic_center 5]  
然后resources目录下新增配置文件log4j2.component.properties

isThreadContextMapInheritable=true

再次运行便发现成功在子线程读到了username。  
![在这里插入图片描述][20201026211858874.png_pic_center]  
但是logback貌似没有发现这样的开关。不过logback也是有办法实现子父线程继承的，比如很多调用链的java客户端，使用logback也一样可以实现子父线程继承，具体解决思路参考zipkin的java客户端了。

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zNjE0MjA0Mg_size_16_color_FFFFFF_t_70_pic_center]: /images/20221122/c6ed2f638e1c430b9c86a83c9c065281.png
[20201026205116199.png_pic_center]: /images/20221122/82122944bf1543c582e003fc44c93eb4.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zNjE0MjA0Mg_size_16_color_FFFFFF_t_70_pic_center 1]: /images/20221122/350fcfe579d149f1b4f888b0e53faabb.png
[2020102620532218.png_pic_center]: /images/20221122/38975a1e00d946e596b4f381e43351ee.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zNjE0MjA0Mg_size_16_color_FFFFFF_t_70_pic_center 2]: /images/20221122/74810c9e834c49699738234788e72528.png
[20201026205831381.png_pic_center]: /images/20221122/ce2d91574b9f427ebdfa6649b30ed3b7.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zNjE0MjA0Mg_size_16_color_FFFFFF_t_70_pic_center 3]: /images/20221122/b51d6d7f113a44148bdbb8d0ada9213f.png
[20201026210806813.png_pic_center]: /images/20221122/a05182153eb34fe6bac92801982f4fef.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zNjE0MjA0Mg_size_16_color_FFFFFF_t_70_pic_center 4]: /images/20221122/a47f8fb239b043a290480fbd0b6fbc4b.png
[20201026211517668.png_pic_center]: /images/20221122/89ce065a08e64a498653b9c964de49f3.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zNjE0MjA0Mg_size_16_color_FFFFFF_t_70_pic_center 5]: /images/20221122/706037e35765455590b77d15d75738d0.png
[20201026211858874.png_pic_center]: /images/20221122/b2f6f2fc75ae4dd7bc49b3e34bf2797f.png