1. 程式人生 > >log4j的配置檔案詳細解析

log4j的配置檔案詳細解析

1.Log4j的優點
Log4j是Apache的一個開放原始碼專案,通過使用Log4j,我們可以控制日誌資訊輸送地;我們也可以控制每一條日誌的輸出格式;通過定義每一條日誌資訊的級別,我們能夠更加細緻地控制日誌的生成過程。最令人感興趣的就是,這些可以通過一個配置檔案來靈活地進行配置,而不需要修改應用的程式碼。

log4j的好處在於:
(1) 通過修改配置檔案,就可以決定log資訊的目的地——控制檯、檔案、GUI元件、甚至是套介面伺服器、NT的事件記錄器、UNIX Syslog守護程序等。

(2) 通過修改配置檔案,可以定義每一條日誌資訊的級別,從而控制是否輸出。在系統開發階段可以列印詳細的log資訊以跟蹤系統執行情況,而在系統穩定後可以關閉log輸出,從而在能跟蹤系統執行情況的同時,又減少了垃圾程式碼(System.out.println(......)等)。

(3) 使用log4j,需要整個系統有一個統一的log機制,有利於系統的規劃。

2.配置檔案
Log4j由三個重要的元件構成:日誌資訊的優先順序,日誌資訊的輸出目的地,日誌資訊的輸出格式。日誌資訊的優先順序從高到低有FATAL、ERROR、WARN、INFO、DEBUG、TRACE、ALL,分別用來指定這條日誌資訊的重要程度;日誌資訊的輸出目的地指定了日誌將列印到控制檯還是檔案中;而輸出格式則控制了日誌資訊的顯示內容。

2.1 日誌資訊的優先順序
Log4j建議只使用四個級別,優先順序從高到低分別是ERROR、WARN、INFO、DEBUG。通過在這裡定義的級別,您可以控制到應用程式中相應級別的日誌資訊的開關。如在這裡定義了INFO級別,則應用程式中所有低於INFO級別的日誌資訊將不被打印出來。

2.2 輸出源的使用
有選擇的能用或者禁用日誌請求僅僅是Log4j的一部分功能。Log4j允許日誌請求被輸出到多個輸出源。用Log4j的話說,一個輸出源被稱做一個Appender。

Appender包括console(控制檯), files(檔案), GUI components(圖形的元件), remote socket servers(socket 服務), JMS(java資訊服務), NT Event Loggers(NT的事件日誌), remote UNIX Syslog daemons(遠端UNIX的後臺日誌服務)。它也可以做到非同步記錄。 一個logger可以設定超過一個的appender。 用addAppender方法新增一個appender到一個給定的logger。對於一個給定的logger它每個生效的日誌請求都被轉發到該logger所有的appender上和該logger的父輩 logger的appender上。

2.2.1 ConsoleAppender
如果使用ConsoleAppender,那麼log資訊將寫到Console。效果等同於直接把資訊列印到System.out上了。

2.2.2 FileAppender
使用FileAppender,那麼log資訊將寫到指定的檔案中。這應該是比較經常使用到的情況。 相應地,在配置檔案中應該指定log輸出的檔名。如下配置指定了log檔名為log.txt。

log4j.appender.appendername.File=log.txt 注意將appendername替換為具體配置中Appender的別名。

注意:指定的log檔案路徑問題

2.2.3 DailyRollingAppender
使用FileAppender可以將log資訊輸出到檔案中,但是如果檔案太大了讀起來就不方便了。這時就可以使用DailyRollingAppender。DailyRollingAppender可以把Log資訊輸出到按照日期來區分的檔案中。配置檔案就會每天(時間可以設定)產生一個log檔案,每個log檔案只記錄當天的log資訊:

複製程式碼 程式碼如下:
log4j.appender.appendername=org.apache.log4j.DailyRollingFileAppender 
log4j.appender.Aappendername.file=log 
log4j.appender.appendername.DatePattern='.'yyyy-MM-dd 
log4j.appender.appendername.layout=org.apache.log4j.PatternLayout 
log4j.appender.appendername.layout.ConversionPattern= %5r %-5p %c{2} - %m%n

2.2.4 RollingFileAppender
檔案大小到達指定尺寸的時候產生一個新的檔案。
複製程式碼 程式碼如下:
og4j.appender.appendername=org.apache.log4j.RollingFileAppender 
log4j.appender.appendername.File= ../logs/rlog.log 
# Control the maximum log file size 
log4j.appender.appendername.MaxFileSize=100KB 
# Archive log files (one backup file here) 
log4j.appender.appendername.MaxBackupIndex=1

log4j.appender.appendername.layout=org.apache.log4j.PatternLayout 
log4j.appender.appendername.layout.ConversionPattern=%p %t %c - %m%n


這個配置檔案指定了輸出源appendername,是一個輪轉日誌檔案。最大的檔案是100KB,當一個日誌檔案達到最大尺寸時,Log4J會自動把rlog.log重新命名為rlog.log.1,然後重建一個新的rlog.log檔案,依次輪轉。

2.2.5 WriterAppender
將日誌資訊以流格式傳送到任意指定的地方。

2.3 Layout的配置
Layout指定了log資訊輸出的樣式。

2.3.1 佈局樣式

複製程式碼 程式碼如下:
org.apache.log4j.HTMLLayout(以HTML表格形式佈局), 
org.apache.log4j.PatternLayout(可以靈活地指定佈局模式), 
org.apache.log4j.SimpleLayout(包含日誌資訊的級別和資訊字串), 
org.apache.log4j.TTCCLayout(包含日誌產生的時間、執行緒、類別等等資訊) 

2.3.2 格式
複製程式碼 程式碼如下:
%m 輸出程式碼中指定的訊息 
%p 輸出優先順序,即DEBUG,INFO,WARN,ERROR,FATAL 
%r 輸出自應用啟動到輸出該log資訊耗費的毫秒數 
%c 輸出所屬的類目,通常就是所在類的全名 
%t 輸出產生該日誌事件的執行緒名 
%n 輸出一個回車換行符,Windows平臺為"rn",Unix平臺為"n" 
%d 輸出日誌時間點的日期或時間,預設格式為ISO8601,也可以在其後指定格式,比如:%d{yyy MMM dd HH:mm:ss,SSS},輸出類似:2002年10月18日 22:10:28,921 
%l 輸出日誌事件的發生位置,包括類目名、發生的執行緒,以及在程式碼中的行數。舉例:Testlog4.main(Test Log4.java:10)

3.為不同的Appender設定日誌輸出級別
通過在配置中修改Appender的Threshold即能實現,比如下面的例子:

配置檔案:
log4j.rootLogger = debug,A,B,C

# 輸出到控制檯
log4j.appender.A = org.apache.log4j.ConsoleAppender
log4j.appender.A.Target = System.out
log4j.appender.A.layout = org.apache.log4j.PatternLayout
log4j.appender.A.layout.ConversionPattern = %p %t %c - %m%n

# 輸出到日誌檔案
log4j.appender.B = org.apache.log4j.DailyRollingFileAppender
log4j.appender.B.File = logs/log.log
log4j.appender.B.Append = true
log4j.appender.B.Threshold = DEBUG # 輸出EBUG級別以上的日誌
log4j.appender.B.layout = org.apache.log4j.PatternLayout
log4j.appender.B.layout.ConversionPattern = %p %t %c - %m%n

# 儲存異常資訊到單獨檔案
log4j.appender.C = org.apache.log4j.DailyRollingFileAppender
log4j.appender.C.File = logs/error.log # 異常日誌檔名
log4j.appender.C.Append = true
log4j.appender.C.Threshold = ERROR #只輸出ERROR級別以上的日誌
log4j.appender.C.layout = org.apache.log4j.PatternLayout
log4j.appender.C.layout.ConversionPattern = %p %t %c - %m%n

例子:

複製程式碼 程式碼如下:
public class TestLog4j
{
    public static void main(String[] args)
    {
        PropertyConfigurator.configure("D:/Code/conf/log4j.properties");
        Logger logger = Logger.getLogger(TestLog4j.class);
        logger.debug("debug");
        logger.error("error");  
    }
}