紙飛機(jī)

Commons-logging + Log4j  入門(mén)指南

原創(chuàng)：莊曉立（liigo）

www.liigo.com

2005-8-13

為什么要用日志（Log）?

這個(gè)……就不必說(shuō)了吧。

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

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

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

Commons-loggin的目的是為“所有的Java日志實(shí)現(xiàn)”提供一個(gè)統(tǒng)一的接口，它自身的日志功能平常弱（只有一個(gè)簡(jiǎn)單的SimpleLog?），所以一般不會(huì)單獨(dú)使用它。

Log4j的功能非常全面強(qiáng)大，是目前的首選。我發(fā)現(xiàn)幾乎所有的Java開(kāi)源項(xiàng)目都會(huì)用到Log4j，但我同時(shí)發(fā)現(xiàn)，所有用到Log4j的項(xiàng)目一般也同時(shí)會(huì)用到commons-loggin。我想，大家都不希望自己的項(xiàng)目與Log4j綁定的太緊密吧。另外一個(gè)我能想到的“同時(shí)使用commons-logging和Log4j”的原因是，簡(jiǎn)化使用和配置。

       強(qiáng)調(diào)一點(diǎn)，“同時(shí)使用commons-logging和Log4j”，與“單獨(dú)使用Log4j”相比，并不會(huì)帶來(lái)更大的學(xué)習(xí)、配置和維護(hù)成本，反而更加簡(jiǎn)化了我們的工作。我想這也是為什么“所有用到Log4j的項(xiàng)目一般也同時(shí)會(huì)用到commons-loggin”的原因之一吧。

Commons-logging能幫我們做什么？

l         提供一個(gè)統(tǒng)一的日志接口，簡(jiǎn)單了操作，同時(shí)避免項(xiàng)目與某個(gè)日志實(shí)現(xiàn)系統(tǒng)緊密a耦合

l         很貼心的幫我們自動(dòng)選擇適當(dāng)?shù)娜罩緦?shí)現(xiàn)系統(tǒng)（這一點(diǎn)非常好！）

l         它甚至不需要配置

這里看一下它怎么“‘很貼心的’幫我們‘自動(dòng)選擇’‘適當(dāng)?shù)?#8217;日志實(shí)現(xiàn)系統(tǒng)”：

1)        首先在classpath下尋找自己的配置文件commons-logging.properties，如果找到，則使用其中定義的Log實(shí)現(xiàn)類(lèi)；

2)        如果找不到commons-logging.properties文件，則在查找是否已定義系統(tǒng)環(huán)境變量org.apache.commons.logging.Log，找到則使用其定義的Log實(shí)現(xiàn)類(lèi)；

3)        否則，查看classpath中是否有Log4j的包，如果發(fā)現(xiàn)，則自動(dòng)使用Log4j作為日志實(shí)現(xiàn)類(lèi)；

4)        否則，使用JDK自身的日志實(shí)現(xiàn)類(lèi)（JDK1.4以后才有日志實(shí)現(xiàn)類(lèi)）；

5)        否則，使用commons-logging自己提供的一個(gè)簡(jiǎn)單的日志實(shí)現(xiàn)類(lèi)SimpleLog；

（以上順序不保證完全準(zhǔn)確，請(qǐng)參考官方文檔）

可見(jiàn)，commons-logging總是能找到一個(gè)日志實(shí)現(xiàn)類(lèi)，并且盡可能找到一個(gè)“最合適”的日志實(shí)現(xiàn)類(lèi)。我說(shuō)它“很貼心”實(shí)際上是因?yàn)椋?font face="Times New Roman">1、可以不需要配置文件；2、自動(dòng)判斷有沒(méi)有Log4j包，有則自動(dòng)使用之；3、最悲觀(guān)的情況下也總能保證提供一個(gè)日志實(shí)現(xiàn)（SimpleLog）。

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

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

就這么簡(jiǎn)單！

代碼應(yīng)該怎么寫(xiě)？

我們?cè)谛枰敵鋈罩拘畔⒌?#8220;每一人”類(lèi)中做如下的三個(gè)工作：

1、導(dǎo)入所有需的commongs-logging類(lèi)：

import org.apache.commons.logging.Log;

import org.apache.commons.logging.LogFactory;

如果愿意簡(jiǎn)化的話(huà)，還可以?xún)尚泻蠟橐恍校?/font>

LogFactory.getLog()方法的參數(shù)使用的是當(dāng)前類(lèi)的class，這是目前被普通認(rèn)為的最好的方式。為什么不寫(xiě)作LogFactory.getLog(this.getClass())？因?yàn)?font face="Times New Roman">static類(lèi)成員訪(fǎng)問(wèn)不到this指針！

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

log.debug("111");

log.info("222");

log.warn("333");

log.error("444");

log.fatal("555");

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

l         debug()   輸出“調(diào)試”級(jí)別的日志信息；

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

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

l         error()     輸出“錯(cuò)誤”級(jí)別的日志信息；

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

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

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

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

上面所介紹的方法是目前被普通應(yīng)用的，可以說(shuō)是被標(biāo)準(zhǔn)化了的方法，幾乎所有的人都是這么用。如果不信，或想確認(rèn)一下，就去下載幾個(gè)知名的Java開(kāi)源項(xiàng)目源代碼看一下吧。

下面給出一個(gè)完整的Java類(lèi)的代碼：

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中，上述代碼肯定可以很順利的編譯通過(guò)。那它的執(zhí)行結(jié)果是怎么樣的呢？恐怕會(huì)有很大的不同，請(qǐng)繼續(xù)往下看。

Log4j在哪里呢？它發(fā)揮作用了嗎？

應(yīng)該注意到，我們上面給出的源代碼，完全沒(méi)有涉及到Log4j——這正是我們所希望的，這也正是commons-logging所要達(dá)到的目標(biāo)之一。

可是，怎么才能讓Log4j發(fā)揮它的作用呢？答案很簡(jiǎn)單，只需滿(mǎn)足“classpath中有Log4j的jar包”。前面已經(jīng)說(shuō)過(guò)了，commons-logging會(huì)自動(dòng)發(fā)現(xiàn)并應(yīng)用Log4j。所以只要它存在，它就發(fā)揮作用。（它不存在呢？自然就不發(fā)揮作用，commons-logging會(huì)另行選擇其它的日志實(shí)現(xiàn)類(lèi)。）

注意：配置文件log4j.properties對(duì)Log4j來(lái)說(shuō)是必須的。如果classpath中沒(méi)有該配置文件，或者配置不對(duì)，將會(huì)引發(fā)運(yùn)行時(shí)異常。

       這樣，要正確地應(yīng)用Log4j輸出日志信息，log4j.properties的作用就很重要了。好在該文件有通用的模板，復(fù)制一份（稍加修改）就可以使用。幾乎每一個(gè)Java項(xiàng)目目錄內(nèi)都會(huì)有一個(gè)log4j.properties文件，可下載幾個(gè)Java開(kāi)源項(xiàng)目源代碼查看。本文最后也附一個(gè)模板性質(zhì)的log4j.properties文件，直接復(fù)制過(guò)去就可以用，或者根據(jù)自己的需要稍加修改。后文將會(huì)log4j.properties文件適當(dāng)作一些介紹。

       這里順便提示一點(diǎn)：如果不用commons-logging，僅僅單獨(dú)使用Log4j，操作上反而要稍微麻煩一些，因?yàn)?font face="Times New Roman">Log4j需要多一點(diǎn)點(diǎn)的初始化代碼（相比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");

   }

}

不過(guò)也就多出一行。但這至少說(shuō)明，引用commons-logging并沒(méi)有使問(wèn)題復(fù)雜化，反而簡(jiǎn)單了一些。在這里1+1就小于2了。這也驗(yàn)證了前面的結(jié)論。

總結(jié)

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

采用Log4j配合commons-logging作為日志系統(tǒng)，是目前Java領(lǐng)域非常非常流行的模式，使用非常非常的普遍。兩者的結(jié)合帶來(lái)的結(jié)果就是：簡(jiǎn)單 + 強(qiáng)大。

commons-logging提供了簡(jiǎn)捷、統(tǒng)一的接口，不需要額外配置，簡(jiǎn)單；

Log4j功能非常全面、強(qiáng)大；

commons-logging僅僅對(duì)Log4j(當(dāng)然還包括其它LOG實(shí)現(xiàn))作了一層包裝，具體的日志輸出還是在內(nèi)部轉(zhuǎn)交給身后的Log4j來(lái)處理；而Log4j雖然做了所有的事情，卻甘作綠葉，從不以真身示人。

兩者堪稱(chēng)絕配。

對(duì)log4j.properties的一點(diǎn)介紹

下面對(duì)log4j.properties文件內(nèi)容作一點(diǎn)點(diǎn)介紹，以后文所附log4j.properties文件為例：

除去以#開(kāi)頭的注釋以及空行，第一行有用的內(nèi)容是：

log4j.rootLogger = DEBUG, CONSOLE,A1

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

關(guān)鍵看“=”后面的值，“DEBUG, CONSOLE,A1”這里我們要把它分成兩部分：第一個(gè)逗號(hào)之前的是第一部分，指定“輸出級(jí)別”；后面的是第二部分，指定“輸出目的地”。可以同時(shí)指定多個(gè)“輸出目的地”，以逗號(hào)隔開(kāi)。

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

注意：

l         “輸出級(jí)別”有可選的五個(gè)值，分別是DEBUG、INFO、WARN、ERROR、FATAL，它們是由Log4j系統(tǒng)定義的。

l         “輸出目的地”就是我們自己定義的了，就在log4j.properties的后面部分，此文件定義的“輸出目的地”有CONSOLE、FILE、ROLLING_FILE、SOCKET、LF5_APPENDER、MAIL、DATABASE、A1、im。該文件之所以可作主模板，就是因?yàn)樗容^全面地定義了各種常見(jiàn)的輸出目的地（控制臺(tái)、文件、電子郵件、數(shù)據(jù)庫(kù)等）。

好，下面詳細(xì)解釋“log4j.rootLogger=DEBUG, CONSOLE,A1”這一行：

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

l         指定“輸出目的地”是“CONSOLE”和“A1”，即，將指定的日志信息（根據(jù)日志級(jí)別已進(jìn)行了過(guò)濾）同時(shí)輸出到的“控制臺(tái)”和“SampleMessages.log4j文件”。

為什么說(shuō)“CONSOLE”表示將日志信息輸出到“控制臺(tái)”呢？那就要看一下后文的定義了：

# 應(yīng)用于控制臺(tái)

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

為什么說(shuō)“A1”表示將日志信息輸出到“SampleMessages.log4j文件”呢？還要看后文的定義：

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

注意：這里的定義沒(méi)有指定輸出文件的路徑，它的路徑實(shí)際上是 java.user.path的值。

您應(yīng)該已經(jīng)注意到，在定義“輸出目的地”時(shí)，還可以指定日志格式、時(shí)間、布局等相關(guān)信息。略過(guò)。

好了，我可以根據(jù)需要，將這一行修改為：

log4j.rootLogger = ERROR, CONSOLE,FILE,MAIL

將“錯(cuò)誤（ERROR）”及“致命錯(cuò)誤（FATAL）”級(jí)別的日志信息同時(shí)輸出到控制臺(tái)、文件，并且發(fā)電子郵件向系統(tǒng)管理員報(bào)告。是不是很爽？（如果將“調(diào)試（DEBUG）”級(jí)別的日志信息郵件給管理員，恐怕遲早會(huì)把他/她的郵箱漲爆，哪怕用的是Gmail！再次理解了“將日志信息分為不同級(jí)別”的意圖了吧？）

附：一個(gè)有用的log4j.properties文件模板

##Log4J的配置之簡(jiǎn)單使它遍及于越來(lái)越多的應(yīng)用中了

##Log4J配置文件實(shí)現(xiàn)了輸出到控制臺(tái)、文件、回滾文件、發(fā)送日志郵件、輸出到數(shù)據(jù)庫(kù)日志表、自定義標(biāo)簽等全套功能。擇其一二使用就夠用了。

##此文件（log4j.properties）內(nèi)容來(lái)自網(wǎng)絡(luò)，非本文作者liigo原創(chuàng)。
 log4j.rootLogger=DEBUG, CONSOLE,A1
log4j.addivity.org.apache=true

# 應(yīng)用于控制臺(tái)
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

#應(yīng)用于文件
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

 
# 應(yīng)用于文件回滾
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

#應(yīng)用于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

# 發(fā)送日志給郵件
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

# 用于數(shù)據(jù)庫(kù)
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
 
# 結(jié)束