1. 日志簡介
在Java項目中,日志是必不可少的功能,日志對於快速定位問題,檢查日常項目運行狀態等有非常重要的作用,但是目前Java日志存在多種框架,如:Log4j、Log4j2、Commons Logging、Slf4j、Logback、Jul等。
2. 常用日志框架
Log4j,Apache基金會項目,日志實現框架。
Log4j 2,是Log4j的升級產品,但是與Log4j不兼容。
Commons Logging,簡稱jcl,Apache基金會項目,日志門面組件。
Slf4j,日志門面組件。
Logback,日志實現框架。
Jul, java官方的日志實現框架。
介紹到這里大家可能比較疑惑,記錄日志到底該用哪個組件,其實實現日志記錄可以直接使用日志實現框架,比如Logback、Log4j、Log4j2或者Jul,但是一旦這么做如果碰到日志組件更換或者升級,將會很麻煩,比如你需要去每一個使用日志記錄的類中去修改,
所以我們在項目中一般不直接使用日志實現框架,而是使用外觀模式:日志門面組件+橋接器+日志實現框架,這樣即使項目更換日志種類,只需更換橋接器和日志實現框架,也就是只更換Jar包就可以了,代碼無需做任何改動。
下圖表示了日志門面組件、橋接器、日志時間框架之間的關系:
3. 日志選用
建議選擇Slf4j+logback,相比其他組合相比有以下優勢:
1) 限制較少,使用范圍更廣。
2) 更好的性能,更低的開銷。
3) 文檔免費
4) Slf4j和Logback是同一個人開發,銜接好。
如果你不想使用該組合,也可以選用其他組合,很多人也使用Slf4j+Log4j,這里把Slf4j和其他日志實現框架組合和所需要的橋接器列出,可自行選用:
更詳細的Slf4j官網(https://www.slf4j.org/manual.html#swapping)示意圖如下:
4. 問題處理
實際上不單單存在日志門面組件到日志實現框架的橋接器,還存在另外一種橋接器,就是可以把日志實現框架重定向到日志門面組件,我們暫時就叫它“重定向橋接器”吧,例如:Log4j-over-slf4j-version.jar、jcl-over-slfj-version.jar(jcl雖然也是日志門面組件,但是也可以實現重新定向),jul-over-slf4j-version.jar等。這些“重定向橋接器”的存在,不謹慎處理會造成一些異常,首先要知道,為什么會存在這類橋接器?不要不行嗎?因為項目中你自己主動打印的日志,可能是想用Slf4j+Logback,但是項目中使用了許多其他依賴,這些依賴用的日志實現不盡相同,這時候就需要統一項目日志記錄系統,所以就有了這些“重定向橋接器”。
常見異常為:
1)
這種異常是因為Slf4j作為日志門面接口,結果依賴中出現了多個不同日志實現框架的橋接器,所以出現多重綁定的異常,如果你想使用logback作為日志實現,那就保留logback-classic橋接器,屏蔽其他橋接器,想使用其他日志實現框架的話同理。
2)
這種異常是因為Slf4j使用橋接器到某個日志實現框架,然后該框架又使用“重定向橋接器”調用Slf4j,即“Slf4j -> 橋接器 -> 日志實現框架 -> ‘重定向橋接器’-> Slf4j”,形成閉環,循環調用,從而堆棧溢出。解決辦法就是,屏蔽“重定向橋接器”,打破閉環。
舉例:
(1) slf4j-log4j12.jar和log4j-over-slf4j.jar共存,會形成Slf4j -> slf4j-log4j12 -> log4j -> log4j-over-slf4j -> Slf4j 的閉環,這個時候根據你實際項目使用日志情況,打破閉環,比如你本身並不使用log4j作為日志實現框架而用的是logback,那就可以屏蔽slf4j-log4j12.jar。
(2) Jul-to-slf4j.jar和slfj-jdk14.jar共存,方法同上。
5.查看沖突
如果使用IDEA作為開發工具,可以很方便的看到依賴沖突的情況。
(1) 打開項目的pom.xml文件,然后右擊->maven->Show Dependencies,如果沒有此項功能,請看一下File- > Plugins -> UMLSupport插件下了沒。
(2) 然后出現如下,按住Ctrl,使用鼠標滾輪可調整大小,Ctrl+F 可以搜索jar。
(3) 連接帶紅線的就是有沖突的jar包,點擊該jar包會顯示版本信息,順着紅色虛線就可以找到沖突的jar包 , 然后對着沖突的jar包點擊右鍵,選擇Exclude就可以屏蔽沖突的jar包。