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

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章