一 :為什么同時(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)化使用和配置。
二 :Commons-logging能幫我們做什么?
提供一個(gè)統(tǒng)一的日志接口,簡(jiǎn)單了操作,同時(shí)避免項(xiàng)目與某個(gè)日志實(shí)現(xiàn)系統(tǒng)緊密a耦合很貼心的幫我們自動(dòng)選擇適當(dāng)?shù)娜罩緦?shí)現(xiàn)系統(tǒng)(這一點(diǎn)非常好!)它甚至不需要配置
這里看一下它怎么“‘很貼心的’幫我們‘自動(dòng)選擇’‘適當(dāng)?shù)摹罩緦?shí)現(xiàn)系統(tǒng)”:
1) 首先在classpath下尋找自己的配置文件commons-logging.properties,如果找到,則使用其中定義的Log實(shí)現(xiàn)類;
2) 如果找不到commons-logging.properties文件,則在查找是否已定義系統(tǒng)環(huán)境變量org.apache.commons.logging.Log,找到則使用其定義的Log實(shí)現(xiàn)類;
建立一個(gè)叫 :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),則自動(dòng)使用Log4j作為日志實(shí)現(xiàn)類;
4) 否則,使用JDK自身的日志實(shí)現(xiàn)類(JDK1.4以后才有日志實(shí)現(xiàn)類);
5) 否則,使用commons-logging自己提供的一個(gè)簡(jiǎn)單的日志實(shí)現(xiàn)類SimpleLog;
(以上順序不保證完全準(zhǔn)確,請(qǐng)參考官方文檔)
可見(jiàn),commons-logging總是能找到一個(gè)日志實(shí)現(xiàn)類,并且盡可能找到一個(gè)“最合適”的日志實(shí)現(xiàn)類。我說(shuō)它“很貼心”實(shí)際上是因?yàn)椋?
1、可以不需要配置文件;
2、自動(dòng)判斷有沒(méi)有Log4j包,有則自動(dòng)使用之;
3、最悲觀的情況下也總能保證提供一個(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)該怎么寫?
我們?cè)谛枰敵鋈罩拘畔⒌摹懊恳蝗恕鳖愔凶鋈缦碌娜齻€(gè)工作:
1、導(dǎo)入所有需的commongs-logging類:
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
如果愿意簡(jiǎn)化的話,還可以兩行合為一行:
在自己的類中定義一個(gè)org.apache.commons.logging.Log類的私有靜態(tài)類成員:
private static Log log = LogFactory.getLog(YouClassName.class );
注意這里定義的是static成員,以避免產(chǎn)生多個(gè)實(shí)例。
LogFactory.getLog()方法的參數(shù)使用的是當(dāng)前類的class,這是目前被普通認(rèn)為的最好的方式。為什么不寫作LogFactory.getLog(this.getClass())?因?yàn)閟tatic類成員訪問(wèn)不到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,通過(guò)該類的成員方法,我們就可以將不同性質(zhì)的日志信息輸出到目的地(目的地是哪里?視配置可定,可能是stdout,也可能是文件,還可能是發(fā)送到郵件,甚至發(fā)送短信到手機(jī)……詳見(jiàn)下文對(duì)log4j.properties的介紹):
debug() 輸出“調(diào)試”級(jí)別的日志信息;
info() 輸出“信息”級(jí)別的日志信息;
warn() 輸出“警告”級(jí)別的日志信息;
error() 輸出“錯(cuò)誤”級(jí)別的日志信息;
fatal() 輸出“致命錯(cuò)誤”級(jí)別的日志信息
Log4j在哪里呢?它發(fā)揮作用了嗎?
應(yīng)該注意到,我們上面給出的源代碼,完全沒(méi)有涉及到Log4j——這正是我們所希望的,這也正是commons-logging所要達(dá)到的目標(biāo)之一。
可是,怎么才能讓Log4j發(fā)揮它的作用呢?答案很簡(jiǎ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)類。)
注意:配置文件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)?span id="wmqeeuq" class="hilite2" twffan="done">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雖然做了所有的事情,卻甘作綠葉,從不以真身示人。
兩者堪稱絕配。
對(duì)log4j.properties的一點(diǎn)介紹
下面對(duì)log4j.properties文件內(nèi)容作一點(diǎn)點(diǎn)介紹,以后文所附log4j.properties文件為例:
除去以#開(kāi)頭的注釋以及空行,第一行有用的內(nèi)容是:
1 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”。
注意:
“輸出級(jí)別”有可選的五個(gè)值,分別是DEBUG、INFO、WARN、ERROR、FATAL,它們是由Log4j系統(tǒng)定義的。
“輸出目的地”就是我們自己定義的了,就在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”這一行:
指定“輸出級(jí)別”是“DEBUG”,即,僅輸出級(jí)別大于等于“調(diào)試(DEBUG)”的日志信息。如果此處指定的是“WARN”則僅調(diào)用warn()、error()、fatal()方法輸出的日志信息才被輸出到“輸出目的地”,而調(diào)用debug()、info()方法輸出的日志信息不被輸出到“輸出目的地”。明白了嗎?Log4j就是以這種方式來(lái)過(guò)濾控制日志信息的輸出與否,這也是對(duì)日志信息進(jìn)行級(jí)別分類的目的。
指定“輸出目的地”是“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文件”呢?還要看后文的定義:
灰色的行就是標(biāo)題,log4J配置文件默認(rèn)的讀取方式是ISO-88591,遇到中文會(huì)出現(xiàn)亂碼,我們可以把這個(gè)配置文件log4j.properties用jdk的工具native2asii轉(zhuǎn)換一下編碼方式。
命令:native2asii log4j.properties log4jxx.properties
把這個(gè)log4jxx.properties改名為log4j.properties取代原來(lái)的log4j.properties就ok了。
灰色行重新編碼后是:
log4j.appender.MAIL.Subject=Log4J\u63d0\u9192\u60a8\uff1a\u7cfb\u7edf\u53d1\u751f\u4e86\u4e25\u91cd\u9519\u8bef
二、 正文亂碼
正文亂碼,解決也比較簡(jiǎn)單。閱讀Log4J的源碼類SMTPAppender,我們可以發(fā)現(xiàn)sendBuffer()方法中有這樣一句:
part.setContent(sbuf.toString(), layout.getContentType());
我們繼續(xù)追蹤發(fā)現(xiàn)layout就是配置文件里的layout屬性對(duì)應(yīng)的布局模式。但是這些布局模式都是繼承自Layout,而contentType是只可通過(guò)getContentType方法取得,不能修改。所有的布局模式getContentType方法返回的都是”text/plain”;
為處理中文亂碼,我們可以寫一個(gè)布局模式。如果你要使用HTMLLayout,我們就寫一個(gè)HTMLLayout的子類,覆蓋HTMLLayout的getContentType方法即可。假如我要用org.apache.log4j.HTMLLayout。我們就可以寫一個(gè)DefineLayOut類,代碼如下: