開發日誌解決方案

日誌解決方案

1、org.apache.commons.logging.Log方案

如果對於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包在裏面。

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

• 查看圖片附件

二、slf4j方案

一. Log4j+commons-logging
 JAR包
commons-logging-1.1.jar
log4j-1.2.15.jar
 配置文件
commons-logging.properties
log4j.xml
 commons-logging.jar包讀取commons-logging.properties中指定的log,自動加載日誌配置
在commons-logging+log4j組合中commons-logging.properties指定的日誌爲:
org.apache.commons.logging.Log=org.apache.commons.logging.impl.Log4JLogger
 log4j指定具體日誌輸出配置
 如果未選用commons-logging,可以在啓動項目中,主動加載log4j的配置文件
二. Logback+slf4j
 JAR包
slf4j-api-1.5.2.jar
logback-classic-0.9.9.jar
logback-core-0.9.9.jar
 配置文件
Logback.xml
 logback的加載採用編碼加載

String logbackCfg = "/config/logback.xml";
URL logURL = new ClassPathResource(logbackCfg).getURL();
ILoggerFactory loggerFactory = LoggerFactory.getILoggerFactory();
LoggerContext loggerContext = (LoggerContext) loggerFactory;
loggerContext.shutdownAndReset();
JoranConfigurator configurator = new JoranConfigurator();
configurator.setContext(loggerContext);
configurator.doConfigure(logURL);

三. Slf4j+log4j
 JAR包
slf4j-api-1.5.2.jar
slf4j-log4j12-1.5.2.jar
log4j-1.2.15.jar
 配置文件
Logback.xml
四. Slf4j+logback+logback
注:這種情況下是項目中有log4j輸出的日誌以及logback數據的日誌.老項目改造,log4j和logback共存的情況下.(當選用spring+slf4j+logback的時候,spring的日誌輸出是log4j的,這個時候採用這種配置.)
 JARbao
log4j-over-slf4j-1.5.2.jar
logback-classic-0.9.9.jar
logback-core-0.9.9.jar
slf4j-api-1.5.2.jar
 配置文件
Logback.xml
 配置加載

String logbackCfg = "/config/logback.xml";
URL logURL = new ClassPathResource(logbackCfg).getURL();
ILoggerFactory loggerFactory = LoggerFactory.getILoggerFactory();
LoggerContext loggerContext = (LoggerContext) loggerFactory;
loggerContext.shutdownAndReset();
JoranConfigurator configurator = new JoranConfigurator();
configurator.setContext(loggerContext);
configurator.doConfigure(logURL);

五. Log4j配置文件示例

<?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">
        <param name="Target" value="System.out" />
        <param name="Threshold" value="INFO" />
        <layout class="org.apache.log4j.PatternLayout">
            <param name="ConversionPattern"
                value="%d{yyyy-MM-dd HH:mm:ss sss}[%-p][%-c][line:%-L] \r\n  %m%n" />
        </layout>

<!— 以下是過濾一些不需要輸出的log信息 -->
        <filter class="org.apache.log4j.varia.StringMatchFilter">
            <param name="StringToMatch" value="new a seq no spend" />
            <param name="AcceptOnMatch" value="false" />
        </filter>
        <filter class="org.apache.log4j.varia.StringMatchFilter">
            <param name="StringToMatch" value="new hi[type=" />
            <param name="AcceptOnMatch" value="false" />
        </filter>
        <filter class="org.apache.log4j.varia.StringMatchFilter">
            <param name="StringToMatch" value="FileTransfer.execCommand()" />
            <param name="AcceptOnMatch" value="false" />
        </filter>
    </appender>

    <!--文件輸出 按照文件大小滾動文件-->
    <appender name="xxxx_file" class="org.apache.log4j.RollingFileAppender">
        <param name="Append" value="true" />
        <param name="Threshold" value="INFO" />
        <param name="File" value="xxxx.log" />
        <param name="MaxFileSize" value="100MB" />
        <param name="MaxBackupIndex" value="15" />
        <layout class="org.apache.log4j.PatternLayout">
            <param name="ConversionPattern"
                value="%d{yyyy-MM-dd HH:mm:ss sss}[%-p][%-c][line:%-L] \r\n  %m%n" />
        </layout>
        <filter class="org.apache.log4j.varia.StringMatchFilter">
            <param name="StringToMatch" value="new a seq no spend" />
            <param name="AcceptOnMatch" value="false" />
        </filter>
        <filter class="org.apache.log4j.varia.StringMatchFilter">
            <param name="StringToMatch" value="new hi[type=" />
            <param name="AcceptOnMatch" value="false" />
        </filter>
        <filter class="org.apache.log4j.varia.StringMatchFilter">
            <param name="StringToMatch" value="FileTransfer.execCommand()" />
            <param name="AcceptOnMatch" value="false" />
        </filter>
    </appender>

    <!-- 錯誤輸出 過濾出錯誤日誌信息-->
    <appender name="xxxx_error" class="org.apache.log4j.RollingFileAppender">
        <param name="Append" value="true" />
        <param name="Threshold" value="ERROR" />
        <param name="File" value="xxxx-error.log" />
        <param name="MaxFileSize" value="100MB" />
        <param name="MaxBackupIndex" value="4" />
        <layout class="org.apache.log4j.PatternLayout">
            <param name="ConversionPattern"
                value="%d{yyyy-MM-dd HH:mm:ss sss}[%-p][%-c][line:%-L] \r\n  %m%n" />
        </layout>
    </appender>

  <!-- 根loggr -->
    <root>
        <appender-ref ref="CONSOLE" />
        <appender-ref ref="xxxx_file" />
        <appender-ref ref="xxxx_file_error" />
    </root>
</log4j:configuration>

六. Logback配置文件示例

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration>

<configuration>
    <jmxConfigurator />

    <!-- 控制檯輸出日誌 -->
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <layout class="ch.qos.logback.classic.PatternLayout">
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
        </layout>
    </appender>

    <!-- 文件輸出日誌 (文件大小策略進行文件輸出，超過指定大小對文件備份)-->
    <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <File>xxxx.log</File>
        <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
            <FileNamePattern>xxxx.log.%i.bak</FileNamePattern>
            <MinIndex>1</MinIndex>
            <MaxIndex>12</MaxIndex>
        </rollingPolicy>

        <triggeringPolicy
            class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
            <MaxFileSize>100MB</MaxFileSize>
        </triggeringPolicy>
        <layout class="ch.qos.logback.classic.PatternLayout">
            <Pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</Pattern>
        </layout>
    </appender>

    <appender name="FILE-ERROR" class="ch.qos.logback.core.rolling.RollingFileAppender">
         <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>ERROR</level>
            <OnMismatch>DENY</OnMismatch>
            <OnMatch>ACCEPT</OnMatch>
        </filter>

        <File>xxxx-err.log</File>
        <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
            <FileNamePattern>xxxx-err.log.%i.bak</FileNamePattern>
            <MinIndex>1</MinIndex>
            <MaxIndex>3</MaxIndex>
        </rollingPolicy>
        <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
            <MaxFileSize>100MB</MaxFileSize>
        </triggeringPolicy>
        <layout class="ch.qos.logback.classic.PatternLayout">
            <Pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</Pattern>
        </layout>
    </appender>

  <!--這裏指定logger name 是爲jmx設置日誌級別做鋪墊 -->
    <logger name="com.xxx.xxx">
        <level value="INFO" />
        <appender-ref ref="STDOUT" />
        <appender-ref ref="FILE" />
        <appender-ref ref="FILE-ERROR" />
    </logger>



</configuration>

七. 相關簡單說明
 Log4j
Log4j是Apache的一個開放源代碼項目，通過使用Log4j，我們可以控制日誌信息輸送的目的地是控制檯、文件、GUI組件、甚至是套接口服務 器、NT的事件記錄器、UNIX Syslog守護進程等；用戶也可以控制每一條日誌的輸出格式；通過定義每一條日誌信息的級別，用戶能夠更加細緻地控制日誌的生成過程。這些可以通過一個 配置文件來靈活地進行配置，而不需要修改程序代碼

 Slf4j
簡單日記門面(Facade)SLF4J是爲各種loging APIs提供一個簡單統一的接口，從而使得最終用戶能夠在部署的時候配置自己希望的loging APIs實現。 Logging API實現既可以選擇直接實現SLF4J接的loging APIs如： NLOG4J、SimpleLogger。也可以通過SLF4J提供的API實現來開發相應的適配器如Log4jLoggerAdapter、JDK14LoggerAdapter。

 Logback
Logback是由log4j創始人設計的又一個開源日記組件。logback當前分成三個模塊：logback-core,logback- classic和logback-access。logback-core是其它兩個模塊的基礎模塊。logback-classic是log4j的一個 改良版本。此外logback-classic完整實現SLF4J API使你可以很方便地更換成其它日記系統如log4j或JDK14 Logging。logback-access訪問模塊與Servlet容器集成提供通過Http來訪問日記的功能。