1. 程式人生 > >log4j+logback+slf4j的關係與除錯

log4j+logback+slf4j的關係與除錯

背景
    由於現在開源框架日益豐富,好多開源框架使用的日誌元件不盡相同。存在著在一個專案中,不同的版本,不同的框架共存。導致日誌輸出異常混亂。雖然也不至於對系統造成致命傷害,但是明顯可以看出,架構不夠精良,追求極致略有不足。 
    其中有一些標準通用介面,標準實現,各種橋接器的存在,下面就讓筆者樹立一下這些框架之間的關係。 
 
從上圖中,我們可以看到4部分。 
介面:將所有日誌實現適配到了一起,用統一的介面呼叫。 
實現:目前主流的日誌實現 
舊日誌到slf4j的介面卡:如果使用了slf4j,但是隻想用一種實現,想把log4j的日誌體系也從logback輸出,這個是很有用的。 
slf4j到實現的介面卡:如果想制定slf4j的具體實現,需要這些包。 


slf4J與舊日誌框架的關係
slf4j等於commons-logging,是各種日誌實現的通用入口,會根據classpath中存在下面哪一個Jar來決定具體的日誌實現庫。
logback-classic(預設的logback實現) 
slf4j-jcl.jar(apache commons logging) 
slf4j-logj12.jar(log4j 1.2.4) 
slf4j-jdk14(java.util.logging) 
將所有使用舊式日誌API的第三方類庫或舊程式碼的日誌呼叫轉到slfj
jcl-over-slf4j.jar/jcl104-over-slf4j:apache commons logging 1.1.1/1.0.4,直接替換即可。 

log4j-over-slf4j.jar:log4j,直接替換即可。 
jul-to-slf4j:jdk logging,需要在程式開始時呼叫SLF4JBridgeHandler.install()來註冊listener參考JulOverSlf4jProcessor,可在applicationContext.xml中定義該bean來實現初始化。注意原有的log4j.properites將失效,logback網站上提供轉換器,支援從log4j.properties 轉換到logback.xml 。 

優勢:轉移到logback的理由
    slf4j支援引數化的logger.error("帳號ID:{}不存在", userId);告別了if(logger.isDebugEnable()) 時代。 

    另外logback的整體效能比log4j也較佳,hibernate等專案已經採用了slf4j:"某些關鍵操作,比如判定是否記錄一條日誌語句的操作,其效能得到了顯著的提高。這個操作在LOGBack中需要3納秒,而在Log4J中則需要30納秒。 LOGBack建立記錄器(logger)的速度也更快:13毫秒,而在Log4J中需要23毫秒。更重要的是,它獲取已存在的記錄器只需94納秒,而 Log4J需要2234納秒,時間減少到了1/23。" 

slf4j和logback的使用
1.如果日誌的引數超過3個,需要寫成 
Object[] params = {newVal, below, above}; logger.debug("Value {} was inserted between {} and {}.", params); 
commons-logging 和slf4j的程式碼比較:commons-logging 示例程式碼: 
Java程式碼  收藏程式碼
  1. import org.apache.commons.logging.Log;  
  2. import org.apache.commons.logging.LogFactory;  
  3. public class TestLog {  
  4.     Log log = LogFactory.getLog(TestLog.class);  
  5.     public void print() {  
  6.         if (log.isDebugEnabled()) {  
  7.             log.debug(sql);  
  8.             log.debug("My name is " + name + ", I am " + age + " years old.");  
  9.         }  
  10.     }  
  11. }  

slf4j的示例程式碼: 
Java程式碼  收藏程式碼
  1. import org.slf4j.Logger;  
  2. import org.slf4j.LoggerFactory;  
  3. public class TestLogBySlf4J {  
  4.     Logger logger = LoggerFactory.getLogger(TestLogBySlf4J.class);  
  5.     public void print() {  
  6.         logger.debug(sql);  
  7.         logger.debug("My name is {}, I am {} years old.", name, age);  
  8.     }  
  9. }  

2.因為內部已優化,作者認為slf4j的logger不需要定義為static。 
3.可設定快取後批量寫日誌檔案(但伺服器如果重啟,可能會丟失未寫到磁碟的記錄) 
4.MDC,用Filter,將當前使用者名稱等業務資訊放入MDC中,在日誌format定義中即可使用該變數。 
5.JMS Appender用於告警, DB Appender用於業務日誌等 

生產環境情況以及優雅方案
    我廠的專案由於使用了眾多的開源架構,所以導致專案中的日誌體系非常混亂。經常出現日誌包衝突的情況。例如:commons-logging-1.0.4,commons-logging-1.1.3,log4j,logback,jboss-logging,java.util.logging......不同的版本,不同的實現。之前筆者至少要配置log4j,logback,commons-logging三個配置檔案,才能完成日誌的輸出。研究了日誌體系以後,我廠的maven的pom.xml如下 
Xml程式碼  收藏程式碼
  1.     <!-- log -->  
  2. <dependency>  
  3.     <groupId>org.slf4j</groupId>  
  4.     <artifactId>slf4j-api</artifactId>  
  5.     <version>${org.slf4j-version}</version>  
  6. </dependency>  
  7. <dependency>  
  8.     <groupId>org.slf4j</groupId>  
  9.     <artifactId>jcl-over-slf4j</artifactId>  
  10.     <version>${org.slf4j-version}</version>  
  11. </dependency>  
  12. <dependency>  
  13.     <groupId>org.slf4j</groupId>  
  14.     <artifactId>log4j-over-slf4j</artifactId>  
  15.     <version>${org.slf4j-version}</version>  
  16. </dependency>  
  17. <dependency>  
  18.     <groupId>org.slf4j</groupId>  
  19.     <artifactId>jul-to-slf4j</artifactId>  
  20.     <version>${org.slf4j-version}</version>  
  21. </dependency>  
  22. <dependency>  
  23.     <groupId>org.jboss.logging</groupId>  
  24.     <artifactId>jboss-logging</artifactId>  
  25.     <version>3.1.4.GA</version>  
  26. </dependency>  
  27. <!--   
  28. <dependency>  
  29.     <groupId>commons-logging</groupId>  
  30.     <artifactId>commons-logging</artifactId>  
  31.     <version>1.1.3</version>  
  32. </dependency>  
  33. <dependency>  
  34.     <groupId>log4j</groupId>  
  35.     <artifactId>log4j</artifactId>  
  36.     <version>1.2.17</version>  
  37. </dependency>       
  38.  -->  

    加了幾個重要的實現介面卡,log4j-over-slf4j,log4j-over-slf4j,jul-to-slf4j。然後jboss-logging部分也進行了統一的版本控制。同時刪除及exclude掉所有log4j,commons-logging的各個版本。介面卡和具體日誌實現,不能共存,否則介面卡不生效。這樣的話,我們只有logback配置檔案即可,因為log4j的輸出已經委託給了slf4j(通過log4j-over-slf4j),而slf4j的預設實現是logback。 
其中JUL需要額外執行一行初始化程式碼 
Java程式碼  收藏程式碼
  1. SLF4JBridgeHandler.install();// jul to slf4j  


常見錯誤除錯
【錯誤1】只是一個典型錯誤,主要是錯誤的第二行紅色部分 
log4j:WARN No appenders could be found for logger (com.mchange.v2.log.MLog). 
log4j:WARN Please initialize the log4j system properly.
log4j:WARN See http://logging.apache.org/log4j/1.2/faq.html#noconfig for more info. 
出現此錯誤是由於沒有log4j配置檔案導致。在classpath下新增log4j.xml,並做一些配置即可。配置完以後,啟動輸出 
2014-02-25 09:30:31:743[INFO ][com.mchange.v2.log.MLog.<clinit>(MLog.java:80)] - MLog clients using log4j logging. 
2014-02-25 09:30:31:780[INFO ][com.mchange.v2.c3p0.C3P0Registry.banner(C3P0Registry.java:204)] - Initializing c3p0-0.9.1.2 [built 21-May-2007 15:04:56; debug? true; trace: 10] 
即表示回覆正常 
。例如我的配置檔案如下 
log4j.xml 
Xml程式碼  收藏程式碼
  1. <?xml version="1.0" encoding="UTF-8"?>  
  2. <!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">  
  3. <log4j:configuration xmlns:log4j='http://jakarta.apache.org/log4j/'>  
  4.     <appender name="console" class="org.apache.log4j.ConsoleAppender">  
  5.         <layout class="org.apache.log4j.PatternLayout">  
  6.             <param name="ConversionPattern" value="%d{yyyy-MM-dd HH:mm:ss:SSS}[%-5p][%l] - %m%n" />  
  7.         </layout>  
  8.     </appender>  
  9.     <logger name="org.springframework" additivity="false">  
  10.         <level value="info" />  
  11.         <appender-ref ref="console" />  
  12.     </logger>  
  13.     <root>  
  14.         <level value="info" />  
  15.         <appender-ref ref="console" />  
  16.     </root>  
  17. </log4j:configuration>  
5