Slf4j MDC机制

发布时间：2023-02-16 13:50:47 所属栏目：Java 来源：互联网

导读：MDC 简介 MDC ( Mapped Diagnostic Contexts )，它是一个线程安全的存放诊断日志的容器。 Logback设计的一个目标之一是对分布式应用系统的审计和调试。在现在的分布式系统中，需要同时处理很多的请求。如何来很好的区分日志到底是那个请求输出的呢？我们可以

　　MDC 简介
　　MDC ( Mapped Diagnostic Contexts )，它是一个线程安全的存放诊断日志的容器。

　　Logback设计的一个目标之一是对分布式应用系统的审计和调试。在现在的分布式系统中，需要同时处理很多的请求。如何来很好的区分日志到底是那个请求输出的呢？我们可以为每一个请求生一个logger，但是这样子最产生大量的资源浪费，并且随着请求的增多这种方式会将服务器资源消耗殆尽，所以这种方式并不推荐。

　　一种更加轻量级的实现是使用MDC机制，在处理请求前将请求的唯一标示放到MDC容器中如sessionId，这个唯一标示会随着日志一起输出，以此来区分该条日志是属于那个请求的。并在请求处理完成之后清除MDC容器。

　　下面是MDC对外提供的方法，也可以通过MDC javadocs查看所有方法。

　　

　　package org.slf4j;
　　public class MDC {
　　 // 将一个K-V的键值对放到容器，其实是放到当前线程的ThreadLocalmap中
　　 public static void put(String key,String val);
　　 // 根据key在当前线程的MDC容器中获取对应的值
　　 public static String get(String key);
　　 // 根据key移除容器中的值
　　 public static void remove(String key);
　　 // 清空当前线程的MDC容器
　　 public static void clear();
　　}
　　简单的例子
　　Example 7.1: Basic MDC usage ( logback-examples/src/main/java/chapters/mdc/SimpleMDC.java)

　　

　　package com.xiaolyuh;
　　import org.slf4j.Logger;
　　import org.slf4j.LoggerFactory;
　　import org.slf4j.MDC;
　　public class SimpleMDC {
　　    public static void main(String[] args) throws Exception {
　　        // You can put values in the MDC at any time. Before anything else
　　        // we put the first name
　　        MDC.put("first","Dorothy");
　　        Logger logger = LoggerFactory.getLogger(SimpleMDC.class);
　　        // We Now put the last name
　　        MDC.put("last","Parker");
　　        // The most beautiful two words in the English language according
　　        // to Dorothy Parker:
　　        logger.info("Check enclosed.");
　　        logger.debug("The most beautiful two words in English.");
　　        MDC.put("first","Richard");
　　        MDC.put("last","Nixon");
　　        logger.info("I am not a crook.");
　　        logger.info("Attributed to the former US president. 17 Nov 1973.");
　　    }
　　}
　　Logback配置：

　　

　　<appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
　　 <layout>
　　    <Pattern>%X{first} %X{last} - %m%n</Pattern>
　　 </layout>
　　</appender>
　　输出日志：

　　

　　Dorothy Parker - Check enclosed.
　　Dorothy Parker - The most beautiful two words in English.
　　Richard Nixon - I am not a crook.
　　Richard Nixon - Attributed to the former US president. 17 Nov 1973.
　　在日志模板logback.xml 中，使用 %X{ }来占位，替换到对应的 MDC 中 key 的值。同样，logback.xml配置文件支持了多种格式的日志输出，比如%highlight、%d等等，这些标志，在PatternLayout.java中维护。
　　MDC的容器中的key可以多次赋值，最后一次的赋值会覆盖上一次的值。
　　PatternLayout :

　　

　　public class PatternLayout extends PatternLayoutBase<ILoggingEvent> {
　　    public static final Map<String,String> defaultConverterMap = new HashMap<String,String>();
　　    public static final String HEADER_PREFIX = "#logback.classic pattern: ";
　　    static {
　　        defaultConverterMap.putAll(Parser.DEFAULT_COMPOSITE_CONVERTER_MAP);
　　        // 按照{}配置输出时间
　　        defaultConverterMap.put("d",DateConverter.class.getName());
　　        defaultConverterMap.put("date",DateConverter.class.getName());
　　        // 输出应用启动到日志时间触发时候的毫秒数
　　        defaultConverterMap.put("r",RelativeTimeConverter.class.getName());
　　        defaultConverterMap.put("relative",RelativeTimeConverter.class.getName());
　　        // 输出日志级别的信息
　　        defaultConverterMap.put("level",LevelConverter.class.getName());
　　        defaultConverterMap.put("le",LevelConverter.class.getName());
　　        defaultConverterMap.put("p",LevelConverter.class.getName());
　　        // 输出产生日志事件的线程名
　　        defaultConverterMap.put("t",ThreadConverter.class.getName());
　　        defaultConverterMap.put("thread",ThreadConverter.class.getName());
　　        // 输出产生log事件的原点的日志名=我们创建logger的时候设置的
　　        defaultConverterMap.put("lo",LoggerConverter.class.getName());
　　        defaultConverterMap.put("logger",LoggerConverter.class.getName());
　　        defaultConverterMap.put("c",LoggerConverter.class.getName());
　　        // 输出提供日志事件的对应的应用信息
　　        defaultConverterMap.put("m",MessageConverter.class.getName());
　　        defaultConverterMap.put("msg",MessageConverter.class.getName());
　　        defaultConverterMap.put("message",MessageConverter.class.getName());
　　        // 输出调用方发布日志事件的完整类名
　　        defaultConverterMap.put("C",ClassOfCallerConverter.class.getName());
　　        defaultConverterMap.put("class",ClassOfCallerConverter.class.getName());
　　        // 输出发布日志请求的方法名
　　        defaultConverterMap.put("M",MethodofCallerConverter.class.getName());
　　        defaultConverterMap.put("method",MethodofCallerConverter.class.getName());
　　        // 输出log请求的行数
　　        defaultConverterMap.put("L",LineOfCallerConverter.class.getName());
　　        defaultConverterMap.put("line",LineOfCallerConverter.class.getName());

（编辑：甘南站长网）

【声明】本站内容均来自网络，其相关言论仅代表作者个人观点，不代表本站立场。若无意侵犯到您的权利，请及时与联系站长删除相关内容!

1/4

尾页