天天看點

架構師必備,帶你弄清混亂的JAVA日志體系!

引言

還在為弄不清​

​commons-logging-xx.jar​

​、​

​log4j-xx.jar​

​sl4j-api-xx.jar​

​等日志架構之間複雜的關系而感到煩惱嗎?

還在為如何統一系統的日志輸出而感到不知所措嘛?

您是否依然存在這樣的煩惱。比如,要更改spring的日志輸出為log4j 2,卻不知該引哪些jar包,隻知道去百度一下所謂的部落格,照着人家複制,卻無法弄懂其中的原理?

不要急,不要方!本文帶你們弄懂其中的原理,隻要你靜下心看本文,你就能随心所欲更改你系統裡的日志架構,統一日志輸出!

正文

日志架構發展史

早年,你工作的時候,在日志裡使用了log4j架構來輸出,于是你代碼是這麼寫的

import org.apache.log4j.Logger;
\\省略
Logger logger = Logger.getLogger(Test.class);
logger.trace("trace");
\\省略      

但是,歲月流逝,sun公司對于log4j的出現内心隐隐表示嫉妒。于是在jdk1.4版本後,增加了一個包為java.util.logging,簡稱為jul,用以對抗log4j。于是,你的上司要你把日志架構改為jul,這時候你隻能一行行的将log4j的api改為jul的api,如下所示

import java.util.logging.Logger;
\\省略
Logger loggger = Logger.getLogger(Test.class.getName()); 
logger.finest("finest");
\\省略      

可以看出,api完全是不同的。那有沒有辦法,将這些api抽象出接口,這樣以後調用的時候,就調用這些接口就好了呢?

這個時候jcl(Jakarta Commons Logging)出現了,說jcl可能大家有點陌生,講​

​commons-logging-xx.jar​

​元件,大家總有印象吧。JCL 隻提供 log 接口,具體的實作則在運作時動态尋找。這樣一來元件開發者隻需要針對 JCL 接口開發,而調用元件的應用程式則可以在運作時搭配自己喜好的日志實踐工具。JCL可以實作的內建方案如下圖所示

架構師必備,帶你弄清混亂的JAVA日志體系!

jcl預設的配置:如果能找到Log4j 則預設使用log4j 實作,如果沒有則使用jul(jdk自帶的) 實作,再沒有則使用jcl内部提供的SimpleLog 實作。

于是,你在代碼裡變成這麼寫了

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
\\省略
Log log =LogFactory.getLog(Test.class);
log.trace('trace');
\\省略      

至于這個Log具體的實作類,JCL會在ClassLoader中進行查找。這麼做,有三個缺點,缺點一是效率較低,二是容易引發混亂,三是在使用了自定義ClassLoader的程式中,使用JCL會引發記憶體洩露。

于是log4j的作者覺得jcl不好用,自己又寫了一個新的接口api,那麼就是slf4j。關于slf4j的內建圖如下所示

架構師必備,帶你弄清混亂的JAVA日志體系!

如圖所示,應用調了sl4j-api,即日志門面接口。日志門面接口本身通常并沒有實際的日志輸出能力,它底層還是需要去調用具體的日志架構API的,也就是實際上它需要跟具體的日志架構結合使用。由于具體日志架構比較多,而且互相也大都不相容,日志門面接口要想實作與任意日志架構結合可能需要對應的橋接器,上圖紅框中的元件即是對應的各種橋接器!

我們在代碼中需要寫日志,變成下面這麼寫

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
//省略
Logger logger = LoggerFactory.getLogger(Test.class);
// 省略
logger.info("info");      

在代碼中,并不會出現具體日志架構的api。程式根據classpath中的橋接器類型,和日志架構類型,判斷出logger.info應該以什麼架構輸出!注意了,如果classpath中不小心引了兩個橋接器,那會直接報錯的!

是以,在阿裡的開發手冊上才有這麼一條

強制:應用中不可直接使用日志系統(log4j、logback)中的 API ,而應依賴使用日志架構 SLF4J 中的 API 。使用門面模式的日志架構,有利于維護和各個類的日志處理方式的統一。

ok,至此,基礎知識完畢,下面是實戰!

項目實戰

案例一

一個項目,一個子產品用log4j,另一個子產品用slf4j+log4j2,如何統一輸出?

其實在某些中小型公司,這種情況很常見。我曾經見過某公司的項目,因為研發不懂底層的日志原理,日志檔案裡頭既有log4j.properties,又有log4j2.xml,各種API混用,慘不忍睹!

還有人用着jul的API,然後拿着log4j.properties,跑來問我,為什麼配置不生效!簡直是一言難盡!

OK,回到我們的問題,如何統一輸出!OK,這裡就要用上slf4j的擴充卡,slf4j提供了各種各樣的擴充卡,用來将某種日志架構委托給slf4j。其最明顯的內建工作方式有如下:

架構師必備,帶你弄清混亂的JAVA日志體系!

進行選擇填空,将我們的案例裡的條件填入,顯然應該選log4j-over-slf4j擴充卡,就變成下面這張圖

架構師必備,帶你弄清混亂的JAVA日志體系!

就可以實作日志統一為log4j2來輸出!

​ps​

​:根據擴充卡工作原理的不同,被适配的日志架構并不是一定要删除!以上圖為例,log4j這個日志架構删不删都可以,你隻要能保證log4j的加載順序在log4j-over-slf4j後即可。因為log4j-over-slf4j這個擴充卡的工作原理是,内部提供了和log4j一模一樣的api接口,是以你在程式中調用log4j的api的時候,你必須想辦法讓其走擴充卡的api。如果你删了log4j這個架構,那你程式裡肯定是走log4j-over-slf4j這個元件裡的api。如果不删log4j,隻要保證其在classpth裡的順序比log4j前即可!

案例二

如何讓spring以log4j2的形式輸出?

spring預設使用的是jcl輸出日志,由于你此時并沒有引入Log4j的日志架構,jcl會以jul做為日志架構。此時內建圖如下

架構師必備,帶你弄清混亂的JAVA日志體系!

而你的應用中,采用了slf4j+log4j-core,即log4j2進行日志記錄,那麼此時內建圖如下

架構師必備,帶你弄清混亂的JAVA日志體系!

那我們現在需要讓spring以log4j2的形式輸出?怎麼辦?

OK,第一種方案,走jcl-over-slf4j擴充卡,此時內建圖就變成下面這樣了

架構師必備,帶你弄清混亂的JAVA日志體系!

在這種方案下,spring架構中遇到日志輸出的語句,就會如上圖紅線流程一樣,最終以log4J2的形式輸出!

OK,有第二種方案麼?

有,走jul-to-slf4j擴充卡,此時內建圖如下

架構師必備,帶你弄清混亂的JAVA日志體系!

​ps​

​:這種情況下,記得在代碼中執行

SLF4JBridgeHandler.removeHandlersForRootLogger();
SLF4JBridgeHandler.install();      

這樣jul-to-slf4j擴充卡才能正常工作。

天啦噜!要死循環

假設,我們在應用中調用了sl4j-api,但是呢,你引了四個jar包,slf4j-api-xx.jar,slf4j-log4j12-xx.jar,log4j-xx.jar,log4j-over-slf4j-xx.jar,于是你就會出現如下尴尬的場面

架構師必備,帶你弄清混亂的JAVA日志體系!

如上圖所示,在這種情況下,你調用了slf4j-api,就會陷入死循環中!slf4j-api去調了slf4j-log4j12,slf4j-log4j12又去調用了log4j,log4j去調用了log4j-over-slf4j。最終,log4j-over-slf4j又調了slf4j-api,陷入死循環!

結論

希望大家通過這篇文章清楚了解java的日志體系,活學活用!

​commons-logging-xx.jar​

​log4j-xx.jar​

​sl4j-api-xx.jar​

import org.apache.log4j.Logger;
\\省略
Logger logger = Logger.getLogger(Test.class);
logger.trace("trace");
\\省略      
import java.util.logging.Logger;
\\省略
Logger loggger = Logger.getLogger(Test.class.getName()); 
logger.finest("finest");
\\省略      

​commons-logging-xx.jar​

架構師必備,帶你弄清混亂的JAVA日志體系!
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
\\省略
Log log =LogFactory.getLog(Test.class);
log.trace('trace');
\\省略      
架構師必備,帶你弄清混亂的JAVA日志體系!
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
//省略
Logger logger = LoggerFactory.getLogger(Test.class);
// 省略
logger.info("info");      

架構師必備,帶你弄清混亂的JAVA日志體系!
架構師必備,帶你弄清混亂的JAVA日志體系!

​ps​

架構師必備,帶你弄清混亂的JAVA日志體系!
架構師必備,帶你弄清混亂的JAVA日志體系!
架構師必備,帶你弄清混亂的JAVA日志體系!
架構師必備,帶你弄清混亂的JAVA日志體系!

​ps​

SLF4JBridgeHandler.removeHandlersForRootLogger();
SLF4JBridgeHandler.install();