Slf4j java 日志框架用法介绍

2019-04-17 0 By admin

一、Slf4j与其它日志组件的关系说明

Slf4j的设计思想比较简洁,使用了Facade设计模式,Slf4j本身只提供了一个slf4j-api-version.jar包,这个jar中主要是日志的抽象接口,jar中本身并没有对抽象出来的接口做实现。
对于不同的日志实现方案(例如Logback,Log4j…),封装出不同的桥接组件(例如logback-classic-version.jar,slf4j-log4j12-version.jar),这样使用过程中可以灵活的选取自己项目里的日志实现。

二、Slf4j与其它日志组件调用关系图

 Slf4j与其它日志组件调用关系图
Slf4j与其它日志组件调用关系图

三、Slf4j与其他各种日志组件的桥接说明

jar包名 说明
slf4j-log4j12-1.7.13.jar Log4j1.2版本的桥接器,你需要将Log4j.jar加入Classpath。
slf4j-jdk14-1.7.13.jar java.util.logging的桥接器,Jdk原生日志框架。
slf4j-nop-1.7.13.jar NOP桥接器,默默丢弃一切日志。
slf4j-simple-1.7.13.jar 一个简单实现的桥接器,该实现输出所有事件到System.err. 只有Info以及高于该级别的消息被打印,在小型应用中它也许是有用的。
slf4j-jcl-1.7.13.jar Jakarta Commons Logging 的桥接器. 这个桥接器将Slf4j所有日志委派给Jcl。
logback-classic-1.0.13.jar(requires logback-core-1.0.13.jar) Slf4j的原生实现,Logback直接实现了Slf4j的接口,因此使用Slf4j与Logback的结合使用也意味更小的内存与计算开销

具体的接入方式参见下图

Slf4j与其他各种日志组件的桥接
Slf4j与其他各种日志组件的桥接

四、slf4j-api-version.jar中几个核心类与接口

类与接口 用途
org.slf4j.LoggerFactory(class) 给调用方提供的创建Logger的工厂类,在编译时绑定具体的日志实现组件
org.slf4j.Logger(interface) 给调用方提供的日志记录抽象方法,例如debug(String msg),info(String msg)等方法
org.slf4j.ILoggerFactory(interface) 获取的Logger的工厂接口,具体的日志组件实现此接口
org.slf4j.helpers.NOPLogger(class) 对org.slf4j.Logger接口的一个没有任何操作的实现,也是Slf4j的默认日志实现
org.slf4j.impl.StaticLoggerBinder(class) 与具体的日志实现组件实现的桥接类,具体的日志实现组件需要定义org.slf4j.impl包,并在org.slf4j.impl包下提供此类,注意在slf4j-api-version.jar中不存在org.slf4j.impl.StaticLoggerBinder,在源码包slf4j-api-version-source.jar中才存在此类

五、Slf4j调用过程

加入slf4j-api-version.jar,与Logback组件
Slf4j作为门面采用Logback作为实现或者采用其它上面提到过的组件作为实现类似,这里只分析采用Logback组件作为实现。

pom核心配置如下

<dependencies>
    <dependency>
      <groupId>org.slf4j</groupId>
      <artifactId>slf4j-api</artifactId>
      <version>1.7.13</version>
    </dependency>
    <!--logback-classic依赖logback-core,会自动级联引入-->
    <dependency>
      <groupId>ch.qos.logback</groupId>
      <artifactId>logback-classic</artifactId>
      <version>1.2.3</version>
    </dependency>
  </dependencies>

六、lf4j调用过程源码分析2

加入slf4j-api-version.jar,同时加入多种日志实现组件
在项目中如果用slf4j-api作为日志门面,有多个日志实现组件同时存在,例如同时存在Logback,slf4j-log4j12,slf4j-jdk14,slf4j-jcl四种实现,则在项目实际运行中,Slf4j的绑定选择绑定方式将有Jvm确定,并且是随机的,这样会和预期不符,实际使用过程中需要避免这种情况。

 <dependencies>
    <dependency>
      <groupId>junit</groupId>
      <artifactId>junit</artifactId>
      <version>4.11</version>
    </dependency>
    <dependency>
      <groupId>org.slf4j</groupId>
      <artifactId>slf4j-log4j12</artifactId>
      <version>1.7.25</version>
    </dependency>
    <dependency>
      <groupId>ch.qos.logback</groupId>
      <artifactId>logback-classic</artifactId>
      <version>1.2.3</version>
    </dependency>
    <dependency>
      <groupId>org.slf4j</groupId>
      <artifactId>slf4j-jdk14</artifactId>
      <version>1.7.25</version>
    </dependency>
    <dependency>
      <groupId>org.slf4j</groupId>
      <artifactId>slf4j-jcl</artifactId>
      <version>1.7.25</version>
    </dependency>
  </dependencies>

七、使用Slf4时如何桥接遗留的api

在实际环境中我们经常会遇到不同的组件使用的日志框架不同的情况,例如Spring Framework使用的是日志组件是Commons Logging,XSocket依赖的则是Java Util Logging。当我们在同一项目中使用不同的组件时应该如果解决不同组件依赖的日志组件不一致的情况呢?现在我们需要统一日志方案,统一使用Slf4j,把他们的日志输出重定向到Slf4j,然后Slf4j又会根据绑定器把日志交给具体的日志实现工具。Slf4j带有几个桥接模块,可以重定向Log4j,JCL和java.util.logging中的Api到Slf4j。

遗留的api桥接方案

jar包名 作用
log4j-over-slf4j-version.jar 将Log4j重定向到Slf4j
jcl-over-slf4j-version.jar 将Commons Logging里的Simple Logger重定向到slf4j
jul-to-slf4j-version.jar 将Java Util Logging重定向到Slf4j

使用Slf4时如何桥接遗留的api
使用Slf4时如何桥接遗留的api

八、使用Slf4j桥接注意事项

在使用Slf4j桥接时要注意避免形成死循环,在项目依赖的jar包中不要存在以下情况。
多个日志jar包形成死循环的条件 产生原因
log4j-over-slf4j.jar和slf4j-log4j12.jar同时存在 由于slf4j-log4j12.jar的存在会将所有日志调用委托给log4j。但由于同时由于log4j-over-slf4j.jar的存在,会将所有对log4j api的调用委托给相应等值的slf4j,所以log4j-over-slf4j.jar和slf4j-log4j12.jar同时存在会形成死循环
jul-to-slf4j.jar和slf4j-jdk14.jar同时存在 由于slf4j-jdk14.jar的存在会将所有日志调用委托给jdk的log。但由于同时jul-to-slf4j.jar的存在,会将所有对jul api的调用委托给相应等值的slf4j,所以jul-to-slf4j.jar和slf4j-jdk14.jar同时存在会形成死循环
遗留api桥接死循环源码分析源码
这里以项目中集成log4j-over-slf4j与slf4j-log4j12为例,其它组合形成死循环原理相类似。