Java日志工具之SLF4J

时间：2023-03-08 16:39:45
Java日志工具之SLF4J

SLF4J全称为Simple Logging Facade for Java (简单日志门面)，作为各种日志框架的简单门面或者抽象，包括 java.util.logging, log4j, logback. SLF4J允许用户在部署期间加入自己希望使用的日志系统。其实SLF4J与log4j, logback都是同一作者。

首先声明本文是基于SLF4J版本：slf4j-1.7.6。

Hello World

依照编程传统，先来一个Hello Word的Demo:

package net.oseye;

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

public class RunMain {

	public static void main(String[] args) {

		Logger logger = LoggerFactory.getLogger(RunMain.class);

		logger.info("Hello World");

	}

}

首先需要下载slf4j依赖包,解压后将 slf4j-api-1.7.6.jar加入classpath中。

Java日志工具之SLF4J

运行这个Demo会显示如下信息：

SLF4J: Failed to load class "org.slf4j.impl.StaticLoggerBinder".
SLF4J: Defaulting to no-operation (NOP) logger implementation
SLF4J: See http://www.slf4j.org/codes.html#StaticLoggerBinder for further details.

出现这个警告信息的原因是，slf4j没有与任何日志框(如：java.util.logging, log4j, logback)架绑定，一旦将某个绑定加入classpath中，这个警告消息就不再出现。假设你将slf4j-simple-1.7.2.jar(在下载的SLF4J的压缩包里)加入你的classpath，SLF4J自动动绑定SimpleLogger，这是输出：

[main] INFO net.oseye.RunMain - Hello World

但不能把多个绑定加入你的classpath，比如你再把slf4j-nop-1.7.6.jar加入classpath，就会看到如下的警告：

SLF4J: Class path contains multiple SLF4J bindings.
SLF4J: Found binding in [jar:file:/D:/Java/tools/slf4j-1.7.6/slf4j-simple-1.7.6.jar!/org/slf4j/impl/StaticLoggerBinder.class]
SLF4J: Found binding in [jar:file:/D:/Java/tools/slf4j-1.7.6/slf4j-nop-1.7.6.jar!/org/slf4j/impl/StaticLoggerBinder.class]
SLF4J: See http://www.slf4j.org/codes.html#multiple_bindings for an explanation.
SLF4J: Actual binding is of type [org.slf4j.impl.SimpleLoggerFactory]
[main] INFO net.oseye.RunMain - Hello World

可以看到有多个绑定是会警告，且提醒你实际绑定的是哪个。

绑定实现

SLF4J与日志框架进行绑定是在编译阶段实现的，只要把与日志框架相应的绑定实现加入classpath中即可，SLF4J压缩包里已经有了一些绑定实现：

  • slf4j-log4j12-1.7.2.jar：用于绑定 1.2版的log4j , 这是一个广泛使用的日志系统，当然你还要把log4j包加到classpath中
  • slf4j-jdk14-1.7.2.jar：用于绑定 java.util.logging, 作为JDK 1.4 的logging
  • slf4j-nop-1.7.2.jar：用于绑定 NOP, 不做任何操作.
  • slf4j-simple-1.7.2.jar：用于绑定 simple 的实现, 所有的打印会响应到 System.err. 只有INFO或者更高的级别会被打印. 这个绑定在小型应用中非常有用。
  • slf4j-jcl-1.7.2.jar：用于绑定 Jakarta Commons Logging. 这个绑定会使得SLF4J 的日志功能委托JCL来完成.
  • 还有除了SLF4J项目以外提供的绑定包，例如 logback 本身就实现了SLF4J。Logback的 ch.qos.logback.classic.Logger 类实直接实现了SLF4J 的 org.slf4j.Logger 接口。因此，结合logback使用 SLF4J 节省很多内存和计算的开销。

要切换日志系统，只需在classpath上替换slf4j的绑定则可，但只能添加一个绑定实现哦。但如果你使用log4j，不进要把绑定实现加入classpath，同时也要把log4j-x.x.x.jar包加入。

通过官方的一张图，来看看SLF4J最新机制吧：

Java日志工具之SLF4J

  • underlying表示直接实现SLF4J的接口，adaptation表示通过适配器实现SLF4J的接口；
  • SLF4J的接口和它的各种适配器是非常简单的。因为SLF4J没有使用或者说没有直接访问类加载器，所以SLF4J没有类加载器和内存泄露的问题，在方面，common logging就相形见拙了；

Maven依赖配置

使用Maven构建项目时，在POM中添加依赖可以只声明绑定实现即可，通过依赖关系会自动把相应的SLF4J的版本加载到你的项目中，但及时你声明了SLF4J的依赖也没错，避免使用默认的SLF4J的版本不如你意。

  • LOG4J :如果你希望使用log4j 作为日志框架。你只需在pom.xml文件中声明"org.slf4j:slf4j-log4j12"依赖（如下所示）。此外，slf4j-log4j12-1.7.2.jar, 依赖会自动把slf4j-api-1.7.2.jar加载到你的项目。不过明确的声明slf4j-api-1.7.2.jar的依赖并没有错，也避免MAVEN默认的相关版本信息不如你所意。下同。 
    <dependency>
    
  <groupId>org.slf4j</groupId>
    
  <artifactId>slf4j-log4j12</artifactId>
    
  <version>1.7.6</version>
    
</dependency>
  • LOGBACK-CLASSIC 
    <dependency>
    
  <groupId>ch.qos.logback</groupId>
    
  <artifactId>logback-classic</artifactId>
    
  <version>1.0.13</version>
    
</dependency>
  • JAVA.UTIL.LOGGING 
    <dependency>
    
  <groupId>org.slf4j</groupId>
    
  <artifactId>slf4j-jdk14</artifactId>
    
  <version>1.7.6</version>
    
</dependency>

线程映射表（Mapped Diagnostic Context）

MDC本质上是日志框架维护的一个map，在应用中提供键值对，这些值可以添加到日志消息中。

SLF4J支持MDC。如果具体的日志框架提供了MDC功能，那么SLF4J就会委托下面的日志框架实现MDC功能。注意，现在只有log4j和logback提供MDC功能。如果具体的日志框架不提供，如java.util.logging，则slf4j将会存储MDC的数据，但是里面的信息需要用户通过代码来获得。

因此，作为一个SLF4J的用户，你可以利用已有MDC功能的log4j和logback，但是不能强制用户依赖具体的日志框架。

更多关于MDC的信息，请查看logback指南中的 MDC 章节。


SLF4J经典应用：占位符

SLF4J的日志消息使用占位符"{}"代替了常用的字符串拼接，据官方说这样速度更快：

package net.oseye;

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

public class RunMain {

	public static void main(String[] args) {

		Logger logger = LoggerFactory.getLogger(RunMain.class);

		logger.info("Hello {}","World");

	}

}
  • 匹配：占位符“{}”，只匹配“{”后紧跟“}”的占位符 
    logger.debug("Set {1,2} differs from {}", "3");
    
logger.debug("Set {1,2} differs from {{}}", "3");

    输出：

    Set {1,2} differs from 3
    Set {1,2} differs from {3}

  • 转义：只要转义“{”即可 
    logger.debug("Set \\{} differs from {}", "3");
    
logger.debug("File name is C:\\\\{}.", "file.zip");

    输出：

    Set {} differs from 3
    File name is C:\file.zip

相关文章