可能是全網(wǎng)最全的 Java 日志框架適配、沖突解決方案

前言

你是否遇到過配置了日志，但打印不出來的情況？

你是否遇到過配置了logback，啟動(dòng)時(shí)卻提示log4j錯(cuò)誤的情況？像下面這樣：

你是否遇到過SLF4J的這種報(bào)錯(cuò)？

你是否遇到過DUBBO日志打印不正常的情況？

你是否遇到過Mybatis SQL日志打印不出來的情況？

你是否遇到過JPA/Hibernate SQL日志無法打印的情況？

你是否遇到過復(fù)雜項(xiàng)目中，很多框架內(nèi)部日志無法打印的情況？

你是否遇到過Tomcat工程，日志文件打印了多份，catalina.out和其他文件？

你是否遇到過SpringBoot項(xiàng)目，日志文件打印了多份的問題？

你是否遇到過各種日志配置問題……

日志框架的沖突

上面的這些問題，基本都是由于多套日志框架共存或配置錯(cuò)誤導(dǎo)致的。那么為什么會(huì)出現(xiàn)共存或者沖突呢？

一般是以下幾種原因：

• 項(xiàng)目手動(dòng)引用了各種日志框架的包 - 比如同時(shí)引用了log4j/log4j2/logback/jboss-logging/jcl等

• 包管理工具的傳遞依賴（Transitive Dependencies）導(dǎo)致，比如依賴了dubbo，但是dubbo依賴了zkclient，可zkclient又依賴了log4j，此時(shí)如果你的項(xiàng)目中還有其他日志框架存在并有使用，那么就會(huì)導(dǎo)致多套共存

• 同一個(gè)日志框架多版本共存

JAVA里的各種日志框架

在正式介紹沖突和解決之前，需要先簡單的說一下Java中的各種日志框架：

Java 中的日志框架分為兩種，分別為日志抽象/門面，日志實(shí)現(xiàn)

日志抽象/門面

日志抽象/門面，他們不負(fù)責(zé)具體的日志打印，如輸出到文件、配置日志內(nèi)容格式等。他們只是一套日志抽象，定義了一套統(tǒng)一的日志打印標(biāo)準(zhǔn)，如Logger對(duì)象，Level對(duì)象。

slf4j（Simple Logging Facade for Java）和jcl（Apache Commons Logging）這兩個(gè)日志框架就是JAVA中最主流的日志抽象了。還有一個(gè)jboss-logging，主要用于jboss系列軟件，比如hibernate之類。

像 jcl已經(jīng)多年不更新了（上一次更新時(shí)間還是14年），目前最推薦的是使用 slf4j

日志實(shí)現(xiàn)

Java 中的日志實(shí)現(xiàn)框架，主流的有以下幾種：

• log4j - Apache（老牌日志框架，不過多年不更新了，新版本為log4j2）

• log4j2 - Apache（log4j 的新版本，目前異步IO性能最強(qiáng)，配置也較簡單）

• logback - QOS（slf4j就是這家公司的產(chǎn)品）

• jul（java.util.logging） - jdk內(nèi)置

在程序中，可以直接使用日志框架，也可以使用日志抽象+日志實(shí)現(xiàn)搭配的方案。不過一般都是用日志抽象+日志實(shí)現(xiàn)，這樣更靈活，適配起來更簡單。

目前最主流的方案是slf4j+logback/log4j2，不過如果是jboss系列的產(chǎn)品，可能用的更多的還是jboss-logging，畢竟親兒子嘛。像JPA/Hibernate這種框架里，內(nèi)置的就是jboss-logging

SpringBoot + Dubbo 日志框架沖突的例子

舉個(gè)例子來說個(gè)最常見的傳遞依賴導(dǎo)致的共存沖突：

比如我有一個(gè)“干凈的”spring-boot項(xiàng)目，干凈到只有一個(gè)spring-boot-starter依賴，此時(shí)我想集成dubbo，使用zookeeper作為注冊(cè)中心，此時(shí)我的依賴配置是這樣：

現(xiàn)在啟動(dòng)這個(gè)spring-boot項(xiàng)目，會(huì)發(fā)現(xiàn)一堆紅色錯(cuò)誤：

從錯(cuò)誤提示上看，錯(cuò)誤內(nèi)容分為兩個(gè)部分：

• slf4j報(bào)錯(cuò)，提示找到多個(gè)slf4j的日志綁定

• log4j報(bào)錯(cuò)，提示log4j沒有appender配置

出現(xiàn)這個(gè)錯(cuò)誤，就是因?yàn)閐ubbo的傳遞依賴中含有l(wèi)og4j，但是spring-boot的默認(rèn)配置是slf4j+logback。在依賴了dubbo相關(guān)包之后，現(xiàn)在項(xiàng)目中同時(shí)存在logback/jcl(apache commons-logging)/log4j/jul-to-slf4j/slf4j-log4j/log4j-to-slf4j

來看一下依賴圖：

這個(gè)時(shí)候就亂套了，slf4j-log4j是log4j的slf4j實(shí)現(xiàn)，作用是調(diào)用slf4j api的時(shí)候使用log4j輸出；而log4j-to-slf4j的作用是將log4j的實(shí)現(xiàn)替換為log4j，這樣一來不是死循環(huán)了

而且還有l(wèi)ogback的存在，logback默認(rèn)實(shí)現(xiàn)了slf4j的抽象，而slf4j-log4j也是一樣實(shí)現(xiàn)了slf4j的抽象，logback，項(xiàng)目里共存了兩套slf4j的實(shí)現(xiàn)，那么在使用slf4j接口打印的時(shí)候會(huì)使用哪個(gè)實(shí)現(xiàn)呢？

答案是“第一個(gè)”，也就是第一個(gè)被加載的Slf4j的實(shí)現(xiàn)類，但這種依靠ClassLoader加載順序來保證的日志配置順序是非常不靠譜的

如果想正常使用日志，讓這個(gè)項(xiàng)目里所有的框架都正常打印日志，必須將日志框架統(tǒng)一。不過這里的統(tǒng)一并不是至強(qiáng)行修改，而是用“適配/中轉(zhuǎn)”的方式。

現(xiàn)在項(xiàng)目里雖然有slf4j-log4j的配置，但這個(gè)配置是適配log4j2用的，而我們的依賴了只有l(wèi)og4j1，實(shí)際上這個(gè)中轉(zhuǎn)是無效的。但logback是有效的，而且是spring-boot項(xiàng)目的默認(rèn)配置，這次就選擇logback作為項(xiàng)目的統(tǒng)一日志框架吧。

現(xiàn)在項(xiàng)目里存在log4j(1)的包，而且啟動(dòng)時(shí)又報(bào)log4j的錯(cuò)誤，說明某些代碼調(diào)用了log4j的api。但我們又不想用log4j，所以需要先解決log4j的問題。

由于有l(wèi)og4j代碼的引用，所以直接刪除log4j一定是不可行的。slf4j提供了一個(gè)log4j-over-slf4j的包，這個(gè)包復(fù)制了一份log4j1的接口類（Logger等），同時(shí)將實(shí)現(xiàn)類修改為slf4j了。

所以將log4j的（傳遞）依賴排除，同時(shí)引用log4j-over-slf4j，就解決了這個(gè)log4j的問題?，F(xiàn)在來修改下pom中的依賴（查看依賴圖可以使用maven的命令，或者是IDEA自帶的Maven Dependencies Diagram，再或者M(jìn)aven Helper之類的插件）

解決了log4j的問題之后，現(xiàn)在還有slf4j有兩個(gè)實(shí)現(xiàn)的問題，這個(gè)問題處理就更簡單了。由于我們計(jì)劃使用logback，那么只需要排除/刪除slf4j-log4j這個(gè)實(shí)現(xiàn)的依賴即可

修改完成，再次啟動(dòng)就沒有錯(cuò)誤了，輕松解決問題

日志適配大全

上面只是介紹了一種轉(zhuǎn)換的方式，但這么多日志框架，他們之間是可以互相轉(zhuǎn)換的。不過最終目的都是統(tǒng)一一套日志框架，讓最終的日志實(shí)現(xiàn)只有一套

這么多的日志適配/轉(zhuǎn)換方式，全記住肯定是有點(diǎn)難。為此我畫了一張可能是全網(wǎng)最全的日志框架適配圖（原圖尺寸較大，請(qǐng)點(diǎn)擊放大查看），如果再遇到?jīng)_突，需要將一個(gè)日志框架轉(zhuǎn)換到另一款的時(shí)候，只需要按照?qǐng)D上的路徑，引入相關(guān)的依賴包即可。

比如想把slf4j，適配/轉(zhuǎn)換到log4j2。按照?qǐng)D上的路徑，只需要引用log4j-slf4j-impl即可。

如果想把jcl，適配/轉(zhuǎn)換到slf4j，只需要?jiǎng)h除jcl包，然后引用jcl-over-slf4j即可。

圖上的箭頭，有些標(biāo)了文字的，是需要額外包進(jìn)行轉(zhuǎn)換的，有些沒有標(biāo)文字的，是內(nèi)置了適配的實(shí)現(xiàn)。其實(shí)內(nèi)置實(shí)現(xiàn)的這種會(huì)更麻煩，因?yàn)槿绻龅焦泊婊径夹枰ㄟ^配置環(huán)境變量/配置額外屬性的方式來指定一款日志實(shí)現(xiàn)。

目前slf4j是適配方案中，最核心的那個(gè)框架，算是這個(gè)圖的中心樞紐。只要圍繞slf4j做適配/轉(zhuǎn)化，就沒有處理不了的沖突

總結(jié)

解決日志框架共存/沖突問題其實(shí)很簡單，只要遵循幾個(gè)原則：

• 統(tǒng)一使用一套日志實(shí)現(xiàn)

• 刪除多余的無用日志依賴

• 如果有引用必須共存的話，那么就移除原始包，使用“over”類型的包（over類型的包復(fù)制了一份原始接口，重新實(shí)現(xiàn)）

• 不能over的，使用日志抽象提供的指定方式，例如jboss-logging中，可以通過org.jboss.logging.provider環(huán)境變量指定一個(gè)具體的日志框架實(shí)現(xiàn)

項(xiàng)目里統(tǒng)一了日志框架之后，無論用那種日志框架打印，最終還是走向我們中轉(zhuǎn)/適配后的唯一一個(gè)日志框架。

解決了共存/沖突之后，項(xiàng)目里就只剩一款日志框架。再也不會(huì)出現(xiàn)“日志打不出”，“日志配置不生效”之類的各種惡心問題，下班都能早點(diǎn)了！