log4j使用示例
--byblues(zhaochaohua@sina.com)
PART1介紹
log4j的好處在于:
1.通過修改配置文件,就可以決定log信息輸出到何處(console,文件,...),是否輸出。
這樣,在系統(tǒng)開發(fā)階段可以打印詳細的log信息以跟蹤系統(tǒng)運行情況,而在系統(tǒng)穩(wěn)定后可以關(guān)閉log輸出,從而在能跟蹤系統(tǒng)運行情況的同時,又減少了垃圾代碼(System.out.println(...)等)。
2.使用log4j,需要整個系統(tǒng)有一個統(tǒng)一的log機制,有利于系統(tǒng)的規(guī)劃。
log4j的使用本身很簡單。但合理地規(guī)劃一個系統(tǒng)的統(tǒng)一log機制需要周全的考慮。
其他關(guān)于log4j的信息參看log4j自帶的文檔。
PARTII配置文件詳細解釋
先看一個配置文件的例子:
1.配置文件的例子
log4j.rootLogger=DEBUG
#將DAO層log記錄到DAOLog,allLog中
log4j.logger.DAO=DEBUG,A2,A4
#將邏輯層log記錄到BusinessLog,allLog中
log4j.logger.Businesslog=DEBUG,A3,A4
#A1--打印到屏幕上
log4j.appender.A1=org.apache.log4j.ConsoleAppender
log4j.appender.A1.layout=org.apache.log4j.PatternLayout
log4j.appender.A1.layout.ConversionPattern=%-5p[%t]%37c%3x-%m%n
#A2--打印到文件DAOLog中--專門為DAO層服務(wù)
log4j.appender.A2=org.apache.log4j.DailyRollingFileAppender
log4j.appender.A2.file=DAOLog
log4j.appender.A2.DatePattern='.'yyyy-MM-dd
log4j.appender.A2.layout=org.apache.log4j.PatternLayout
log4j.appender.A2.layout.ConversionPattern=[%-5p]%d{yyyy-MM-ddHH:mm:ss,SSS}method:%l%n%m%n
#A3--打印到文件BusinessLog中--專門記錄邏輯處理層服務(wù)log信息
log4j.appender.A3=org.apache.log4j.DailyRollingFileAppender
log4j.appender.A3.file=BusinessLog
log4j.appender.A3.DatePattern='.'yyyy-MM-dd
log4j.appender.A3.layout=org.apache.log4j.PatternLayout
log4j.appender.A3.layout.ConversionPattern=[%-5p]%d{yyyy-MM-ddHH:mm:ss,SSS}method:%l%n%m%n
#A4--打印到文件alllog中--記錄所有l(wèi)og信息
log4j.appender.A4=org.apache.log4j.DailyRollingFileAppender
log4j.appender.A4.file=alllog
log4j.appender.A4.DatePattern='.'yyyy-MM-dd
log4j.appender.A4.layout=org.apache.log4j.PatternLayout
log4j.appender.A4.layout.ConversionPattern=[%-5p]%d{yyyy-MM-ddHH:mm:ss,SSS}method:%l%n%m%n
2.Appender的使用
一個Appender代表log信息要寫向的一個地方。log4j可使用的Appender有很多類型,這里只考慮3種:ConsoleAppender,FileAppender,DailyRollFileAppender
2.1ConsoleAppender
如果使用ConsoleAppender,那么log信息將寫到Console。就是直接把信息打印到System.out上了。
2.2FileAppender
使用FileAppender,那么log信息將寫到指定的文件中。這應(yīng)該是比較經(jīng)常使用到的情況。
相應(yīng)地,在配置文件中應(yīng)該指定log輸出的文件名。如下配置指定了log文件名為demo.txt
log4j.appender.A2.File=demo.txt
注意將A2替換為具體配置中Appender的別名。
2.3DailyRollingAppender
使用FileAppender可以將log信息輸出到文件中,但是如果文件太大了讀起來就不方便了。這時就可以使用DailyRollingAppender。DailyRollingAppender可以把Log信息輸出到按照日期來區(qū)分的文件中。如下配置文件就會每天產(chǎn)生一個log文件,每個log文件只記錄當天的log信息:
log4j.appender.A2=org.apache.log4j.DailyRollingFileAppender
log4j.appender.A2.file=demo
log4j.appender.A2.DatePattern='.'yyyy-MM-dd
log4j.appender.A2.layout=org.apache.log4j.PatternLayout
log4j.appender.A2.layout.ConversionPattern=%m%n
3.Layout的配置
Layout指定了log信息輸出的樣式。
詳細信息請查看PatternLayout的javadoc。
例子1:顯示日期和log信息
log4j.appender.A2.layout=org.apache.log4j.PatternLayout
log4j.appender.A2.layout.ConversionPattern=%d{yyyy-MM-ddHH:mm:ss,SSS}%m%n
打印的信息是:
2002-11-1211:49:42,866SELECT*FROMRoleWHERE1=1orderbycreateDatedesc
例子2:顯示日期,log發(fā)生地方和log信息
log4j.appender.A2.layout=org.apache.log4j.PatternLayout
log4j.appender.A2.layout.ConversionPattern=%d{yyyy-MM-ddHH:mm:ss,SSS}%l"#"%m%n
2002-11-1211:51:46,313cn.net.unet.weboa.system.dao.RoleDAO.select(RoleDAO.java:409)"#"SELECT*FROMRoleWHERE1=1orderbycreateDatedesc
例子3:顯示log級別,時間,調(diào)用方法,log信息
log4j.appender.A2.layout=org.apache.log4j.PatternLayout
log4j.appender.A2.layout.ConversionPattern=[%-5p]%d{yyyy-MM-ddHH:mm:ss,SSS}method:%l%n%m%n
log信息:
[DEBUG]2002-11-1212:00:57,376method:cn.net.unet.weboa.system.dao.RoleDAO.select(RoleDAO.java:409)
SELECT*FROMRoleWHERE1=1orderbycreateDatedesc
PART3log4j的使用
log4j使用步驟有3個:
3.1.根據(jù)配置文件初始化log4j
配置文件如PART2所敘述。現(xiàn)在講的是如何在程序中配置log4j。
log4j可以使用3中配置器來初始化:BasicConfigurator,DOMConfigurator,PropertyConfigurator
這里用的是PropertyConfigurator。使用PropertyConfigurator適用于所有的系統(tǒng)。
如下的語句
PropertyConfigurator.configure("log4j.properties");
就以log4j.properties為配置文件初始化好了log4j環(huán)境。
注意一點:這個語句只需要在系統(tǒng)啟動的時候執(zhí)行一次。例如:在unetwebOA項目中可以這么用:
在ActionServlet的init()方法中調(diào)用一次。
publicclassActionServletextendsHttpServlet{
...
/**
*Initializeglobalvariables
*/
publicvoidinit()throwsServletException{
//初始化Action資源
try{
initLog4j();
...
}catch(IOExceptione){
thrownewServletException("LoadActionResisError");
}
}
...
protectedvoidinitLog4j(){
PropertyConfigurator.configure("log4j.properties");
}
...
}//endclassActionServlet
3.2在需要使用log4j的地方獲取Logger實例
如下是RoleDAO類中的使用例子:
staticLoggerlog=Logger.getLogger("DAO");
注意這里使用"DAO"標識符,那么對應(yīng)的在配置文件中對應(yīng)的配置信息如下:
#定義DAOLogger
log4j.logger.DAO=DEBUG,A2
#設(shè)置AppenderA2的屬性
log4j.appender.A2=org.apache.log4j.DailyRollingFileAppender
log4j.appender.A2.file=demo
log4j.appender.A2.DatePattern='.'yyyy-MM-dd
log4j.appender.A2.layout=org.apache.log4j.PatternLayout
log4j.appender.A2.layout.ConversionPattern=%-5p%d{yyyy-MM-ddHH:mm:ss}%l%n%m%n
publicclassRoleDAOextendsBaseDBObject
{
...
staticLoggerlog=Logger.getLogger("DAO");
...
publicBeanCollectionselectAll()throwsSQLException
{
StringBuffersql=newStringBuffer(SQLBUF_LEN);
sql.append("SELECT*FROM"+tableName+"orderbyroldId");
//System.out.println(sql.toString());
log.debug(sql);
...
}
...
}
3.3使用Logger對象的debug,info,fatal...方法
log.debug("itisthedebuginfo");
附件1:log4j的一個bug
當這樣使用時,DailyRollingFileAppender不能正確使用:
publicClassRoleDAO(){
staticLoggerlog=Logger.getLogger("DAO");
//在每一次newRoleDAO對象的時候都執(zhí)行一次configure()操作
publicRoleDAO(TransactionManagertransMgr)throwsSQLException
{
...
PropertyConfigurator.configure("log4j.properties");
...
}
publicvoidselect(){
...
//使用log4j進行l(wèi)og記錄
log.debug("...");
...
}
}
怎么解決:
在系統(tǒng)啟動時執(zhí)行一次PropertyConfigurator.configure("log4j.properties");
之后就不再執(zhí)行。
</script>