log4j+logback+slf4j+commons-logging的關係與調試

背景 
    因爲如今開源框架日益豐富，好多開源框架使用的日誌組件不盡相同。存在着在一個項目中，不一樣的版本，不一樣的框架共存。致使日誌輸出異常混亂。雖然也不至於對系統形成致命傷害，可是明顯能夠看出，架構不夠精良，追求極致略有不足。 
    其中有一些標準通用接口，標準實現，各類橋接器的存在，下面就讓筆者樹立一下這些框架之間的關係。 
 

從上圖中，咱們能夠看到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 示例代碼： 

import org.apache.commons.logging.Log;  
import org.apache.commons.logging.LogFactory;  
  
public class TestLog {  
    Log log = LogFactory.getLog(TestLog.class);  
  
    public void print() {  
        if (log.isDebugEnabled()) {  
            log.debug(sql);  
            log.debug("My name is " + name + "， I am " + age + " years old.");  
        }  
    }  
}

slf4j的示例代碼： 

import org.slf4j.Logger;  
import org.slf4j.LoggerFactory;  
  
public class TestLogBySlf4J {  
    Logger logger = LoggerFactory.getLogger(TestLogBySlf4J.class);  
  
    public void print() {  
        logger.debug(sql);  
        logger.debug("My name is {}， I am {} years old.", name, age);  
    }  
}

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的pm.xml以下 

   <!-- log -->  
<dependency>  
    <groupId>org.slf4j</groupId>  
    <artifactId>slf4j-api</artifactId>  
    <version>${org.slf4j-version}</version>  
</dependency>  
<dependency>  
    <groupId>org.slf4j</groupId>  
    <artifactId>jcl-over-slf4j</artifactId>  
    <version>${org.slf4j-version}</version>  
</dependency>  
<dependency>  
    <groupId>org.slf4j</groupId>  
    <artifactId>log4j-over-slf4j</artifactId>  
    <version>${org.slf4j-version}</version>  
</dependency>  
<dependency>  
    <groupId>org.slf4j</groupId>  
    <artifactId>jul-to-slf4j</artifactId>  
    <version>${org.slf4j-version}</version>  
</dependency>  
<dependency>  
    <groupId>org.jboss.logging</groupId>  
    <artifactId>jboss-logging</artifactId>  
    <version>3.1.4.GA</version>  
</dependency>  
<!--   
<dependency>  
    <groupId>commons-logging</groupId>  
    <artifactId>commons-logging</artifactId>  
    <version>1.1.3</version>  
</dependency>  
<dependency>  
    <groupId>log4j</groupId>  
    <artifactId>log4j</artifactId>  
    <version>1.2.17</version>  
</dependency>       
 -->

    加了幾個重要的實現適配器，log4j-over-slf4j，log4j-over-slf4j，jul-to-slf4j。而後jboss-logging部分也進行了統一的版本控制。同時刪除及exclude掉全部log4j，commons-logging的各個版本。適配器和具體日誌實現，不能共存，不然適配器不生效。這樣的話，咱們只有logback配置文件便可，由於log4j的輸出已經委託給了slf4j（經過log4j-over-slf4j），而slf4j的默認實現是logback。 
其中JUL須要額外執行一行初始化代碼 

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 version="1.0" encoding="UTF-8"?>  
<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">  
<log4j:configuration xmlns:log4j='http://jakarta.apache.org/log4j/'>  
    <appender name="console" class="org.apache.log4j.ConsoleAppender">  
        <layout class="org.apache.log4j.PatternLayout">  
            <param name="ConversionPattern" value="%d{yyyy-MM-dd HH:mm:ss:SSS}[%-5p][%l] - %m%n" />  
        </layout>  
    </appender>  
    <logger name="org.springframework" additivity="false">  
        <level value="info" />  
        <appender-ref ref="console" />  
    </logger>  
    <root>  
        <level value="info" />  
        <appender-ref ref="console" />  
    </root>  
</log4j:configuration>