ASONG

為什么要用日志（ Log ） ?

這個……就不必說了吧。

為什么不用 System.out.println()?

功能太弱；不易于控制。如果暫時不想輸出了怎么辦？如果想輸出到文件怎么辦？如果想部分輸出怎么辦？……

為什么同時使用 commons-logging 和 Log4j? 為什么不僅使用其中之一？

Commons-loggin 的目的是為“所有的 Java 日志實現”提供一個統一的接口，它自身的日志功能平常弱（只有一個簡單的 SimpleLog? ），所以一般不會單獨使用它。

Log4j 的功能非常全面強大，是目前的首選。我發現幾乎所有的 Java 開源項目都會用到 Log4j ，但我同時發現，所有用到 Log4j 的項目一般也同時會用到 commons-loggin 。我想，大家都不希望自己的項目與 Log4j 綁定的太緊密吧。另外一個我能想到的“同時使用 commons-logging 和 Log4j ”的原因是，簡化使用和配置。

?????? 強調一點，“同時使用 commons-logging 和 Log4j ”，與“單獨使用 Log4j ”相比，并不會帶來更大的學習、配置和維護成本，反而更加簡化了我們的工作。 我想這也是為什么“所有用到 Log4j 的項目一般也同時會用到 commons-loggin ”的原因之一吧。

Commons-logging 能幫我們做什么？

l ???????? 提供一個統一的日志接口，簡單了操作，同時避免項目與某個日志實現系統緊密 a 耦合

l ???????? 很貼心的幫我們自動選擇適當的日志實現系統（這一點非常好！）

l ???????? 它甚至不需要配置

這里看一下它怎么“‘很貼心的’幫我們‘自動選擇’‘適當的’日志實現系統”：

1) ??????? 首先在 classpath 下尋找自己的配置文件 commons-logging.properties ，如果找到，則使用其中定義的 Log 實現類；

2) ??????? 如果找不到 commons-logging.properties 文件，則在查找是否已定義系統環境變量 org.apache.commons.logging.Log ，找到則使用其定義的 Log 實現類；

3) ??????? 否則，查看 classpath 中是否有 Log4j 的包，如果發現，則自動使用 Log4j 作為日志實現類；

4) ??????? 否則，使用 JDK 自身的日志實現類（ JDK1.4 以后才有日志實現類）；

5) ??????? 否則，使用 commons-logging 自己提供的一個簡單的日志實現類 SimpleLog ；

（以上順序不保證完全準確，請參考官方文檔）

可見， commons-logging 總是能找到一個日志實現類，并且盡可能找到一個“最合適”的日志實現類。我說它“很貼心”實際上是因為： 1 、可以不需要配置文件； 2 、自動判斷有沒有 Log4j 包，有則自動使用之； 3 、最悲觀的情況下也總能保證提供一個日志實現（ SimpleLog ）。

?????? 可以看到， commons-logging 對編程者和 Log4j 都非常友好。

?????? 為了簡化配置 commons-logging ，一般不使用 commons-logging 的配置文件，也不設置與 commons-logging 相關的系統環境變量，而只需將 Log4j 的 Jar 包放置到 classpash 中就可以了。這樣就很簡單地完成了 commons-logging 與 Log4j 的融合。 如果不想用 Log4j 了怎么辦？只需將 classpath 中的 Log4j 的 Jar 包刪除即可。

就這么簡單！

代碼應該怎么寫？

我們在需要輸出日志信息的“每一人”類中做如下的三個工作：

1 、導入所有需的 commongs-logging 類：

import org.apache.commons.logging.Log;

import org.apache.commons.logging.LogFactory;

如果愿意簡化的話，還可以兩行合為一行：

import org.apache.commons.logging.*;

2 、在自己的類中定義一個 org.apache.commons.logging.Log 類的私有靜態類成員：

private static Log log = LogFactory.getLog(YouClassName.class);

注意這里定義的是 static 成員，以避免產生多個實例。

LogFactory.getLog() 方法的參數使用的是當前類的 class ，這是目前被普通認為的最好的方式。為什么不寫作 LogFactory.getLog(this.getClass()) ？因為 static 類成員訪問不到 this 指針！

3 、使用 org.apache.commons.logging.Log 類的成員方法輸出日志信息：

log.debug("111");

log.info("222");

log.warn("333");

log.error("444");

log.fatal("555");

這里的 log ，就是上面第二步中定義的類成員變量，其類型是 org.apache.commons.logging.Log ，通過該類的成員方法，我們就可以將不同性質的日志信息輸出到目的地（目的地是哪里？視配置可定，可能是 stdout ，也可能是文件，還可能是發送到郵件，甚至發送短信到手機……詳見下文對 log4j.properties 的介紹）：

l ???????? debug()?? 輸出“調試”級別的日志信息；

l ???????? info()????? 輸出“信息”級別的日志信息；

l ???????? warn()??? 輸出“警告”級別的日志信息；

l ???????? error()???? 輸出“錯誤”級別的日志信息；

l ???????? fatal()????? 輸出“致命錯誤”級別的日志信息；

根據不同的性質，日志信息通常被分成不同的級別，從低到高依次是：“調試（ DEBUG ）”“信息（ INFO ）”“警告（ WARN ）”“錯誤（ ERROR ）”“致命錯誤（ FATAL ）”。 為什么要把日志信息分成不同的級別呢？這實際上是方便我們更好的控制它。比如，通過 Log4j 的配置文件，我們可以設置“輸出‘調試’及以上級別的日志信息”（即“調試”“信息”“警告”“錯誤”“致命錯誤”），這對項目開發人員可能是有用的；我們還可以設置“輸出“警告”及以上級別的日志信息”（即“警告”“錯誤”“致命錯誤”），這對項目最終用戶可能是有用的。

?????? 僅從字面上理解，也可以大致得出結論：最常用的應該是 debug() 和 info() ；而 warn() 、 error() 、 fatal() 僅在相應事件發生后才使用。

從上面三個步驟可以看出，使用 commons-logging 的日志接口非常的簡單，不需要記憶太多東西：僅僅用到了兩個類 Log, LogFactory ，并且兩個類的方法都非常少（后者只用到一個方法，前者經常用到的也只是上面第三步中列出的幾個），同時參數又非常簡單。

上面所介紹的方法是目前被普通應用的，可以說是被標準化了的方法，幾乎所有的人都是這么用。如果不信，或想確認一下，就去下載幾個知名的 Java 開源項目源代碼看一下吧。

下面給出一個完整的 Java 類的代碼：

package liigo.testlog;

import org.apache.commons.logging.Log;

import org.apache.commons.logging.LogFactory;

public class TestLog

{

??? private static Log log = LogFactory.getLog(TestLog.class);

??? public void test()

??? {

??????? log.debug("111");

??????? log.info("222");

??????? log.warn("333");

??????? log.error("444");

??????? log.fatal("555");

??? }

??? public static void main(String[] args)

??? {

??????? TestLog testLog = new TestLog();

??????? testLog.test();

??? }

}

只要保證 commons-logging 的 jar 包在 classpath 中，上述代碼肯定可以很順利的編譯通過。那它的執行結果是怎么樣的呢？恐怕會有很大的不同，請繼續往下看。

Log4j 在哪里呢？它發揮作用了嗎？

應該注意到，我們上面給出的源代碼，完全沒有涉及到 Log4j ——這正是我們所希望的，這也正是 commons-logging 所要達到的目標之一。

可是，怎么才能讓 Log4j 發揮它的作用呢？答案很簡單，只需滿足“ classpath 中有 Log4j 的 jar 包”。前面已經說過了， commons-logging 會自動發現并應用 Log4j 。所以只要它存在，它就發揮作用。（它不存在呢？自然就不發揮作用， commons-logging 會另行選擇其它的日志實現類。）

注意：配置文件 log4j.properties 對 Log4j 來說是必須的。如果 classpath 中沒有該配置文件，或者配置不對，將會引發運行時異常。

?????? 這樣，要正確地應用 Log4j 輸出日志信息， log4j.properties 的作用就很重要了。好在該文件有通用的模板，復制一份（稍加修改）就可以使用。幾乎每一個 Java 項目目錄內都會有一個 log4j.properties 文件，可下載幾個 Java 開源項目源代碼查看。本文最后也附一個模板性質的 log4j.properties 文件，直接復制過去就可以用，或者根據自己的需要稍加修改。后文將會 log4j.properties 文件適當作一些介紹。

?????? 這里順便提示一點：如果不用 commons-logging ，僅僅單獨使用 Log4j ，操作上反而要稍微麻煩一些，因為 Log4j 需要多一點點的初始化代碼（相比 commons-logging 而言）：

import org.apache.log4j.Logger;

import org.apache.log4j.PropertyConfigurator;

public class TestLog4j {

?? static Logger logger = Logger.getLogger(TestLog4j.class); //First step

?? public static void main(String args[]) {

????? PropertyConfigurator.configure("log4j.properties"); //Second step

????? logger.debug("Here is some DEBUG"); //Third step

????? logger.info("Here is some INFO");

????? logger.warn("Here is some WARN");

????? logger.error("Here is some ERROR");

????? logger.fatal("Here is some FATAL");

?? }

}

不過也就多出一行。但這至少說明，引用 commons-logging 并沒有使問題復雜化，反而簡單了一些。在這里 1+1 就小于 2 了。這也驗證了前面的結論。

總結

將 commons-logging 和 Log4j 的 jar 包都放置到 classpath 下，同時也將 Log4j 的配置文件放到 classpath 中，兩者就可以很好的合作。

采用 Log4j 配合 commons-logging 作為日志系統，是目前 Java 領域非常非常流行的模式，使用非常非常的普遍。兩者的結合帶來的結果就是：簡單 + 強大。

commons-logging 提供了簡捷、統一的接口，不需要額外配置，簡單；

Log4j 功能非常全面、強大；

commons-logging 僅僅對 Log4j( 當然還包括其它 LOG 實現 ) 作了一層包裝，具體的日志輸出還是在內部轉交給身后的 Log4j 來處理；而 Log4j 雖然做了所有的事情，卻甘作綠葉，從不以真身示人。

兩者堪稱絕配。

對 log4j.properties 的一點介紹

下面對 log4j.properties 文件內容作一點點介紹，以后文所附 log4j.properties 文件為例：

除去以 # 開頭的注釋以及空行，第一行有用的內容是：

log4j.rootLogger = DEBUG, CONSOLE,A1

log4j.rootLogger 是最最重要的一個屬性了，它定義日志信息的“輸出級別”和“輸出目的地”。

關鍵看“ = ”后面的值，“ DEBUG, CONSOLE,A 1 ” 這里我們要把它分成兩部分：第一個逗號之前的是第一部分，指定“輸出級別”；后面的是第二部分，指定“輸出目的地”。可以同時指定多個“輸出目的地”，以逗號隔開。

具體到上面這一行：它指定的“輸出級別”是“ DEBUG ”；它指定的“輸出目的地”是“ CONSOLE ”和“ A1 ”。

注意：

l ???????? “輸出級別”有可選的五個值，分別是 DEBUG 、 INFO 、 WARN 、 ERROR 、 FATAL ，它們是由 Log4j 系統定義的。

l ???????? “輸出目的地”就是我們自己定義的了，就在 log4j.properties 的后面部分，此文件定義的“輸出目的地”有 CONSOLE 、 FILE 、 ROLLING_FILE 、 SOCKET 、 LF5_APPENDER 、 MAIL 、 DATABASE 、 A1 、 im 。該文件之所以可作主模板，就是因為它比較全面地定義了各種常見的輸出目的地（控制臺、文件、電子郵件、數據庫等）。

好，下面詳細解釋“ log4j.rootLogger=DEBUG, CONSOLE,A 1 ” 這一行：

l???????? 指定“輸出級別”是“ DEBUG ”，即，僅輸出級別大于等于“調試（ DEBUG ）”的日志信息 。如果此處指定的是“ WARN ”則僅調用 warn() 、 error() 、 fatal() 方法輸出的日志信息才被輸出到“輸出目的地”，而調用 debug() 、 info() 方法輸出的日志信息不被輸出到“輸出目的地”。明白了嗎？ Log4j 就是以這種方式來過濾控制日志信息的輸出與否，這也是對日志信息進行級別分類的目的。

l???????? 指定“輸出目的地”是“ CONSOLE ”和“ A1 ”，即，將指定的日志信息（根據日志級別已進行了過濾）同時輸出到的“控制臺”和“ SampleMessages.log4j 文件”。

?

?

附：一個有用的 log4j.properties 文件模板

##Log4J 的配置之簡單使它遍及于越來越多的應用中了

##Log4J 配置文件實現了輸出到控制臺、文件、回滾文件、發送日志郵件、輸出到數據庫日志表、自定義標簽等全套功能。擇其一二使用就夠用了。

## 此文件（ log4j.properties ）內容來自網絡，非本文作者 liigo 原創。

log4j.rootLogger=DEBUG, CONSOLE,A1

log4j.addivity.org.apache=true

# 應用于控制臺

log4j.appender.CONSOLE=org.apache.log4j.ConsoleAppender

log4j.appender.Threshold=DEBUG

log4j.appender.CONSOLE.Target=System.out

log4j.appender.CONSOLE.layout=org.apache.log4j.PatternLayout

log4j.appender.CONSOLE.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n

#log4j.appender.CONSOLE.layout.ConversionPattern=[start]%d{DATE}[DATE]%n%p[PRIORITY]%n%x[NDC]%n%t[THREAD] n%c[CATEGORY]%n%m[MESSAGE]%n%n

# 應用于文件

log4j.appender.FILE=org.apache.log4j.FileAppender

log4j.appender.FILE.File=file.log

log4j.appender.FILE.Append=false

log4j.appender.FILE.layout=org.apache.log4j.PatternLayout

log4j.appender.FILE.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n

# Use this layout for LogFactor 5 analysis

# 應用于文件回滾

log4j.appender.ROLLING_FILE=org.apache.log4j.RollingFileAppender

log4j.appender.ROLLING_FILE.Threshold=ERROR

log4j.appender.ROLLING_FILE.File=rolling.log

log4j.appender.ROLLING_FILE.Append=true

log4j.appender.ROLLING_FILE.MaxFileSize=10KB

log4j.appender.ROLLING_FILE.MaxBackupIndex=1

log4j.appender.ROLLING_FILE.layout=org.apache.log4j.PatternLayout

log4j.appender.ROLLING_FILE.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n

# 應用于 socket

log4j.appender.SOCKET=org.apache.log4j.RollingFileAppender

log4j.appender.SOCKET.RemoteHost=localhost

log4j.appender.SOCKET.Port=5001

log4j.appender.SOCKET.LocationInfo=true

# Set up for Log Facter 5

log4j.appender.SOCKET.layout=org.apache.log4j.PatternLayout

log4j.appender.SOCET.layout.ConversionPattern=[start]%d{DATE}[DATE]%n%p[PRIORITY]%n%x[NDC]%n%t[THREAD]%n%c[CATEGORY]%n%m[MESSAGE]%n%n

# Log Factor 5 Appender

log4j.appender.LF5_APPENDER=org.apache.log4j.lf5.LF5Appender

log4j.appender.LF5_APPENDER.MaxNumberOfRecords=2000

# 發送日志給郵件

log4j.appender.MAIL=org.apache.log4j.net.SMTPAppender

log4j.appender.MAIL.Threshold=FATAL

log4j.appender.MAIL.BufferSize=10

log4j.appender.MAIL.From=web@www.wuset.com

log4j.appender.MAIL.SMTPHost=www.wusetu.com

log4j.appender.MAIL.Subject=Log4J Message

log4j.appender.MAIL.To=web@www.wusetu.com

log4j.appender.MAIL.layout=org.apache.log4j.PatternLayout

log4j.appender.MAIL.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n

# 用于數據庫

log4j.appender.DATABASE=org.apache.log4j.jdbc.JDBCAppender

log4j.appender.DATABASE.URL=jdbc:mysql://localhost:3306/test

log4j.appender.DATABASE.driver=com.mysql.jdbc.Driver

log4j.appender.DATABASE.user=root

log4j.appender.DATABASE.password=

log4j.appender.DATABASE.sql=INSERT INTO LOG4J (Message) VALUES ('[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n')

log4j.appender.DATABASE.layout=org.apache.log4j.PatternLayout

log4j.appender.DATABASE.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n

log4j.appender.A1=org.apache.log4j.DailyRollingFileAppender

log4j.appender.A1.File=SampleMessages.log4j

log4j.appender.A1.DatePattern=yyyyMMdd-HH'.log4j'

log4j.appender.A1.layout=org.apache.log4j.xml.XMLLayout

# 自定義 Appender

log4j.appender.im = net.cybercorlin.util.logger.appender.IMAppender

log4j.appender.im.host = mail.cybercorlin.net

log4j.appender.im.username = username

log4j.appender.im.password = password

log4j.appender.im.recipient = corlin@cybercorlin.net

log4j.appender.im.layout=org.apache.log4j.PatternLayout

log4j.appender.im.layout.ConversionPattern =[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n