Slf4j與其他日誌系統兼容的使用
java生產的各種框架(如spring等)裏各個框架會使用不同的日誌體系,多個不同日誌在一個jvm裏混搭會出現一定問題 ,這裏梳理一下java體系裏常見的日誌框架,以SFL4j為中心介紹下跟各個日誌框架的關系,介紹下生產環境如何打理各種日誌框架。
1. 接口簡介
在java的體系裏,主要有slf4j和common-logging兩種日誌體系接口。實現的框架有很多,主流的諸如logback、log4j等。
當然,雖然都是接口,但兩者也可以通過橋接包實現相互的日誌代理輸出。
common-logging掛載的日誌實現常為log4j。在初始化的時候,如果沒有特殊指定要掛載誰,會自動按上圖順序去實例化實現,log4jLogger封裝了log4j的logger,打印日誌的時候調用到log4j過去。
2. SLF4j 的橋接和被橋接
slf4j作為一個接口定義,底層可以有很多實現框架,同時也可以支持別的日誌實現或者框架打到sfl4j上。它的實現是基於不同的橋接包。
2.1 slf4j的橋接
slf4j作為接口定義,下面有很多種實現。實現原理是獲取ILoggerFactory時執行初始化,初始化過程綁定實現對象:load出所有實現StaticLoggerBinder的類,然後獲取他的單例,後面執行getLogger的時候都是調用這個單例類的方法獲取對應有具體實現日誌功能的Logger對象。如果有多個實現,之後綁定其中的一個。這種情況需要排除掉不需要的日誌實現類。
2.2 slf4j的被橋接
上圖展示了其他日誌系統如何接入到slf4j日誌體系,其中基本原理是針對各自日誌體系做了代理 ,輸出到了sfl4j接口中,具體實現可以去看橋接包的實現。基本都是對原日誌體現做了重新實現,然後底層實際調用日誌輸出的方法是走到了slf4j上面 。
只有jul是個例外,因為是java自帶jdk實現,沒法去重新那些類,這個地方根據jul的handler擴展機制實現了一個slf4j的handler然後把日誌寫到slf4j上面。同時要生效的話,還要修改jre/lib/logging.properties把新的handler配置到.handlers屬性中。一般生產不會去這麽搞。
2.3 應用
實際項目應用的時候要註意,橋接和被橋接的包不能同時出現,不然會出現死循環了,比如sfl4j既橋接了log4j又被log4j橋接,那log4j輸出調用會指向slf4j,slf4j又指向log4j如此循環。一定要註意排除掉無用的包。
生產建議:slf4j-api下掛載的實現只保留logback,上層的日誌打印橋接可以存在都指向到slf4j。
參考如下依賴,其他關於log的包統統排掉:
<dependencies>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-api</artifactId>
<version>1.7.24</version>
</dependency>
<dependency>
<groupId>ch.qos.logback</groupId>
<artifactId>logback-classic</artifactId>
<version>1.2.1</version>
</dependency>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>jcl-over-slf4j</artifactId>
<version>1.7.14</version>
</dependency>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>log4j-over-slf4j</artifactId>
<version>1.7.24</version>
</dependency>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>jul-to-slf4j</artifactId>
<version>1.7.7</version>
</dependency>
</dependencies>
3. 測試代碼實現及pom
測試代碼
public class TestLoggers { /** * slf4j-api -->slf4j-log4j12 -> log4j */ public void testSfl4jUpLog4j(){ org.slf4j.Logger logger = LoggerFactory.getLogger(TestLoggers.class.getName()); logger.info("Slf4j print use log4j"); } /** * slf4j-api --> slf4j-jcl --> common-logging-api (自動向log4j)--> log4j */ public void testSlf4j2CommonLogging(){ org.slf4j.Logger logger = LoggerFactory.getLogger(TestLoggers.class.getName()); logger.warn("Slf4j print to common logging"); } /** * log4j-over-slf4j--> slf4j-api--> logback-classic */ public void testLog4j2Slf4j(){ org.apache.log4j.Logger logger = org.apache.log4j.Logger.getLogger(TestLoggers.class.getName()); logger.info("Log4j print to slf4j"); } /** * jcl-over-slf4j --> sfl4-api-->logback */ public void testCommonLogging2Sl4j(){ Log log = LogFactory.getLog(TestLoggers.class.getName()); log.info("common log to slf4j"); } /** * jul(console default)-->jul-to-slf4j-->slf4j-->logback * 要在jre/lib/logging.properties 中.handlers添加org.slf4j.bridge.SLF4JBridgeHandler */ public void testJul2Slf4j(){ java.util.logging.Logger logger = java.util.logging.Logger.getLogger(TestLoggers.class.getName()); logger.info("jul print to slf4j"); } public static void main(String[] args) { TestLoggers tester = new TestLoggers(); tester.testSlf4j2CommonLogging(); } }
測試maven依賴
<dependencies> <dependency> <groupId>org.slf4j</groupId> <artifactId>slf4j-api</artifactId> <version>1.7.24</version> </dependency> <dependency> <groupId>commons-logging</groupId> <artifactId>commons-logging-api</artifactId> <version>1.1</version> </dependency> <!--<dependency>--> <!--<groupId>org.slf4j</groupId>--> <!--<artifactId>jcl-over-slf4j</artifactId>--> <!--<version>1.7.14</version>--> <!--</dependency>--> <dependency> <groupId>org.slf4j</groupId> <artifactId>log4j-over-slf4j</artifactId> <version>1.7.24</version> </dependency> <!--<dependency>--> <!--<groupId>org.slf4j</groupId>--> <!--<artifactId>jul-to-slf4j</artifactId>--> <!--<version>1.7.7</version>--> <!--</dependency>--> <!--<dependency>--> <!--<groupId>ch.qos.logback</groupId>--> <!--<artifactId>logback-classic</artifactId>--> <!--<version>1.2.1</version>--> <!--</dependency>--> <!--<dependency>--> <!--<groupId>org.slf4j</groupId>--> <!--<artifactId>slf4j-log4j12</artifactId>--> <!--<version>1.7.5</version>--> <!--</dependency>--> <dependency> <groupId>log4j</groupId> <artifactId>log4j</artifactId> <version>1.2.17</version> </dependency> <dependency> <groupId>org.slf4j</groupId> <artifactId>slf4j-jcl</artifactId> <version>1.7.24</version> </dependency> </dependencies>
參考:
https://www.slf4j.org/legacy.html
https://www.cnblogs.com/chenhongliang/p/5312517.html
Slf4j與其他日誌系統兼容的使用