一蹈丸、Java日志體系的發(fā)展歷程
Log4j:在JDK 1.3及以前冗栗,Java打日志依賴System.out.println(), System.err.println()或者e.printStackTrace()渔扎,Debug日志被寫到STDOUT流井氢,錯(cuò)誤日志被寫到STDERR流瘪板。這樣打日志有一個(gè)非常大的缺陷捂龄,即無法定制化淑仆,且日志粒度不夠細(xì)涝婉。
于是,Ceki Gülcü 于2001年發(fā)布了Log4j蔗怠,后來成為Apache 基金會(huì)的頂級(jí)項(xiàng)目墩弯。Log4j 在設(shè)計(jì)上非常優(yōu)秀,對(duì)后續(xù)的 Java Log 框架有長(zhǎng)久而深遠(yuǎn)的影響寞射,它定義的Logger渔工、Appender、Level等概念如今已經(jīng)被廣泛使用桥温。Log4j 的短板在于性能引矩,在Logback 和 Log4j2 出來之后,Log4j的使用也減少了侵浸。JUL:Apache要求把log4j并入到JDK旺韭,SUN拒絕,并在jdk1.4版本后增加了JUL(java.util.logging)通惫,但是JUL功能遠(yuǎn)不如log4j完善茂翔,開發(fā)者需要自己編寫Appenders(Sun稱之為Handlers),且只有兩個(gè)Handlers可用(Console和File)履腋,JUL在Java1.5以后性能和可用性才有所提升珊燎。
JCL(commons-logging):由于項(xiàng)目的日志打印必然選擇兩個(gè)框架中至少一個(gè),如果有人想換成其他日志組件遵湖,如log4j換成JUL悔政,因?yàn)閍pi完全不同,就需要改動(dòng)代碼延旧。Apache見此谋国,開發(fā)了JCL(Jakarta Commons Logging)。JCL 是一個(gè)Log Facade迁沫,只提供 Log API芦瘾,不提供實(shí)現(xiàn),然后有 Adapter 來使用 Log4j 或者 JUL 作為L(zhǎng)og Implementation集畅。
在程序中日志創(chuàng)建和記錄都是用JCL中的接口近弟,在真正運(yùn)行時(shí),會(huì)看當(dāng)前ClassPath中有什么實(shí)現(xiàn)挺智,如果有Log4j 就是用 Log4j, 如果啥都沒有就是用 JDK 的 JUL祷愉。
這樣,在你的項(xiàng)目中,還有第三方的項(xiàng)目中二鳄,大家記錄日志都使用 JCL 的接口赴涵,然后最終運(yùn)行程序時(shí),可以按照自己的需求(或者喜好)來選擇使用合適的Log Implementation订讼。如果用Log4j, 就添加 Log4j 的jar包進(jìn)去髓窜,然后寫一個(gè) Log4j 的配置文件;如果喜歡用JUL躯嫉,就只需要寫個(gè) JUL 的配置文件纱烘。如果有其他的新的日志庫出現(xiàn)杨拐,也只需要它提供一個(gè)Adapter祈餐,運(yùn)行的時(shí)候把這個(gè)日志庫的 jar 包加進(jìn)去。
不過哄陶,commons-logging對(duì)Log4j和JUL的配置問題兼容的并不好帆阳,使用commons-loggings還可能會(huì)遇到類加載問題,導(dǎo)致NoClassDefFoundError的錯(cuò)誤出現(xiàn)屋吨。到這個(gè)時(shí)候一切看起來都很簡(jiǎn)單蜒谤,很美好。接口和實(shí)現(xiàn)做了良好的分離至扰,在統(tǒng)一的JCL之下鳍徽,不改變?nèi)魏未a,就可以通過配置就換用功能更強(qiáng)大敢课,或者性能更好的日志庫實(shí)現(xiàn)阶祭。SLF4J & Logback:這樣看上去也挺美好的,但是log4j的作者覺得JCL不好用直秆,自己開發(fā)出SLF4J(Simple Logging Facade for Java)濒募,它跟JCL類似,本身不替供日志具體實(shí)現(xiàn)圾结,只對(duì)外提供接口或門面瑰剃。目的就是為了替代JCL。同時(shí)筝野,還開發(fā)出logback晌姚,一個(gè)比log4j擁有更高性能的組件,目的是為了替代log4j歇竟。
SLF4J 是用來在log和代碼層之間起到門面作用挥唠,類似于 JCL 的 Log Facade。對(duì)于用戶來說只要使用SLF4J提供的接口途蒋,即可隱藏日志的具體實(shí)現(xiàn)猛遍,SLF4J提供的核心API是一些接口和一個(gè)LoggerFactory的工廠類,用戶只需按照它提供的統(tǒng)一紀(jì)錄日志接口,最終日志的格式懊烤、紀(jì)錄級(jí)別梯醒、輸出方式等可通過具體日志系統(tǒng)的配置來實(shí)現(xiàn),因此可以靈活的切換日志系統(tǒng)腌紧。log4j2:Apache參考了logback,并做了一系列優(yōu)化茸习,推出了log4j2
二、Java日志框架的關(guān)系和依賴
1壁肋、依賴關(guān)系
JCL支持日志組件不多(spring默認(rèn)使用JCL輸入日志)号胚,所以基本上沒太多人用,現(xiàn)在主要以slf4j體系為主
以上兩張圖的意思是如果你想用slf4j作為日志門面的話浸遗,你如何去配合使用其他日志實(shí)現(xiàn)組件猫胁,這里說明一下(注意jar包名缺少了版本號(hào),在找版本時(shí)也要注意版本之間是否兼容)
除了slf4j本身需要引入的slf4j-api.jar之外跛锌,其它還需要:
- slf4j+logback: logback-classic.jar弃秆、 logback-core.jar
- slf4j+log4j: slf44j-log4j12.jar、 log4j.jar
- slf4j+jul: slf4j-jdk14.jar
- slf4j+log4j2: log4j-slf4j-impl.jar髓帽、log4j-api.jar菠赚、log4j-core.jar
2、JCL橋接到slf4j
對(duì)于新項(xiàng)目來說郑藏,一般會(huì)使用logback+slf4j日志框架衡查。那對(duì)于依賴的第三方(如spring框架)使用了log4j或者jul的怎么辦,如何統(tǒng)一輸出必盖?答案是橋接器拌牲。
比如:本項(xiàng)目使用的日志框架依賴是logback+slf4j日志框架
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-api</artifactId>
<version>1.7.21</version>
</dependency>
<dependency>
<groupId>ch.qos.logback</groupId>
<artifactId>logback-classic</artifactId>
<version>1.1.7</version>
</dependency>
<dependency>
<groupId>ch.qos.logback</groupId>
<artifactId>logback-core</artifactId>
<version>1.1.7</version>
</dependency>
可以添加如下的橋接器(將jul和log4j重定向到slf4j)
<!-- https://mvnrepository.com/artifact/org.slf4j/jcl-over-slf4j -->
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>jcl-over-slf4j</artifactId>
<version>1.7.25</version>
</dependency>
<!-- https://mvnrepository.com/artifact/org.slf4j/log4j-over-slf4j -->
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>log4j-over-slf4j</artifactId>
<version>1.7.25</version>
</dependency>
具體的思路:
1、確定日志Facade筑悴,一般就是slf4j
2们拙、確定日志實(shí)現(xiàn)框架,不同的日志框架針對(duì)slf4j都提供綁定器阁吝,也就是說slf4j可以配合大部分日志實(shí)現(xiàn)使用
- slf4j-jdk14:slf4j到j(luò)dk-logging的橋梁
- slf4j-log4j12:slf4j到log4j1的橋梁
- log4j-slf4j-impl:slf4j到log4j2的橋梁這是apache實(shí)現(xiàn)砚婆,依賴的log4j版本較新。slf4j-log4j12這是slf4j中實(shí)現(xiàn)突勇,依賴的log4j版本較低装盯。實(shí)驗(yàn)可以互相替代,但是注意配置文件的不同甲馋。
- logback-classic:slf4j到logback的橋梁
- slf4j-jcl:slf4j到commons-logging的橋梁
3埂奈、管理依賴項(xiàng)目中的日志框架,攔截且重定向到slf4j中
- jul-to-slf4j:jdk-logging到slf4j的橋梁
- log4j-over-slf4j:log4j1到slf4j的橋梁
- jcl-over-slf4j:commons-logging到slf4j的橋梁
3定躏、循環(huán)引用問題
想象這樣一種情況账磺,通過橋接器將log4j的日志全部重定向到slf4j芹敌,然后slf4j又再次綁定到了log4j實(shí)現(xiàn),死循環(huán)了垮抗。
三氏捞、Java日志框架各個(gè)jar包作用總結(jié)
1、各個(gè)jar包的總結(jié)
-
log4j1
- log4j:log4j1的全部?jī)?nèi)容
-
log4j2
- log4j-api:log4j2定義的API
- log4j-core:log4j2上述API的實(shí)現(xiàn)
-
logback
- logback-core:logback的核心包
- logback-classic:logback實(shí)現(xiàn)了slf4j的API
-
commons-logging
- commons-logging:commons-logging的原生全部?jī)?nèi)容
- log4j-jcl:commons-logging到log4j2的橋梁
- jcl-over-slf4j:commons-logging到slf4j的橋梁
-
slf4j轉(zhuǎn)向某個(gè)實(shí)際的日志框架 (如:使用slf4j的API進(jìn)行編程冒版,底層想使用log4j1來進(jìn)行實(shí)際的日志輸出液茎,這就是slf4j-log4j12干的事。)
- slf4j-jdk14:slf4j到j(luò)dk-logging的橋梁
- slf4j-log4j12:slf4j到log4j1的橋梁
- log4j-slf4j-impl:slf4j到log4j2的橋梁
- logback-classic:slf4j到logback的橋梁
- slf4j-jcl:slf4j到commons-logging的橋梁
-
某個(gè)實(shí)際的日志框架轉(zhuǎn)向slf4j(如使用log4j1的API進(jìn)行編程辞嗡,但是想最終通過logback來進(jìn)行輸出捆等,所以就需要先將log4j1的日志輸出轉(zhuǎn)交給slf4j來輸出,slf4j再交給logback來輸出续室。將log4j1的輸出轉(zhuǎn)給slf4j栋烤,這就是log4j-over-slf4j做的事)
- jul-to-slf4j:jdk-logging到slf4j的橋梁
- log4j-over-slf4j:log4j1到slf4j的橋梁
- jcl-over-slf4j:commons-logging到slf4j的橋梁
2、集成總結(jié)
commons-logging與其他日志框架集成
- commons-logging與jdk-logging集成猎贴,需要的jar包:
- commons-logging
- commons-logging與log4j1集成班缎,需要的jar包:
- commons-logging
- log4j
- commons-logging與log4j2集成蝴光,需要的jar包:
- commons-logging
- log4j-api
- log4j-core
- log4j-jcl(集成包)
- commons-logging與logback她渴,需要的jar包:
- logback-core
- logback-classic
- slf4j-api、jcl-over-slf4j(2個(gè)集成包,可以不再需要commons-logging)
- commons-logging與slf4j集成,需要的jar包:
- jcl-over-slf4j(集成包蔑祟,不再需要commons-logging)
- slf4j-api
slf4j與其他日志框架集成
- slf4j與jdk-logging集成,需要的jar包:
- slf4j-api
- slf4j-jdk14(集成包)
- slf4j與log4j1集成趁耗,需要的jar包:
- slf4j-api
- log4j
- slf4j-log4j12(集成包)
- slf4j與log4j2集成,需要的jar包:
- slf4j-api
- log4j-api
- log4j-core
- log4j-slf4j-impl(集成包)
- slf4j與logback集成疆虚,需要的jar包:
- slf4j-api
- logback-core
- logback-classic(集成包)
slf4j與commons-logging集成苛败,需要的jar包: - slf4j-api
- commons-logging
- slf4j-jcl(集成包)
四、Java日志框架最佳實(shí)踐
1径簿、最佳實(shí)踐建議:
- 總是使用 Log Facade罢屈,而不是具體的 Log Implementation
- 只添加一個(gè) Log Implementation 依賴
- 具體的日志依賴應(yīng)該設(shè)置為 optional,并使用 runtime scope
設(shè)為optional篇亭,依賴不會(huì)傳遞缠捌,這樣如果你是個(gè)lib項(xiàng)目,然后別的項(xiàng)目使用了你這個(gè)lib译蒂,不會(huì)被引入不想要的Log Implementation 依賴曼月;
Scope設(shè)置為runtime,是為了防止開發(fā)人員在項(xiàng)目中直接使用Log Implementation中的類柔昼,而不使用Log Facade中的類哑芹。 - 如果有必要, 排除依賴的第三方庫中的Log Impementation依賴
這是很常見的一個(gè)問題,第三方庫的開發(fā)者未必會(huì)把具體的日志實(shí)現(xiàn)或者橋接器的依賴設(shè)置為optional捕透,然后你的項(xiàng)目繼承了這些依賴——具體的日志實(shí)現(xiàn)未必是你想使用的聪姿,比如他依賴了Log4j碴萧,你想使用Logback,這時(shí)就很尷尬末购。另外勿决,如果不同的第三方依賴使用了不同的橋接器和Log實(shí)現(xiàn),也極容易形成環(huán)招盲。
這種情況下低缩,推薦的處理方法,是使用exclude來排除所有的這些Log實(shí)現(xiàn)和橋接器的依賴曹货,只保留第三方庫里面對(duì)Log Facade的依賴咆繁。
2、阿里Java日志規(guī)范
【強(qiáng)制】應(yīng)用中不可直接使用日志系統(tǒng)(Log4j顶籽、Logback)中的 API玩般,而應(yīng)依賴使用日志框架
SLF4J 中的 API,使用門面模式的日志框架礼饱,有利于維護(hù)和各個(gè)類的日志處理方式統(tǒng)一坏为。
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
private static final Logger logger = LoggerFactory.getLogger(Abc.class);