SLF4J的正确打开姿势

2018-11-15 本文已影响0人 Lexus90511

最近公司好几波人过来问日志打印相关的异常，大多是jar包冲突引起的，发现大部分同事不太清楚各种日志框架以及相关jar包之间的关系，所以今天详细的讲解下常见jar包之间的关系，以及如何正确搭配各种jar，使得日志正常打印。

Binding SLF4J To All Kinds Of Logger

我们首先应该清楚，SLF4J是一个日志门面框架，是暴露给应用层的公共接口，她的作用在于我们可以随意修改底层打印日志的具体实现框架，而又不需要改动日志打印相关的代码。

我们首先来看一张SLF4J官网给出的图,如下：

concrete-bindings.png

图中从上到下大致可以分为4层：

应用层：具体调用日志打印接口的使用层，如我们的开发的某个项目。
日志抽象接口层：SLF4J就是这里指的抽象接口层，项目代码中通过LoggerFactory.getLogger()来获取Logger打印日志。

适配层：将SLF4J绑定到具体的底层日志框架，需要注意的是我们的项目依赖只能有一个适配层的jar包，如果存在2个时启动时会报：

Class path contains multiple SLF4J bindings.
Found binding in [具体的适配器A的jar包路径/org/slf4j/impl/StaticLoggerBinder.class]
Found binding in [具体的适配器B的jar包路径/org/slf4j/impl/StaticLoggerBinder.class]

意思是项目中存在多个日志适配器依赖。

然后会报：

Actual binding is of type [适配器A的日志工厂类名]

SLF4j会被绑定到第一个适配器上，即适配器A。

举个栗子：

slf4j-log4j12和logback-classic 先后顺序共存时会报如下冲突日志：

SLF4J: Class path contains multiple SLF4J bindings.
SLF4J: Found binding in [jar:file:/Users/caowei/.m2/repository/org/slf4j/slf4j-log4j12/1.7.25/slf4j-log4j12-1.7.25.jar!/org/slf4j/impl/StaticLoggerBinder.class]
SLF4J: Found binding in [jar:file:/Users/caowei/.m2/repository/ch/qos/logback/logback-classic/1.1.2/logback-classic-1.1.2.jar!/org/slf4j/impl/StaticLoggerBinder.class]
SLF4J: Actual binding is of type [org.slf4j.impl.Log4jLoggerFactory]

顺序是logback-classic在slf4j-log4j12前面时报如下冲突日志：

所以在日志依赖发生冲突的时候可以通过如下:

Class path contains multiple SLF4J bindings

Found binding in

Actual binding

等关键词来判定具体的冲突依赖，然后一一排除。

底层日志实现框架层：实现打印日志的日志框架，例如常见的log4j1、log4j2、jcl和JDK1.4 logging等。

SLF4J绑定到4种Logger所需依赖

Logback

<!-- slf4j -->
<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-api</artifactId>
</dependency>
<!-- Logback具体实现 -->
<dependency>
    <groupId>ch.qos.logback</groupId>
    <artifactId>logback-classic</artifactId>
</dependency>
<dependency>
    <groupId>ch.qos.logback</groupId>
    <artifactId>logback-core</artifactId>
</dependency>

Log4J1

<!-- slf4j -->
<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-api</artifactId>
</dependency>
<!-- Log4J1具体实现 -->
<dependency>
    <groupId>log4j</groupId>
    <artifactId>log4j</artifactId>
</dependency>
<!-- Log4J1适配器 -->
<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-log4j12</artifactId>
</dependency>

log4J2

<!-- slf4j -->
<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-api</artifactId>
</dependency>
<!-- log4J2具体实现 -->
<dependency>
    <groupId>org.apache.logging.log4j</groupId>
    <artifactId>log4j-api</artifactId>
</dependency>
<dependency>
    <groupId>org.apache.logging.log4j</groupId>
    <artifactId>log4j-core</artifactId>
</dependency>
<!-- log4J2适配器 -->
<dependency>
    <groupId>org.apache.logging.log4j</groupId>
    <artifactId>log4j-slf4j-impl</artifactId>
</dependency>

JDK 1.4 logging

<!-- slf4j -->
<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-api</artifactId>
</dependency>
<!-- java.util.logging适配器 -->
<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-jdk14</artifactId>
</dependency>

Bridging Legacy APIs

我们项目中经常会存在一种情况，例如：

我们本身项目使用的底层日志框架是Logback，可以按照我前面列出的Logback依赖来实现日志的打印，但是，假如现在我们应用了一个第三方jar包A.jar，他里面使用的是底层日志框架是Log4j而且还没有通过SLF4J来绑定使用，这时候仅仅依赖Logback相关依赖是无法打印出A.jar中的日志，此时我们的Bridging legacy就出场了。

依然给出SLF4J官网的一个图片：

legacy.png

上图向我们展示了如何兼容第三方依赖中的底层日志框架，通过重定向的jar将底层的日志框架重定向到SLF4J，常用的有：

jcl-over-slf4j — 不能与slf4j-jcl并存

代替jcl依赖。
log4j-over-slf4j — 不能与slf4j-log4j12并存

代替log4j依赖。
jul-to-slf4j — 不能与slf4j-jdk14并存

将java.util.logging 的日志打印接口重定向到slf4j，再通过实际绑定SLF4J的日志框架进行打印。

log4j-to-slf4j — 不能与log4j-slf4j-impl并存

将log4j2的日志打印接口重定向到slf4j，再通过实际绑定SLF4J的日志实现框架打印。

如果我们项目中的第三方依赖使用的底层日志实现是别的日志，就可以通过添加上面这些依赖来进行适配，使其日志可以正常输出。