Java日志通关(二) - Slf4j+Logback 整合及排包
阿里妹导读
一、为什么是 Slf4j+Logback
Slf4j的API相比JCL更丰富,且得到Intellij IDEA编辑器的完整支持。这是核心优势,我们会在《Java日志通关(三) - Slf4介绍》中详细讲解;
Slf4j支持日志内容惰性求值,相比JCL性能更好(性能其实也没差多少[1],但码农总是追求极致);
在前边选定Slf4j的前提下,同一厂牌且表现优异的Logback自然中标(并无暗箱操作,举贤不避亲);
Slf4j+Logback 是目前大部分开发者的选择(2021年Slf4j 76%、Logback 48%[2]),万一遇到问题参考文档会多一些;
二、基础依赖项
Slf4j是基本的日志门面,它的核心API在
org.slf4j:slf4j-api
中;Logback的核心实现层在
ch.qos.logback:logback-core
中;Logback针对Slf4j的适配层在
ch.qos.logback:logback-classic
中;
2.1 Slf4j 版本兼容性
org.slf4j.impl.StaticLoggerBinder
,而是改用JDK ServiceLoader[4](也就是SPI,Service Provider Interface) 的方式来加载实现。这是JDK 8中的特性,所以Slf4j对JDK的依赖显而易见:其中,Slf4j在发布了几个1.8 alpha/beta版后,直接跳到了2.0,所以1.8不在我们的讨论范围内了。
2.2 Logback 版本兼容性
其中logback 1.3.x和1.4.x是并行维护版本,每次更新都会同时发布
1.3.n
和1.4.n
,用户需要根据项目的JDK版本进行选择。不过目前Logback已经全面升级1.5.x,且1.3.x和1.4.x不再维护[6],更详细的信息可以参考官网的更新文档[7]。2.3 总结
如果使用JDK 8,建议选择Slf4j 2.0 + Logback 1.3;
如果使用JDK 11及以上,建议选择Slf4j 2.0 + Logback 1.5;
三、适配 Spring Boot
org.springframework.boot.logging.LoggingSystem[10]
查找日志接口并自动适配,所以我们使用Spring Boot时一般并不需要关心日志依赖,只管使用即可。但因为Slf4j 2.0.x与Slf4j 1.7.x实现不一致,导致Spring Boot也会挑版本:根据这个表格,以及前一节总结的版本兼容关系,最终可以得到以下结论:
如果使用Spring Boot 2及以下,建议选择Slf4j 1.7.x + Logback 1.2.x;
如果使用Spring Boot 3,建议选择Slf4j 2.0.x + Logback 1.4.x(本篇发表时 Spring官方还没做好Logback 1.5.x的适配);
四、桥接其他实现层
通过
org.slf4j:jcl-over-slf4j
将JCL桥接到Slf4j 上;通过
org.slf4j:log4j-over-slf4j
将Log4j桥接到Slf4j 上;通过
org.slf4j:jul-to-slf4j
将JUL桥接到Slf4j上;通过
org.apache.logging.log4j:log4j-to-slf4j
将Log4j 2桥接到Slf4j上;
org.slf4j
的包版本要完全一致,所以如果引入这些桥接包,要保证它们的版本与前边选择的slf4j-api版本对应。为此Slf4j从2.0.8开始提供了bom包,省去了维护每个包版本的烦恼(至于低版本就只能人肉保证版本一致性了):<dependencyManagement>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-bom</artifactId>
<version>2.0.9</version>
<type>pom</type>
</dependency>
</dependencyManagement>
让我比较意外的是log4j-to-slf4j
这个包,它很「健壮」,对Slf4j 1和Slf4j 2都能够支持,棒棒的。
五、去除无用依赖
排掉JCL: commons-logging:commons-logging
排掉Log4j: log4j:log4j
排掉Log4j 2:
org.apache.logging.log4j:log4j-core
5.1 Gradle 统一排包方案
all*.exclude[13]
全局排除对应的包。5.2 Maven 统一排包方案
方案一:将要排掉的包通过引入一个占位的空包(版本号一般比较特殊,比如
999-not-exist
),从而达到排包的目的。但这种特殊版本的空包一般在Mvnrepository Central仓库是没有的(各厂的私有仓库一般会有这种包),你可以自己搭建私有仓库并上传这个版本,或者使用Version 99 Does Not Exist [16]也行。这是最完美的方案,无论本地运行还是远程编译都不会有问题。方案二:将需要排掉的包使用
<scope>provided</scope>
标识,这样这个包在编译时会被跳过,从而达到排包的目的,但此包在本地运行时仍会被引入,导致本地运行与远程机器环境差异,不利于调试。方案三:使用maven-enforcer-plugin[17]插件标识哪些包是要被排掉的,它只是一个校验,实际上你仍然需要在每个引入了错误包的依赖中进行排除。
六、最终依赖
6.1 JDK 8/11 + Spring Boot 1.5/2
基础
org.slf4j:slf4j-api:1.7.36
ch.qos.logback:logback-core:1.2.13
ch.qos.logback:logback-classic:1.2.13
桥接包
org.slf4j:jcl-over-slf4j:1.7.36
org.slf4j:log4j-over-slf4j:1.7.36
org.slf4j:jul-to-slf4j:1.7.36
org.apache.logging.log4j:log4j-to-slf4j:2.23.1
排包
commons-logging:commons-logging:99.0-does-not-exist
log4j:log4j:99.0-does-not-exist
org.apache.logging.log4j:log4j-core:99.0-does-not-exist
6.2 JDK 17/21 + Spring Boot 3
基础
org.slf4j:slf4j-bom:2.0.12
通过 BOM 包统一管理依赖ch.qos.logback:logback-core:1.4.14
ch.qos.logback:logback-classic:1.4.14
桥接包
org.slf4j:jcl-over-slf4j
参考【七、注意事项】org.slf4j:log4j-over-slf4j
参考【七、注意事项】org.slf4j:jul-to-slf4j
参考【七、注意事项】org.apache.logging.log4j:log4j-to-slf4j:2.23.1
排包
commons-logging:commons-logging:99.0-does-not-exist
log4j:log4j:99.0-does-not-exist
org.apache.logging.log4j:log4j-core:99.0-does-not-exist
七、注意事项
引入期望的包,并指定版本; 排除一些包(指定空版本);
<dependencyManagement>
中完成的,但这只是管理包版本,在项目没有实际引用之前,并不会真的加载。有一个模块A,依赖Log4j打印日志,所以它依赖了
log4j:log4j
包;我们在父POM中把
log4j:log4j
排掉了,此时模块A调用Log4j时会报错;我们在父POM中引入
log4j-over-slf4j
,目标是把Log4j切到Slf4j,让模块A不报错;
log4j:WARN No appenders could be found for logger (xxx.xxx.xxx)
。这是因为log4j-over-slf4j
并没有真的被引入我们的项目中(很少有哪个二方包会引这种东西,会被骂的)。log4j-over-slf4j
通过<dependencies>
引入即可,在父POM做这个事也行,在实际有依赖的子POM也行。八、常见问题
SLF4J warning or error messages and their meanings[18]
Frequently Asked Questions about SLF4J[19]
Bridging legacy APIs[20]
Logback error messages and their meanings[21]
Frequently Asked Questions (Logback)[22]
Q1: LoggerFactory is not a Logback LoggerContext but Logback is on the classpath. Either remove Logback or the competing implementation
logback-classic
和slf4j-log4j12
冲突,根据你使用的是Logback还是Log4j 2,把另一个排掉。LoggingSystem
获取当前有效的日志系统(参考【三、适配Spring Boot】),默认支持Slf4j、Logback、Log4j 2、JUL:slf4j-log4j12
)都有名为StaticLoggerBinder
的实现,如果命中的不是Logback实现,就会报这个错。Q2: java.lang.NoClassDefFoundError: org/slf4j/impl/StaticLoggerBinder
Q3:java.lang.ClassNotFoundException: org.slf4j.impl.StaticLoggerBinder
Q4:java.lang.ClassCastException:org.apache.logging.slf4j.SLF4JLoggerContext cannot be cast to org.apache.logging.log4j.core.LoggerContext
Q5:java.lang.ClassCastException:org.slf4j.impl.Log4jLoggerFactory cannot be cast to ch.qos.logback.classic.LoggerContext
logback-classic
和 slf4j-log4j12
。原因和解法都与 Q4 类似。Q6: SLF4J: No SLF4J providers were found.
slf4j-api
接口,没有适配层。一般添加 logback-classic
或者 slf4j-log4j12
即可解决。Q7: SLF4J: Failed to load class "org.slf4j.impl.StaticLoggerBinder".
slf4j-api
接口,没有适配层。一般添加 logback-classic
或者 slf4j-log4j12
即可解决。logback-classic
,明明项目启动正常,明明日志输出正常,但还可能会报这个错,我还没查到原因,期待高手解惑。Q8: SLF4J: Class path contains multiple SLF4J bindings.
Q9: log4j:WARN No appenders could be found for logger (xxx.xxx.xxx)
log4j-over-slf4j
引到项目中可以解决。具体原因请参考【2.7 注意事项】节。Q10:java.lang.UnsupportedClassVersionError:ch/qos/logback/classic/spi/LogbackServiceProvider has been compiled by a more recent version of the Java Runtime (class file version 55.0), this version of the Java Runtime only recognizes class file versions up to 52.0
Q11: Failed to load class org.slf4j.impl.StaticLoggerBinder
[1]https://juejin.cn/post/6915015034565951501
[2]https://logging.apache.org/log4j/2.x/manual/extending.html
[3]https://www.slf4j.org/faq.html#changesInVersion200
[4]https://docs.oracle.com/javase/8/docs/api/java/util/ServiceLoader.html
[5]https://github.com/qos-ch/slf4j/discussions/379
[6]https://logback.qos.ch/download.html
[7]https://logback.qos.ch/news.html
[8]https://docs.spring.io/spring-boot/docs/current/reference/html/features.html#features.logging
[9]https://mvnrepository.com/artifact/org.springframework.boot/spring-boot-starter-logging
[10]https://docs.spring.io/spring-boot/docs/current/api/org/springframework/boot/logging/LoggingSystem.html
[11]https://github.com/spring-projects/spring-boot/issues/12649
[12]https://github.com/spring-projects/spring-boot/issues/12649#issuecomment-1569448932
[13]https://stackoverflow.com/questions/55441430/what-does-this-all-exclude-means-in-gradle-transitive-dependency
[14]https://issues.apache.org/jira/browse/MNG-1977
[15]https://stackoverflow.com/questions/4716310/is-there-a-way-to-exclude-a-maven-dependency-globally
[16]https://github.com/erikvanoosten/version99
[17]https://maven.apache.org/enforcer/maven-enforcer-plugin/
[18]https://www.slf4j.org/codes.html
[19]https://www.slf4j.org/faq.html
[20]https://www.slf4j.org/legacy.html
[21]https://logback.qos.ch/codes.html
点击查看《Java日志通关(一) - 前世今生》
微信扫码关注该文公众号作者