log4j MDC用户操作日志追踪配置

        MDC（Mapped Diagnostic Context，映射调试上下文）是 log4j 和 logback 提供的一种方便在多线程条件下记录日志的功能。某些应用程序采用多线程的方式来处理多个用户的请求。在一个用户的使用过程中，可能有多个不同的线程来进行处理。典型的例子是 Web 应用服务器。当用户访问某个页面时，应用服务器可能会创建一个新的线程来处理该请求，也可能从线程池中复用已有的线程。在一个用户的会话存续期间，可能有多个线程处理过该用户的请求。这使得比较难以区分不同用户所对应的日志。当需要追踪某个用户在系统中的相关日志记录时，就会变得很麻烦。

　　一种解决的办法是采用自定义的日志格式，把用户的信息采用某种方式编码在日志记录中。这种方式的问题在于要求在每个使用日志记录器的类中，都可以访问到用户相关的信息。这样才可能在记录日志时使用。这样的条件通常是比较难以满足的。MDC 的作用是解决这个问题。

　　MDC 可以看成是一个与当前线程绑定的哈希表，可以往其中添加键值对。MDC 中包含的内容可以被同一线程中执行的代码所访问。当前线程的子线程会继承其父线程中的 MDC 的内容。当需要记录日志时，只需要从 MDC 中获取所需的信息即可。MDC 的内容则由程序在适当的时候保存进去。对于一个 Web 应用来说，通常是在请求被处理的最开始保存这些数据。

二、MDC使用案例

     相对比较大的项目来说，一般会有多个开发人员，如果每个开发人员凭自己的理解打印日志，那么当用户反馈问题时，很难通过日志去快速的定位到出错原因，也会消耗更多的时间。所以针对这种问题，一般会定义好整个项目的日志格式，如果是需要追踪的日志，开发人员调用统一的打印方法，在日志配置文件里面定义好相应的字段，通过MDC功能就能很好的解决问题。

     比如我们可以事先把用户的sessionId，登录用户的用户名，访问的城市id，当前访问商户id等信息定义成字段，线程开始时把值放入MDC里面，后续在其他地方就能直接使用，无需再去设置了。

    使用MDC来记录日志，一来可以规范多开发下日志格式的一致性，二来可以为后续使用ELK对日志进行分析。

    所需依赖 

[plain] view plain copy

1. <dependency>  
2.   <groupId>log4j</groupId>  
3.   <artifactId>log4j</artifactId>  
4.   <version>1.2.17</version>  
5. </dependency>  
6. <dependency>  
7.     <groupId>org.slf4j</groupId>  
8.     <artifactId>slf4j-log4j12</artifactId>  
9.     <version>1.7.21</version>  
10. </dependency>   

log4j.xml配置样例，追踪日志自定义格式主要在name="trance"的layout里面进行设置，我们使用%X{userName}来定义此处会打印MDC里面key为userName的value，如果所定义的字段在MDC不存在对应的key，那么将不会打印，会留一个占位符。

[html] view plain copy

1. <?xml version="1.0" encoding="UTF-8"?>  
2. <!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">  
3. <log4j:configuration>  
4.     <appender name="console" class="org.apache.log4j.ConsoleAppender">  
5.         <param name="target" value="System.out" />  
6.         <layout class="org.apache.log4j.PatternLayout">  
7.             <param name="ConversionPattern" value="%-d{yyyy-MM-dd HH:mm:ss.SSS} %-6p%c:%L %x - %m%n" />  
8.         </layout>  
9.     </appender>  
10.   
11.     <appender name="error" class="org.apache.log4j.DailyRollingFileAppender">  
12.         <param name="File" value="D://logs//error.log" />  
13.         <param name="DatePattern" value="'.'yyyy-MM-dd" />  
14.         <param name="threshold" value="error"/>  
15.         <param name="append" value="true"/>  
16.         <layout class="org.apache.log4j.PatternLayout">  
17.             <param name="ConversionPattern" value="[%d{yyyy-MM-dd HH:mm:ss.SSS}] %-6p%c:%L - %m%n" />  
18.         </layout>  
19.     </appender>  
20.   
21.     <appender name="logic" class="org.apache.log4j.DailyRollingFileAppender">  
22.         <param name="File" value="D://logs//logic.log" />  
23.         <param name="DatePattern" value="'.'yyyy-MM-dd" />  
24.         <param name="threshold" value="info"/>  
25.         <param name="append" value="true"/>  
26.         <layout class="org.apache.log4j.PatternLayout">  
27.             <param name="ConversionPattern" value="[%d{yyyy-MM-dd HH:mm:ss.SSS}] %-6p%c:%L - %m%n" />  
28.         </layout>  
29.     </appender>  
30.   
31.     <appender name="trace" class="org.apache.log4j.DailyRollingFileAppender">  
32.         <param name="File" value="D://logs//trace.log" />  
33.         <param name="DatePattern" value="'.'yyyy-MM-dd" />  
34.         <param name="threshold" value="info"/>  
35.         <param name="append" value="true"/>  
36.         <layout class="org.apache.log4j.PatternLayout">  
37.                <param name="ConversionPattern" value="[%d{yyyy-MM-dd HH:mm:ss.SSS}] - %X{mchId} - %X{mchName} - %X{siteName} - %X{sessionId} - %X{cityId} - %X{userName} - %X{mobile} - %m%n" />  
38.          </layout>  
39.     </appender>  
40.   
41.     <logger name="traceLog" additivity="false">  
42.         <level value="info" />  
43.         <appender-ref ref="trace" />  
44.     </logger>  
45.   
46.     <root>  
47.         <level value="info" />  
48.         <appender-ref ref="console"/>  
49.         <appender-ref ref="logic" />  
50.         <appender-ref ref="error" />  
51.     </root>  
52. </log4j:configuration>  

日志打印类

[java] view plain copy

1. import org.slf4j.Logger;  
2. import org.slf4j.LoggerFactory;  
3.   
4. public class TraceLogger {  
5.     //此处的"tranceLog"为log4j中定义的对应的 logger的name  
6.     private static final Logger TRACE_LOGGER = LoggerFactory.getLogger("traceLog");  
7.   
8.     private TraceLogger() {  
9.           
10.     }  
11.     
12.     public static void info(String message){  
13.         TRACE_LOGGER.info(message);  
14.     }  
15.   
16.     public static void info(String format,Object... arguments){  
17.         TRACE_LOGGER.info(format, arguments);  
18.     }  
19. }  

最后写个日志打印测试一下效果

[java] view plain copy

1. @Test  
2. public void Test(){  
3.     MDC.clear();  
4.     MDC.put("sessionId" , "f9e287fad9e84cff8b2c2f2ed92adbe6");  
5.     MDC.put("cityId" , 1);  
6.     MDC.put("siteName" , "北京");  
7.     MDC.put("userName" , "userwyh");  
8.     TraceLogger. info("测试MDC打印一");  
9.            
10.     MDC.put("mobile" , "110");  
11.     TraceLogger. info("测试MDC打印二");  
12.            
13.     MDC.put("mchId" , 12);  
14.     MDC.put("mchName", "商户名称");  
15.     TraceLogger. info("测试MDC打印三");  
16.            
17. }  

执行完后我们可以在定义的日志输出路径下看到以下输出