SLF4J的正确打开姿势

最近公司好几波人过来问日志打印相关的异常,大多是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-log4j12logback-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-classicslf4j-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的日志实现框架打印。

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

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 219,427评论 6 508
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,551评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 165,747评论 0 356
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,939评论 1 295
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,955评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,737评论 1 305
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,448评论 3 420
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,352评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,834评论 1 317
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,992评论 3 338
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,133评论 1 351
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,815评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,477评论 3 331
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 32,022评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,147评论 1 272
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,398评论 3 373
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 45,077评论 2 355

推荐阅读更多精彩内容