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.設定檔的例子
[code]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[/code]

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資訊
[code]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 [/code]

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 ActionServlet

3.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("..."); ... } }

怎麼解決:
在系統啟動時執行一次PropertyConfigurator.configure("log4j.properties");
之後就不再執行。