SLF4J及其MDC详解

梦里梦外; 2022-05-10 07:33 235阅读 0赞

SLF4J，即Simple Logging Facade for Java，是一个通用的、Java日志系统的抽象框架。

对于实现了SLF4J的日志系统，能够在应用部署时（而不是编译时）动态插入应用，使得应用可以采用任何日志系统。

1. 常见的SLF4J日志系统实现

*  No-operation (NOP) Logger

即org.slf4j.helpers.NOPMDCAdapter，是SLF4J API自带的默认实现。该实现只是占位，不会输出任何日志。

*  Simple Logger

即org.slf4j.impl.SimpleLogger，是SLF4J API提供的简单日志实现。

*  Logback

原生实现了SLF4J API的日志系统，是SLF4J的标准参考实现，提供了强大而灵活的日志功能，是Log4j的继任者。

*  Log4j

通过封装实现了SLF4J API的日志系统。

*  JCL (Jakarta Commons Logging)

通过封装实现了SLF4J API的日志系统。

*  Java Logging(JUL, java.util.logging)

通过封装实现了SLF4J API的日志系统。

2. SLF4J的基本用法

1) 在Java应用类中调用SLF4J API输出日志

org.slf4j.Logger logger = org.slf4j.LoggerFactory.getLogger(MyClassName.class);
    logger.info("my logs");

2) 配置mdc.xml，以指定日志格式等（可选）

<configuration>
      <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <layout>
          <Pattern>%-4r [%thread] %-5level C:%X{MDC.my_param1} N:%X{MDC.my_param2} - %msg%n</Pattern>
        </layout>
      </appender>
    
      <root level="debug">
        <appender-ref ref="CONSOLE"/>
      </root>
    </configuration>

3. MDC (Mapped Diagnostic Context)

MDC顾名思义提供日志的上下文信息，通过MDC中的参数值区分输出的日志。

SLF4J的MDC实质上就是一个Map。通常实现SLF4J的日志系统支持MDC，即表明该日志系统负责维护这个Map。应用就可以依赖于日志系统，直接存取key/value对到该Map中。

在SLF4J API中，也提供了MDC的默认实现类org.slf4j.MDC。如果实现SLF4J API的日志系统也支持MDC功能，则覆盖org.slf4j.MDC类。

目前，只有Log4j和Logback支持MDC功能。Java Logging不支持MDC功能，可以通过SLF4J API中的org.slf4j.helpers.BasicMDCAdapter提供MDC功能。而对于其他的日志系统（如slf4j-simple, slf4j-nop），只能使用SLF4J API中的org.slf4j.helpers.NOPMDCAdapter提供MDC功能。

参考链接：

http://www.slf4j.org/  
    https://github.com/qos-ch/slf4j  
    http://www.slf4j.org/api/org/slf4j/MDC.html