hejiaming的博客

一、commons-logging和Log4j
Commons-loggin的目的是為“所有的Java日志實現(xiàn)”提供一個統(tǒng)一的接口，它自身的日志功能平常弱（只有一個簡單的SimpleLog?），所以一般不會單獨使用它。Log4j的功能非常全面強(qiáng)大，是目前的首選。我發(fā)現(xiàn)幾乎所有的Java開源項目都會用到Log4j，但我同時發(fā)現(xiàn)，所有用到Log4j的項目一般也同時會用到commons-loggin。我想，大家都不希望自己的項目與Log4j綁定的太緊密吧。另外一個我能想到的“同時使用commons-logging和Log4j”的原因是，簡化使用和配置。

二、Commons-logging能幫我們做什么？

提供一個統(tǒng)一的日志接口，簡單了操作，同時避免項目與某個日志實現(xiàn)系統(tǒng)緊密的耦合，很貼心的幫我們自動選擇適當(dāng)?shù)娜罩緦崿F(xiàn)系統(tǒng)(如log4j,JDK自身的日志實現(xiàn)類,SimpleLog)它甚至不需要配置

說明如下：

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

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


建立一個叫 ：CATALINA_OPTS 的環(huán)境變量
給他的值 ： - Dorg.apache.commons.logging.Log = org.apache.commons.logging.impl.SimpleLog  - Dorg.apache.commons.logging.simplelog.defaultlog = warn

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

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

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

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

可見，commons-logging總是能找到一個日志實現(xiàn)類，并且盡可能找到一個“最合適”的日志實現(xiàn)類。我說它“很貼心”實際上是因為：

1、可以不需要配置文件；
2、自動判斷有沒有Log4j包，有則自動使用之；
3、最悲觀的情況下也總能保證提供一個日志實現(xiàn)（SimpleLog）。


可以看到，commons-logging對編程者和Log4j都非常友好。
三、Commons-logging結(jié)合Log4j

只需將Log4j的Jar包和log4j.properties放置到classpash中就可以了。這樣就很簡單地完成了commons-logging與Log4j的融合。如果不想用Log4j了怎么辦？只需將classpath中的Log4j的Jar包刪除即可。就這么簡單！

具體代碼如下：

 1package  liigo.testlog;   

 2    

 3import  org.apache.commons.logging.Log;    

 4import  org.apache.commons.logging.LogFactory;   

 5  

 6public   class  TestLog  {   

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

 8 public   void  test()   {   

 9 log.debug( " 111 " );   

10log.info( " 222 " );   

11log.warn( " 333 " );   

12log.error(warnStr, exception);   

13log.fatal( " 555 " );   

14}    

15  

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

17TestLog testLog  =   new  TestLog();   

18testLog.test();   

19}    

20}   

應(yīng)該注意到，我們上面給出的源代碼，完全沒有涉及到Log4j——這正是我們所希望的，這也正是commons-logging所要達(dá)到的目標(biāo)之一。
可是，怎么才能讓Log4j發(fā)揮它的作用呢？答案很簡單，只需滿足“classpath中有Log4j的jar包”。前面已經(jīng)說過了，commons-logging會自動發(fā)現(xiàn)并應(yīng)用Log4j。所以只要它存在，它就發(fā)揮作用。（它不存在呢？自然就不發(fā)揮作用，commons-logging會另行選擇其它的日志實現(xiàn)類。）

四、單獨使用Log4j


總結(jié)
將commons-logging和Log4j的jar包都放置到classpath下，同時也將Log4j的配置文件放到classpath中，兩者就可以很好的合作。
采用Log4j配合commons-logging作為日志系統(tǒng)，是目前Java領(lǐng)域非常非常流行的模式，使用非常非常的普遍。兩者的結(jié)合帶來的結(jié)果就是：簡單 + 強(qiáng)大。

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

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

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

兩者堪稱絕配。

五、對log4j.properties的一點介紹

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

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

1  log4j.rootLogger  =  DEBUG, CONSOLE,A1
log4j.rootLogger是最最重要的一個屬性了，它定義日志信息的“輸出級別”和“輸出目的地”。
關(guān)鍵看“=”后面的值，“DEBUG, CONSOLE,A1”這里我們要把它分成兩部分：第一個逗號之前的是第一部分，指定“輸出級別”；后面的是第二部分，指定“輸出目的地”。可以同時指定多個“輸出目的地”，以逗號隔開。
具體到上面這一行：它指定的“輸出級別”是“DEBUG”；它指定的“輸出目的地”是“CONSOLE”和“A1”。

注意：

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

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

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

        指定“輸出級別”是“DEBUG”，即，僅輸出級別大于等于“調(diào)試（DEBUG）”的日志信息。如果此處指定的是“WARN”則僅調(diào)用warn()、error()、fatal()方法輸出的日志信息才被輸出到“輸出目的地”，而調(diào)用debug()、info()方法輸出的日志信息不被輸出到“輸出目的地”。明白了嗎？Log4j就是以這種方式來過濾控制日志信息的輸出與否，這也是對日志信息進(jìn)行級別分類的目的。
        指定“輸出目的地”是“CONSOLE”和“A1”，即，將指定的日志信息（根據(jù)日志級別已進(jìn)行了過濾）同時輸出到的“控制臺”和“SampleMessages.log4j文件”。


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

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

1  log4j.appender.CONSOLE = org.apache.log4j.ConsoleAppender
2 log4j.appender.Threshold = DEBUG
3 log4j.appender.CONSOLE.Target = System.out
4 log4j.appender.CONSOLE.layout = org.apache.log4j.PatternLayout
5 log4j.appender.CONSOLE.layout.ConversionPattern = [framework]  % d  -   % c  -%- 4r [ % t]  %- 5p  % c  % x  -   % m % n
6  #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 
為什么說“A1”表示將日志信息輸出到“SampleMessages.log4j文件”呢？還要看后文的定義：

1  log4j.appender.A1 = org.apache.log4j.DailyRollingFileAppender
2 log4j.appender.A1.File = SampleMessages.log4j
3 log4j.appender.A1.DatePattern = yyyyMMdd - HH ' .log4j ' 
4 log4j.appender.A1.layout = org.apache.log4j.xml.XMLLayout 
注意：這里的定義沒有指定輸出文件的路徑，它的路徑實際上是 java.user.path的值。
您應(yīng)該已經(jīng)注意到，在定義“輸出目的地”時，還可以指定日志格式、時間、布局等相關(guān)信息。略過。

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

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

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


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

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

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

# 應(yīng)用于控制臺
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 = FATA
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ù)庫
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é)束

Log4J發(fā)日志郵件給多個接收者及標(biāo)題、正文亂碼問題

以前開發(fā)的系統(tǒng)沒有單獨的日志管理，所有的日志統(tǒng)一輸出到tomcat后臺一個文件里，不幾天就是好幾G，現(xiàn)在要整體增加一個Log4J管理日志的功能，其實這方面的資料網(wǎng)上多的是。發(fā)郵件的配置說明也有，但是具體怎么發(fā)，亂碼問題怎么解決那就比較少了。
       利用javamail發(fā)送郵件，你需要導(dǎo)入包mail.jar和activation.jar這兩個包 ，否則是沒法發(fā)郵件的 ，下邊配置文件里綠色行顯示的就是發(fā)給兩個接收者ac和ae。

       這里會出現(xiàn)中文亂碼問題，主要有兩方面的亂碼，一是標(biāo)題亂碼；二是正文亂碼。下邊具體說明這兩種亂碼的解決方案。
一、 標(biāo)題亂碼
Log4J日志郵件的標(biāo)題在配置文件log4j.properties里設(shè)定，如下
log4j.appender.MAIL=org.apache.log4j.net.SMTPAppender
log4j.appender.MAIL.Threshold=FATAL
log4j.appender.MAIL.BufferSize=10
log4j.appender.MAIL.From=ab@163.com
log4j.appender.MAIL.SMTPHost=smtp@163.com
log4j.appender.MAIL.Subject= Log4J提醒您：系統(tǒng)發(fā)生了嚴(yán)重錯誤 log4j.appender.MAIL.To=ac@163.com,ae@163.com
log4j.appender.MAIL.layout=com.sun.DefineLayOut
log4j.appender.MAIL.layout.LocationInfo=true

       綠色的行就是標(biāo)題，log4J配置文件默認(rèn)的讀取方式是ISO-88591，遇到中文會出現(xiàn)亂碼，我們可以把這個配置文件log4j.properties用jdk的工具native2asii轉(zhuǎn)換一下編碼方式。
命令：native2asii log4j.properties log4jxx.properties
把這個log4jxx.properties改名為log4j.properties取代原來的log4j.properties就ok了。
灰色行重新編碼后是：
log4j.appender.MAIL.Subject=Log4J\u63d0\u9192\u60a8\uff1a\u7cfb\u7edf\u53d1\u751f\u4e86\u4e25\u91cd\u9519\u8bef

二、 正文亂碼
        正文亂碼，解決也比較簡單。閱讀Log4J的源碼類SMTPAppender，我們可以發(fā)現(xiàn)sendBuffer()方法中有這樣一句：
part.setContent(sbuf.toString(), layout.getContentType());
我們繼續(xù)追蹤發(fā)現(xiàn)layout就是配置文件里的layout屬性對應(yīng)的布局模式。但是這些布局模式都是繼承自Layout，而contentType是只可通過getContentType方法取得，不能修改。所有的布局模式getContentType方法返回的都是”text/plain”；
為處理中文亂碼，我們可以寫一個布局模式。如果你要使用HTMLLayout，我們就寫一個HTMLLayout的子類，覆蓋HTMLLayout的getContentType方法即可。假如我要用org.apache.log4j.HTMLLayout。我們就可以寫一個DefineLayOut類，代碼如下：
package com.sun;

import org.apache.log4j.HTMLLayout;
public class DefineLayOut extends HTMLLayout{
public String getContentType() {
return "text/html;charset=GBK";
}
}
對應(yīng)的配置文件設(shè)置如紅色行所示。