log4j使用示例
--by blues(zhaochaohua@sina.com)
PART 1 介紹
log4j的好處在于：
1.通過修改配置文件，就可以決定log信息輸出到何處(console,文件,...),是否輸出。
這樣，在系統開發階段可以打印詳細的log信息以跟蹤系統運行情況,而在系統穩定后可以關閉log輸出,從而在能跟蹤系統運行情況的同時,又減少了垃圾代碼(System.out.println(...)等)。
2.使用log4j，需要整個系統有一個統一的log機制，有利于系統的規劃。
log4j的使用本身很簡單。但合理地規劃一個系統的統一log機制需要周全的考慮。
其他關于log4j的信息參看log4j自帶的文檔。
PART II 配置文件詳細解釋
先看一個配置文件的例子:
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層服務
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-dd HH:mm:ss,SSS} method:%l%n%m%n
#A3--打印到文件BusinessLog中--專門記錄邏輯處理層服務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-dd HH:mm:ss,SSS} method:%l%n%m%n
#A4--打印到文件alllog中--記錄所有log信息
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-dd HH:mm:ss,SSS} method:%l%n%m%n
2.Appender的使用
一個Appender代表log信息要寫向的一個地方。log4j可使用的Appender有很多類型,這里只考慮3種:ConsoleAppender,FileAppender,DailyRollFileAppender
2.1 ConsoleAppender
如果使用ConsoleAppender，那么log信息將寫到Console。就是直接把信息打印到System.out上了。
2.2 FileAppender
使用FileAppender，那么log信息將寫到指定的文件中。這應該是比較經常使用到的情況。
相應地，在配置文件中應該指定log輸出的文件名。如下配置指定了log文件名為demo.txt
log4j.appender.A2.File=demo.txt
注意將A2替換為具體配置中Appender的別名。
2.3 DailyRollingAppender
使用FileAppender可以將log信息輸出到文件中，但是如果文件太大了讀起來就不方便了。這時就可以使用DailyRollingAppender。DailyRollingAppender可以把Log信息輸出到按照日期來區分的文件中。如下配置文件就會每天產生一個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-dd HH:mm:ss,SSS} %m%n
打印的信息是：
2002-11-12 11:49:42,866 SELECT * FROM Role WHERE 1=1 order by createDate desc
例子2：顯示日期，log發生地方和log信息
log4j.appender.A2.layout=org.apache.log4j.PatternLayout
log4j.appender.A2.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss,SSS} %l "#" %m%n
2002-11-12 11:51:46,313 cn.net.unet.weboa.system.dao.RoleDAO.select(RoleDAO.java:409) "#" SELECT * FROM Role WHERE 1=1 order by createDate desc
例子3：顯示log級別,時間,調用方法,log信息
log4j.appender.A2.layout=org.apache.log4j.PatternLayout
log4j.appender.A2.layout.ConversionPattern=[%-5p] %d{yyyy-MM-dd HH:mm:ss,SSS} method:%l%n%m%n
log信息:
DEBUG??2002-11-12 12:00:57,376 method:cn.net.unet.weboa.system.dao.RoleDAO.select(RoleDAO.java:409)
SELECT * FROM Role WHERE 1=1 order by createDate desc
PART 3 log4j的使用
log4j使用步驟有3個：
3.1.根據配置文件初始化log4j
配置文件如PART 2所敘述。現在講的是如何在程序中配置log4j。
log4j可以使用3中配置器來初始化：BasicConfigurator,DOMConfigurator,PropertyConfigurator
這里用的是PropertyConfigurator。使用PropertyConfigurator適用于所有的系統。
如下的語句
PropertyConfigurator.configure("log4j.properties");
就以log4j.properties為配置文件初始化好了log4j環境。
注意一點：這個語句只需要在系統啟動的時候執行一次。例如:在unet webOA項目中可以這么用:
在ActionServlet的init()方法中調用一次。
public class ActionServlet extends HttpServlet{
...
/**
* Initialize global variables
*/
public void init() throws ServletException {
// 初始化Action資源
try{
initLog4j();
...
}catch(IOException e){
throw new ServletException("Load ActionRes is Error");
}
}
...
protected void initLog4j(){
PropertyConfigurator.configure("log4j.properties");
}
...
}//end class ActionServlet3.2 在需要使用log4j的地方獲取Logger實例
如下是RoleDAO類中的使用例子:
static Logger log = Logger.getLogger("DAO");
注意這里使用"DAO"標識符，那么對應的在配置文件中對應的配置信息如下：
#定義DAO Logger
log4j.logger.DAO=DEBUG,A2
#設置Appender A2的屬性
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-dd HH:mm:ss} %l%n%m%n
public class RoleDAO extends BaseDBObject
{
...
static Logger log = Logger.getLogger("DAO");
...
public BeanCollection selectAll() throws SQLException
{
StringBuffer sql = new StringBuffer(SQLBUF_LEN);
sql.append("SELECT * FROM " + tableName + " order by roldId");
//System.out.println(sql.toString());
log.debug(sql);
...
}
...
}
3.3 使用Logger對象的debug,info,fatal...方法
log.debug("it is the debug info");
附件1：log4j的一個bug
當這樣使用時，DailyRollingFileAppender不能正確使用：
public Class RoleDAO(){
static Logger log = Logger.getLogger("DAO");
//在每一次new RoleDAO對象的時候都執行一次configure()操作
public RoleDAO(TransactionManager transMgr) throws SQLException
{
...
PropertyConfigurator.configure("log4j.properties");
...
}
public void select(){
...
//使用log4j進行log記錄
log.debug("...");
...
}
}