日志框架分為三大部分,包括日志門面、日志適配器、日志庫。利用門面設計模式,即Facade來進行解耦,使日志使用變得更加簡單,如下圖:

日志門面
門面設計模式是面向對象設計模式中的一種,日志框架采用的就是這種模式,類似JDBC的設計理念。它只提供一套接口規范,自身不負責日志功能的實現,目的是讓使用者不許奧關注底層具體是哪個日志庫來負責日志打印及具體的使用字節等。目前用得最廣泛的日志門面有 slf4j和commons-logging。
日志庫
它具體實現了日志的相關的功能,主流的日志庫有三個: log4j、log-jdk、logback。最早java 要想記錄只能通過System.out 或 System.err 來完成,非常不方便。log4j 就是為了解決這一問題而提出的,它是最早誕生的日志庫。接著JDK也在1.4 版本引入一個日志庫 java.util.logging.Logger,簡稱 log-jdk。這樣市面上就出現兩種日志功能的實現,開發者在使用時需要關注所使用的日志庫的具體字節。logback是最晚出現的,它與log4j出自同一個作者,是log4j的升級版且本身就實現了 slf4j 的接口。
日志適配器
日志適配器分為兩種場景:
(1) 日志門面適配器,因為slf4j 規范是后來提出的,在此之前的日志庫沒有實現 slf4j 的接口的,例如 log4j, 所以,在工程里要想使用slf4j + log4j 的模式,就額外需要一個適配器(slf4j + log4j2) 來解決接口不兼容的問題。
(2) 日志適配器,在一些老的工程,一開始為了開發簡單而直接使用了日志庫API 來完成日志打印,隨著時間的推移想將原來直接調用日志庫的模型改為業界標準的門面模式 ( 例如 slf4j +logback 組合) ,但老工程代碼里的打印日志的地方太多,難以改變,所以需要一個適配器來完成從舊日志庫的API到slf4j的路由,這樣在不改動原有代碼的情況下也能使用slf4j來統一管理日志,而且后續自由替換具體日志庫也不成問題。
1、Apache Commons Logging(JCL)
Commons本身只提供日志接口,具體實現在運行時 動態尋找對應組件?思路上類似于JDBC的抽象。
JCL動態查找(綁定)日志組件原理如下:

JCL為每一種日志采用了一個適配器,具體采用哪一個,是動態根據指定順序查找classpath是否存在相應日志的實現,如果JCL運行時沒有找到任何一種第三方的日志實現,則就使用jdk14自帶的java.util.logging(JUL)。
Spring日志就是采JCL,解決了應用程序和框架日志不統一的問題,動態去尋找(應用程序配置)日志體系的實現。
默認的LogFactory是按照下列的步驟去發現并決定哪個日志工具將被使用的,LogFactory按照順序尋找,找到第一個工具后中止。
- 首先在classpath下尋找自己的配置文件commons-logging.properties,如果找到,則使用其中定義的Log實現類;
- 如果找不到commons-logging.properties文件,則在查找是否已定義系統環境變量org.apache.commons.logging.Log,找到則使用其定義的Log實現類;
- 否則,查看classpath中是否有Log4j的包,如果發現,則自動使用Log4j作為日志實現類;
- 否則,使用JDK自身的日志實現類(JDK1.4以后才有日志實現類);
- 否則,使用commons-logging自己提供的一個簡單的日志實現類SimpleLog;
2、SLF4j(Simple Logging Facade for java)
與JCL類似,本身不提供具體實現,只對外提供接口或者門面,因此它不是具體的日志解決方案,而是通過Facade Pattern 門面模式對外提供一些 java logging api,這些對外提供的核心API就是一些接口以及LoggerFactory的工程類。
與Common logging 不同的是其采用在ClassPath下尋找一下jar包來表示具體的采用哪種實現
- slf4j-log4j12.jar(表示指定logh4j)
- slf-jdk14.jar(表示使用JUL)
- slf4j-jcl.jar(表示使用JCL)
- log4j-slf4j-impl.jar(表示指定log4j2)
- logback-classic(logback)
SLF4j 靜態綁定日志組件原理:

3、常見的日志組件
4. 適用場景
4.1 slf4j 使用log4j打印日志
- slf4j-api.jar
- slf4j-log4j12.jar
- log4j.jar
JCL方式的common-logging 是動態查找綁定
SLF4j 是靜態綁定,需要加上橋接包,如 SLF4j-log4j2
可通過如下配置進行集成
- <!--slf4j門面 -->
- <dependency>
- <groupId>org.slf4j</groupId>
- <artifactId>slf4j-api</artifactId>
- <version>${slf4j-api.version}</version>
- </dependency>
- <dependency>
- <groupId>org.slf4j</groupId>
- <artifactId>slf4j-log4j12</artifactId>
- <version>${slf4j-log4j12.jar.version}</version>
- </dependency>
- <dependency>
- <groupId>log4j</groupId>
- <artifactId>log4j</artifactId>
- <version>${log4j.version}</version>
- </dependency>
如果是老代碼中直接使用了 log4j 日志庫提供的接口來打印日志,則還需要引入日志庫適配器,配置實例如下所示:
- <dependency>
- <groupId>org.slf4j</groupId>
- <artifactId>log4j-over-slf4j</artifactId>
- <version>${log4j-over-slf4j.version}</version>
- </dependency>
4.2 slf4j 使用logback打印日志

如果是新工程,則推薦使用slf4j+logback 模式,因為logback 自身實現了 slf4j的接口,無須額外引入適配器,另外,logback 是 log4j 的升級版,具備比log4j更多的優點,可通過如下配置進行集成:
- <dependency>
- <groupId>org.slf4j</groupId>
- <artifactId>slf4j-api</artifactId>
- <version>${slf4j.version}</version>
- </dependency>
- <dependency>
- <groupId>ch.qos.logback</groupId>
- <artifactId>logback-core</artifactId>
- <version>${logback.version}</version>
- </dependency>
- <dependency>
- <groupId>ch.qos.logback</groupId>
- <artifactId>logback-classic</artifactId>
- <version>${logback.version}</version>
- </dependency>
4.3 spring 集成log4j2
我們應用使用的是log4j2打印日志;而Spring采用的JCL中不包含log4j2,運行時,JCL從ClassPath下尋找日志的實現,如果沒有引用其他實現,最終會使用JUL實現。如下圖:

這時候會出現什么問題呢?
Spring打印日志和應用程序的打印日志不統一,錯誤排除還比較困難,而且應用程序和Spring框架,日志不統一,太亂了。
為了讓Spring和我們的應用程序,采用統一的log4j2日志體系,需要加入適配器,改善上面應用程序和框架日志的統一問題(加入適配器后),如下圖:

- <dependencies>
- <!--slf4j門面 -->
- <dependency>
- <groupId>org.slf4j</groupId>
- <artifactId>slf4j-api</artifactId>
- <version>1.7.25</version>
- </dependency>
- <!-- SLF2j-log4j2的橋接-->
- <dependency>
- <groupId>org.apache.logging.log4j</groupId>
- <artifactId>log4j-slf4j-impl</artifactId>
- <version>2.3</version>
- </dependency>
- <!-- jcl 橋接 SLF4j -->
- <dependency>
- <groupId>org.slf4j</groupId>
- <artifactId>jcl-over-slf4j</artifactId>
- <version>1.7.13</version>
- </dependency>
- <!-- log4j2 -->
- <dependency>
- <groupId>org.apache.logging.log4j</groupId>
- <artifactId>log4j-core</artifactId>
- <version>2.3</version>
- </dependency>
- <dependency>
- <groupId>org.apache.logging.log4j</groupId>
- <artifactId>log4j-api</artifactId>
- <version>2.3</version>
- </dependency>
- <dependency>
- <groupId>com.lmax</groupId>
- <artifactId>disruptor</artifactId>
- <version>3.3.4</version>
- </dependency>
SLF4j集成其他日志框架的方法:

5、優秀實踐
在使用SLF4J使用時,需要注意以下事項:
- private static final Logger LOGGER = LoggerFactory.getLogger(XXX.class);
logger被定義為static 變量,是因為這個LOGGER與當前類綁定,避免每次都new一個新對象,造成資源浪費。
原文鏈接:https://www.toutiao.com/a6991357371033371139/