新聞中心
注:下文中的“橋接”、“轉(zhuǎn)調(diào)”、“綁定”等詞基本都是同一個(gè)概念。
創(chuàng)新互聯(lián)主營(yíng)三門(mén)峽網(wǎng)站建設(shè)的網(wǎng)絡(luò)公司,主營(yíng)網(wǎng)站建設(shè)方案,手機(jī)APP定制開(kāi)發(fā),三門(mén)峽h5重慶小程序開(kāi)發(fā)搭建,三門(mén)峽網(wǎng)站營(yíng)銷(xiāo)推廣歡迎三門(mén)峽等地區(qū)企業(yè)咨詢
log4j-over-slf4j和slf4j-log4j12是跟java日志系統(tǒng)相關(guān)的兩個(gè)jar包,當(dāng)它們同時(shí)出現(xiàn)在classpath下時(shí),就可能會(huì)引起堆棧溢出異常。異常信息大致如下(摘自slf4j官網(wǎng)文檔Detected both log4j-over-slf4j.jar AND slf4j-log4j12.jar on the class path, preempting StackOverflowError):
Exception in thread "main" java.lang.StackOverflowError
at java.util.Hashtable.containsKey(Hashtable.java:306)
at org.apache.log4j.Log4jLoggerFactory.getLogger(Log4jLoggerFactory.java:36)
at org.apache.log4j.LogManager.getLogger(LogManager.java:39)
at org.slf4j.impl.Log4jLoggerFactory.getLogger(Log4jLoggerFactory.java:73)
at org.slf4j.LoggerFactory.getLogger(LoggerFactory.java:249)
at org.apache.log4j.Category.(Category.java:53)
at org.apache.log4j.Logger..(Logger.java:35)
at org.apache.log4j.Log4jLoggerFactory.getLogger(Log4jLoggerFactory.java:39)
at org.apache.log4j.LogManager.getLogger(LogManager.java:39)
at org.slf4j.impl.Log4jLoggerFactory.getLogger(Log4jLoggerFactory.java:73)
at org.slf4j.LoggerFactory.getLogger(LoggerFactory.java:249)
at org.apache.log4j.Category..(Category.java:53)
at org.apache.log4j.Logger..(Logger.java:35)
at org.apache.log4j.Log4jLoggerFactory.getLogger(Log4jLoggerFactory.java:39)
at org.apache.log4j.LogManager.getLogger(LogManager.java:39)
subsequent lines omitted...
現(xiàn)有日志體系
分析這個(gè)異常出現(xiàn)的具體原因之前,有必要先快速了解一下現(xiàn)有的Java日志體系。下圖是現(xiàn)有Java日志體系的一個(gè)示意:
上圖不是非常精準(zhǔn),但是能夠比較清晰地展示現(xiàn)有Java日志體系的主體架構(gòu)。Java日志體系大體可以分為三個(gè)部分:日志門(mén)面接口、橋接器、日志框架具體實(shí)現(xiàn)。
Java日志框架有很多種,最簡(jiǎn)單的是Java自帶的java.util.logging,而最經(jīng)典的是log4j,后來(lái)又出現(xiàn)了一個(gè)比log4j性能更好的logback,其他的日志框架就不怎么常用了。應(yīng)用程序直接使用這些具體日志框架的API來(lái)滿足日志輸出需求當(dāng)然是可以的,但是由于各個(gè)日志框架之間的API通常是不兼容的,這樣做就使得應(yīng)用程序喪失了更換日志框架的靈活性。
比直接使用具體日志框架API更合理的選擇是使用日志門(mén)面接口。日志門(mén)面接口提供了一套獨(dú)立于具體日志框架實(shí)現(xiàn)的API,應(yīng)用程序通過(guò)使用這些獨(dú)立的API就能夠?qū)崿F(xiàn)與具體日志框架的解耦,這跟JDBC是類(lèi)似的。最早的日志門(mén)面接口是commons-logging,但目前最受歡迎的是slf4j。
日志門(mén)面接口本身通常并沒(méi)有實(shí)際的日志輸出能力,它底層還是需要去調(diào)用具體的日志框架API的,也就是實(shí)際上它需要跟具體的日志框架結(jié)合使用。由于具體日志框架比較多,而且互相也大都不兼容,日志門(mén)面接口要想實(shí)現(xiàn)與任意日志框架結(jié)合可能需要對(duì)應(yīng)的橋接器,就好像JDBC與各種不同的數(shù)據(jù)庫(kù)之間的結(jié)合需要對(duì)應(yīng)的JDBC驅(qū)動(dòng)一樣。
需要注意的是,前面說(shuō)過(guò),上圖并不精準(zhǔn),這只是主要部分,實(shí)際情況并不總是簡(jiǎn)單的“日志門(mén)面接口-->橋接器-->日志框架”這一條單向線。實(shí)際上,獨(dú)立的橋接器有時(shí)候是不需要的,而且也并不是只有將日志門(mén)面API轉(zhuǎn)調(diào)到具體日志框架API的橋接器,也存在將日志框架API轉(zhuǎn)調(diào)到日志門(mén)面API的橋接器。
說(shuō)白了,所謂“橋接器”,不過(guò)就是對(duì)某套API的偽實(shí)現(xiàn)。這種實(shí)現(xiàn)并不是直接去完成API所聲明的功能,而是去調(diào)用有類(lèi)似功能的別的API。這樣就完成了從“某套API”到“別的API”的轉(zhuǎn)調(diào)。如果同時(shí)存在A-to-B.jar和B-to-A.jar這兩個(gè)橋接器,那么可以想象當(dāng)應(yīng)用程序開(kāi)始調(diào)用A或者B的API時(shí),會(huì)發(fā)生什么事。這就是最開(kāi)始引出的那個(gè)stack overflow異常的基本原理。
slf4j的轉(zhuǎn)接綁定
上面只是從整體上大概說(shuō)了下Java現(xiàn)有日志體系,還看無(wú)法詳細(xì)說(shuō)明問(wèn)題所在,需要進(jìn)一步了解一下slf4j與具體日志框架的橋接情況。
slf4j橋接到具體日志框架
下圖來(lái)自slf4j官網(wǎng)文檔Binding with a logging framework at deployment time:
可以看到slf4j與具體日志框架結(jié)合的方案有很多種。當(dāng)然,每種方案的最上層(綠色的應(yīng)用層)都是統(tǒng)一的,它們向下都是直接調(diào)用slf4j提供的API(淺藍(lán)色的抽象API層),依賴(lài)slf4j-api.jar。然后slf4j API向下再怎么做就非常自由了,幾乎可以使用所有的具體日志框架。注意圖中的第二層是淺藍(lán)色的,看左下角的圖例可知這代表抽象日志API,也就是說(shuō)它們不是具體實(shí)現(xiàn)。如果像左邊第一種方案那樣下層沒(méi)有跟任何具體日志框架實(shí)現(xiàn)相結(jié)合,那么日志是無(wú)法輸出來(lái)的(這里不確定是否可能會(huì)默認(rèn)輸出到標(biāo)準(zhǔn)輸出)。
圖中第三層明顯就不如第一、二層那么整齊劃一了,因?yàn)檫@里已經(jīng)開(kāi)始涉及到了具體的日志框架。
首先看第三層中間的兩個(gè)湖藍(lán)色塊,這是適配層,也就是橋接器。左邊的slf4j-log4j12.jar橋接器看名字就知道是slf4j到log4j的橋接器,同樣,右邊的slf4j-jdk14.jar就是slf4j到Java原生日志實(shí)現(xiàn)的橋接器了。它們的下一層分別是對(duì)應(yīng)的日志框架實(shí)現(xiàn),log4j的實(shí)現(xiàn)代碼是log4j.jar,而jul實(shí)現(xiàn)代碼已經(jīng)包含在了JVM runtime中,不需要單獨(dú)的jar包。
再看第三層其余的三個(gè)深藍(lán)色塊。它們?nèi)齻€(gè)也是具體的日志框架實(shí)現(xiàn),但是卻不需要橋接器,因?yàn)樗鼈儽旧砭鸵呀?jīng)直接實(shí)現(xiàn)了slf4j API。slf4j-simple.jar和slf4j-nop.jar這兩個(gè)不用多說(shuō),看名字就知道一個(gè)是slf4j的簡(jiǎn)單實(shí)現(xiàn),一個(gè)是slf4j的空實(shí)現(xiàn),平時(shí)用處也不大。而logback之所以也實(shí)現(xiàn)了slf4j API,據(jù)說(shuō)是因?yàn)閘ogback和slf4j出自同一人之手,這人同時(shí)也是log4j的作者。
第三層所有的灰色jar包都帶有紅框,這表示它們都直接實(shí)現(xiàn)了slf4j API,只是湖藍(lán)色的橋接器對(duì)slf4j API的實(shí)現(xiàn)并不是直接輸出日志,而是轉(zhuǎn)去調(diào)用別的日志框架的API。
其它日志框架API轉(zhuǎn)調(diào)回slf4j
如果只存在上面這些從sfl4j到其他日志框架的橋接器,可能還不會(huì)出什么問(wèn)題。但是實(shí)際上還有另外一類(lèi)橋接器,它們的作用跟上面的恰好相反,它們將其它日志框架的API轉(zhuǎn)調(diào)到slf4j的API上。下圖來(lái)自slf4j官網(wǎng)文檔Bridging legacy APIs:
上圖展示了目前為止能安全地從別的日志框架API轉(zhuǎn)調(diào)回slf4j的所有三種情形。
以左上角第一種情形為例,當(dāng)slf4j底層橋接到logback框架的時(shí)候,上層允許橋接回slf4j的日志框架API有l(wèi)og4j和jul。jcl雖然不是什么日志框架的具體實(shí)現(xiàn),但是它的API仍然是能夠被轉(zhuǎn)調(diào)回slf4j的。要想實(shí)現(xiàn)轉(zhuǎn)調(diào),方法就是圖上列出的用特定的橋接器jar替換掉原有的日志框架jar。需要注意的是這里不包含logback API到slf4j API的轉(zhuǎn)調(diào),因?yàn)閘ogback本來(lái)就是slf4j API的實(shí)現(xiàn)。
看完三種情形以后,會(huì)發(fā)現(xiàn)幾乎所有其他日志框架的API,包括jcl的API,都能夠隨意的轉(zhuǎn)調(diào)回slf4j。但是有一個(gè)唯一的限制就是轉(zhuǎn)調(diào)回slf4j的日志框架不能跟slf4j當(dāng)前橋接到的日志框架相同。這個(gè)限制就是為了防止A-to-B.jar跟B-to-A.jar同時(shí)出現(xiàn)在類(lèi)路徑中,從而導(dǎo)致A和B一直不停地互相遞歸調(diào)用,最后堆棧溢出。目前這個(gè)限制并不是通過(guò)技術(shù)保證的,僅僅靠開(kāi)發(fā)者自己保證,這也是為什么slf4j官網(wǎng)上要強(qiáng)調(diào)所有合理的方式只有上圖的三種情形。
到這里,在開(kāi)始所展示的那個(gè)異常的原理基本已經(jīng)清楚了。此外,通過(guò)上圖還可以看出可能會(huì)出現(xiàn)類(lèi)似異常的組合不僅僅是log4j-over-slf4j和slf4j-log4j12,slf4j官網(wǎng)還指出了另外一對(duì):jcl-over-slf4j.jar和slf4j-jcl.jar
代碼示例
前面的分析都是理論上的,實(shí)際代碼中即便同時(shí)使用了log4j-over-slf4j和slf4j-log4j12,也未必一定會(huì)出現(xiàn)異常。下面的代碼調(diào)用slf4j的API輸出日志,slf4j底層橋接到log4j:
package test; public class HelloWorld { public static void main(String[] args) { org.apache.log4j.BasicConfigurator.configure(); org.slf4j.Logger logger = org.slf4j.LoggerFactory .getLogger(HelloWorld.class); logger.info("Hello World"); } }
配置clas配置classpath上的jar包為(注意log4j在log4j-over-slf4j之前):
在這種情況下運(yùn)行測(cè)試程序是能夠正常輸出日志的,不會(huì)出現(xiàn)stack overflow異常。但是如果調(diào)整classpath上的jar順序?yàn)椋?/p>
再運(yùn)行測(cè)試程序就出現(xiàn)類(lèi)似于本文最開(kāi)始的stack overflow異常了,可以看到明顯的周期性重復(fù):
序列圖分析
上圖是堆棧溢出的詳細(xì)調(diào)用過(guò)程序列圖。從調(diào)用1開(kāi)始,依次調(diào)用1.1、1.1.1……最后到了1.1.1.1.1.1(圖中最后一個(gè)調(diào)用)的時(shí)候,發(fā)現(xiàn)它跟1是完全一樣的,那么后續(xù)的過(guò)程就是完全一樣的重復(fù)了。
需要特別說(shuō)明的是最開(kāi)始的導(dǎo)火索并不只有圖中所示的LoggerFactory.getLogger()一種,應(yīng)用程序中能夠觸發(fā)堆棧溢出異常的直接調(diào)用還有好幾種其它的,比如前面示例代碼中觸發(fā)異常的實(shí)際上是第一條語(yǔ)句org.apache.log4j.BasicConfigurator.configure(),但后續(xù)的互相無(wú)限遞歸調(diào)用過(guò)程基本都是跟上圖相同的過(guò)程。
以上就是本文的全部?jī)?nèi)容,希望對(duì)大家的學(xué)習(xí)有所幫助,也希望大家多多支持創(chuàng)新互聯(lián)。
文章題目:詳解log4j-over-slf4j與slf4j-log4j12共存stackoverflow異常分析
鏈接分享:http://www.dlmjj.cn/article/jodhoo.html