1. 程式人生 > >commons-logging的使用簡介、Java的那些日誌---commons-loging 、log4j 、slf4j 、LogBack 的理解與區分

commons-logging的使用簡介、Java的那些日誌---commons-loging 、log4j 、slf4j 、LogBack 的理解與區分

簡介:

Jakarta  Commons-logging(JCL)是apache最早提供的日誌的門面介面。提供簡單的日誌實現以及日誌解耦功能。

        JCL能夠選擇使用Log4j(或其他如slf4j等)還是JDK Logging,但是他不依賴Log4j,JDK Logging的API。如果專案的classpath中包含了log4j的類庫,就會使用log4j,否則就使用JDK Logging。使用commons-logging能夠靈活的選擇使用那些日誌方式,而且不需要修改原始碼。(類似於JDBC的API介面)

原理:

       JCL有兩個基本的抽象類: Log( 基本記錄器 ) 和 LogFactory( 負責建立 Log 例項 ) 。當 commons-logging.jar 被加入到 CLASSPATH之後,它會合理地猜測你想用的日誌工具,然後進行自我設定,使用者根本不需要做任何設定。預設的 LogFactory 是按照下列的步驟去發現並決定那個日誌工具將被使用的(按照順序,尋找過程會在找到第一個工具時中止) :

①首先在classpath下尋找commons-logging.properties檔案。如果找到,則使用其中定義的Log實現類;如果找不到,則在查詢是否已定義系統環境變數org.apache.commons.logging.Log,找到則使用其定義的Log實現類;

②檢視classpath中是否有Log4j的包,如果發現,則自動使用Log4j作為日誌實現類;

③否則,使用JDK自身的日誌實現類(JDK1.4以後才有日誌實現類);

④否則,使用commons-logging自己提供的一個簡單的日誌實現類SimpleLog;

org.apache.commons.logging.Log 的具體實現有如下:

---org.apache.commons.logging.impl.Jdk14Logger  使用 JDK1.4 。

---org.apache.commons.logging.impl.Log4JLogger  使用 Log4J 。

---org.apache.commons.logging.impl.LogKitLogger    使用 avalon-Logkit 。

---org.apache.commons.logging.impl.SimpleLog      common-logging 自帶日誌實現類。

---org.apache.commons.logging.impl.NoOpLog          common-logging 自帶日誌實現類。它實現了 Log 介面。 其輸出日誌的方法中不進行任何操作。

————————————————————————————————————————

Maven依賴:

  1. <dependency>

  2. <groupId>commons-logging</groupId>

  3. <artifactId>commons-logging</artifactId>

  4. <version>1.2</version>

  5. </dependency>

一、Commons-logging簡單日誌實現:

①新建commons-logging.properties檔案,放置在classpath根路徑下:

org.apache.commons.logging.Log=org.apache.commons.logging.impl.SimpleLog

②程式碼中使用

  1. import org.apache.commons.logging.Log;

  2. import org.apache.commons.logging.LogFactory;

  3. public class CommonsTest {

  4. private final static Log logger = LogFactory.getLog(CommonsTest.class);

  5. public static void main(String[] args) {

  6. logger.debug("DEBUG ...");

  7. logger.info("INFO ...");

  8. logger.error("ERROR ...");

  9. }

  10. }


輸出:

二、Commons-logging的解耦功能:

commons-logging最核心有用的功能是解耦,它的SimpleLog實現效能比不上其他實現,如log4j等。 

①新增依賴

  1. <dependency>

  2. <groupId>commons-logging</groupId>

  3. <artifactId>commons-logging</artifactId>

  4. <version>1.2</version>

  5. </dependency>

  6. <dependency>

  7. <groupId>log4j</groupId>

  8. <artifactId>log4j</artifactId>

  9. <version>1.2.17</version>

  10. </dependency>

②修改配置檔案:

修改commons-logging.properties檔案:顯示地指定log4j

org.apache.commons.logging.Log=org.apache.commons.logging.impl.Log4JLogger

並新增log4j.properties的配置檔案:

  1. log4j.rootLogger=DEBUG,console

  2. # 輸出到控制檯

  3. log4j.appender.console=org.apache.log4j.ConsoleAppender

  4. # 設定輸出樣式

  5. log4j.appender.console.layout=org.apache.log4j.PatternLayout

  6. # 日誌輸出資訊格式為

  7. log4j.appender.console.layout.ConversionPattern=[%-d{yyyy-MM-dd HH:mm:ss}]-[%t-%5p]-[%C-%M(%L)]: %m%n

③程式碼中使用

  1. import org.apache.commons.logging.Log;

  2. import org.apache.commons.logging.LogFactory;

  3. public class CommonsTest {

  4. private final static Log logger = LogFactory.getLog(CommonsTest.class);

  5. public static void main(String[] args) {

  6. logger.debug("DEBUG ...");

  7. logger.info("INFO ...");

  8. logger.error("ERROR ...");

  9. }

  10. }


輸出:

=========================================================================

Java的那些日誌---commons-loging 、log4j 、slf4j 、LogBack 的理解與區分

最近自己動手做專案時,發現Java日誌實現這麼狗血。。。

以下是小弟的一些拙見。。。望過往牛人指正!

如果對於commons-loging 、log4j 、slf4j 、LogBack 等都已經非常清楚了,可以忽略本文。幾次解決日誌衝突問題時對這幾個概念的簡單總結,希望對這塊基礎沒有理解透的同學能有所幫助,當然如果對這塊有更深刻理解的同學,也貢獻出自己的知識和見解。

一、     概念

Commons-logging : apache最早提供的日誌的門面介面。避免和具體的日誌方案直接耦合。類似於JDBC 的api 介面,具體的的JDBC driver 實現由各資料庫提供商實現。通過統一介面解耦,不過其內部也實現了一些簡單日誌方案。

Log4j : 經典的一種日誌解決方案。內部把日誌系統抽象封裝成Logger 、appender 、pattern 等實現。我們可以通過配置檔案輕鬆的實現日誌系統的管理和多樣化配置。

Slf4j : 全稱為Simple Logging Facade for JAVA:java簡單日誌門面。 是對不同日誌框架提供的一個門面封裝。可以在部署的時候不修改任何配置即可接入一種日誌實現方案。和commons-loging 應該有一樣的初衷。個人感覺設從計上更好一些,沒有commons 那麼多潛規則。同時有兩個額外特點:

1. 能支援多個引數,並通過{} 佔位符進行替換,避免老寫logger.isXXXEnabled 這種無奈的判斷,帶來效能提升見:http://www.slf4j.org/faq.html#logging_performance 。

2.OSGI 機制更好相容支援

一圖勝千言,官網上的一個圖:


從上圖可以發現,選擇還是很多的。

Logback : LOGBack 作為一個通用可靠、快速靈活的日誌框架,將作為Log4j 的替代和SLF4J 組成新的日誌系統的完整實現。官網上稱具有極佳的效能,在關鍵路徑上執行速度是log4j 的10 倍,且記憶體消耗更少。具體優勢見:

http://logback.qos.ch/reasonsToSwitch.html

二、     常見日誌方案和注意事項

1.Commons-logging+log4j : 經典的一個日誌實現方案。出現在各種框架裡。如spring 、webx 、ibatis 等等。直接使用log4j 即可滿足我們的日誌方案。但是一般為了避免直接依賴具體的日誌實現,一般都是結合commons-logging 來實現。常見程式碼如下:

import org.apache.commons.logging.Log;

import org.apache.commons.logging.LogFactory;

private static Log logger = LogFactory.getLog(CommonsLoggingTest.class);

程式碼上,沒有依賴任何的log4j 內部的類。那麼log4j 是如何被裝載的?

Log 是一個介面宣告。LogFactory 的內部會去裝載具體的日誌系統,並獲得實現該Log 介面的實現類。而內部有一個Log4JLogger 實現類對Log 介面同時內部提供了對log4j logger 的代理。LogFactory 內部裝載日誌系統流程:

1.   首先,尋找org.apache.commons.logging.LogFactory 屬性配置

2.   否則,利用JDK1.3 開始提供的service 發現機制,會掃描classpah 下的META-INF/services/org.apache.commons.logging.LogFactory 檔案,若找到則裝載裡面的配置,使用裡面的配置。

3.   否則,從Classpath 裡尋找commons-logging.properties ,找到則根據裡面的配置載入。

4.   否則,使用預設的配置:如果能找到Log4j 則預設使用log4j 實現,如果沒有則使用JDK14Logger 實現,再沒有則使用commons-logging 內部提供的SimpleLog 實現。

從上述載入流程來看,如果沒有做任何配置,只要引入了log4j 並在classpath 配置了log4j.xml ,則commons-logging 就會使log4j 使用正常,而程式碼裡不需要依賴任何log4j 的程式碼。

2.Commons-logging+log4j+slf4j

如果在原有commons-logging 系統裡,如果要遷移到slf4j, 使用slf4j 替換commons-logging ,也是可以做到的。原理使用到了上述commons-logging 載入的第二點。需要引入Org.slf4j.jcl-over-slf4j-1.5.6.jar 。這個jar 包提供了一個橋接,讓底層實現是基於slf4j 。原理是在該jar 包裡存放了配置META-INF/services/org.apache.commons.logging.LogFactory =org.apache.commons.logging.impl.SLF4JLogFactory,而commons-logging 在初始化的時候會找到這個serviceId ,並把它作為LogFactory 。

完成橋接後,那麼那麼簡單日誌門面SLF4J 內部又是如何來裝載合適的log 呢?

原理是SLF4J 會在編譯時會繫結import org.slf4j.impl.StaticLoggerBinder; 該類裡面實現對具體日誌方案的繫結接入。任何一種基於slf4j 的實現都要有一個這個類。如:

org.slf4j.slf4j-log4j12-1.5.6: 提供對 log4j 的一種適配實現。

Org.slf4j.slf4j-simple-1.5.6: 是一種 simple 實現,會將 log 直接打到控制檯。

……

那麼這個地方就要注意了:如果有任意兩個實現slf4j 的包同時出現,那就有可能釀就悲劇,你可能會發現日誌不見了、或都打到控制檯了。原因是這兩個jar 包裡都有各自的org.slf4j.impl.StaticLoggerBinder ,編譯時候繫結的是哪個是不確定的。這個地方要特別注意!!出現過幾次因為這個導致日誌錯亂的問題。

3.Slf4j+logback

Slf4j 和log4j 作者都是同一個人。

Logback 號稱在效能各方面有很多優勢,也很誘人。

直接使用SLf4j 也很簡單:

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class HelloWorld {
  public static void main(String[] args) {
    Logger logger = LoggerFactory.getLogger(HelloWorld.class);
    logger.info("Hello World");
  }
}

程式碼裡也看不到任何具體日誌實現方案的痕跡。

Logback 沒用過,看到過一些誘人介紹。具體大家可以去研究。logback 。

注意事項

使用日誌配置的時候一定要明白需求,同時避免衝突。

如使用SLF4j 的時候為了避免衝突,一定要保障只有一種實現類jar 包在裡面。

當遇到日誌錯亂等問題時,可以從這幾個方面來排查