文章版權(quán)由作者李曉暉和博客園共有,若轉(zhuǎn)載請于明顯處標(biāo)明出處:http://www.cnblogs.com/naaoveGIS/
1.背景
Log4j作為常用的日志生成工具,其清除日志的策略卻十分有限。只有在RollingFileAppender中可以通過設(shè)置MaxFileSize和maxBackupIndex屬性來指定要保留的日志文件大小以及個(gè)數(shù),從而實(shí)現(xiàn)自動(dòng)清除。

但是實(shí)際生產(chǎn)中,我們的真實(shí)的需求常常是定時(shí)生成日志,然后保留最近幾天的日志,歷史日志需要及時(shí)清理??墒荓og4j中的DailyRollingFileAppender這個(gè)類卻不帶屬性maxBackupIndex,maxFileSize等,所以無法通過直接配置實(shí)現(xiàn)。
針對這種情況,一般方法是寫一個(gè)定時(shí)刪除日志的腳本等,這里我們討論一種通過繼承FileAppender,重新實(shí)現(xiàn)DailyRollingFileAppender類,并且?guī)в邪磿r(shí)間順序清理日志的功能。
2.具體實(shí)現(xiàn)
2.1代碼實(shí)現(xiàn)
a.完成自定義的日期類和文件過濾類,為進(jìn)行文件命名和查找做準(zhǔn)備。


b.繼承FileAppender類,定義好文件輸出日期格式以及文件備份參數(shù)。

c.重寫核心的RollOver函數(shù)。

d.在RollOver函數(shù)中完成對備份數(shù)量的監(jiān)測以及歷史日志的刪除。

2.2配置實(shí)現(xiàn)

3.Log4j各配置的含義
Log4j由三個(gè)重要的組件構(gòu)成:日志信息的優(yōu)先級,日志信息的輸出目的地,日志信息的輸出格式。日志信息的優(yōu)先級從高到低有ERROR、WARN、 INFO、DEBUG,分別用來指定這條日志信息的重要程度;日志信息的輸出目的地指定了日志將打印到控制臺還是文件中;而輸出格式則控制了日志信息的顯示內(nèi)容。Log4j支持兩種配置文件格式,一種是XML格式的文件,一種是Java特性文件(鍵=值)。這里,我們主要探討基于XML的配置方式。
3.1配置根logger
基本語法是:

其中,level 是日志記錄的優(yōu)先級,分為OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者您定義的級別。Log4j建議只使用四個(gè)級別,優(yōu) 先級從高到低分別是ERROR、WARN、INFO、DEBUG。
這里,每一個(gè)appenderName均是下面需要配置的日志信息的名稱。
實(shí)際例子:
log4j.rootLogger=INFO ,stdout, ROLLING_ERROR_FILE, ROLLING_INFO_FILE

3.2配置日志信息輸出目的地Appeder
Log4j中提供的Appender主要有以下幾種:
org.apache.log4j.ConsoleAppender(控制臺),
org.apache.log4j.FileAppender(文件),
org.apache.log4j.DailyRollingFileAppender(每天產(chǎn)生一個(gè)日志文件),
org.apache.log4j.RollingFileAppender(文件大小到達(dá)指定尺寸的時(shí)候產(chǎn)生一個(gè)新的文件),
org.apache.log4j.WriterAppender(將日志信息以流格式發(fā)送到任意指定的地方)
基本語法為:

實(shí)際例子:
log4j.appender.ROLLING_ERROR_FILE=org.apache.log4j.DailyRollingFileAppender
針對不同的Appender,它們的屬性也有一定的差別,這些屬性主要是針對日志文件的命名規(guī)則、保存路徑、刪除策略等有關(guān)系。
3.2.1 ConsoleAppender的屬性
Threshold=WARN:指定日志信息的最低輸出級別,默認(rèn)為DEBUG。
ImmediateFlush=true:表示所有消息都會被立即輸出,設(shè)為false則不輸出,默認(rèn)值是true。
Target=System.err:默認(rèn)值是System.out。
3.2.2 FileAppender的屬性
Threshold=WARN:指定日志信息的最低輸出級別,默認(rèn)為DEBUG。
ImmediateFlush=true:表示所有消息都會被立即輸出,設(shè)為false則不輸出,默認(rèn)值是true。
Append=false:true表示消息增加到指定文件中,false則將消息覆蓋指定的文件內(nèi)容,默認(rèn)值是true。
File=D:/logs/logging.log4j:指定消息輸出到logging.log4j文件中。
3.2.3 DailyRollingFileAppender的屬性
Threshold=WARN:指定日志信息的最低輸出級別,默認(rèn)為DEBUG。
ImmediateFlush=true:表示所有消息都會被立即輸出,設(shè)為false則不輸出,默認(rèn)值是true。
Append=false:true表示消息增加到指定文件中,false則將消息覆蓋指定的文件內(nèi)容,默認(rèn)值是true。
File=D:/logs/logging.log4j:指定當(dāng)前消息輸出到logging.log4j文件中。
DatePattern='.'yyyy-MM:每月滾動(dòng)一次日志文件,即每月產(chǎn)生一個(gè)新的日志文件。當(dāng)前月的日志文件名為logging.log4j,前一個(gè)月的日志文件名為logging.log4j.yyyy-MM。
另外,也可以指定按周、天、時(shí)、分等來滾動(dòng)日志文件,對應(yīng)的格式如下:
1)'.'yyyy-MM:每月
2)'.'yyyy-ww:每周
3)'.'yyyy-MM-dd:每天
4)'.'yyyy-MM-dd-a:每天兩次
5)'.'yyyy-MM-dd-HH:每小時(shí)
6)'.'yyyy-MM-dd-HH-mm:每分鐘
3.2.4 RollingFileAppender的屬性
Threshold=WARN:指定日志信息的最低輸出級別,默認(rèn)為DEBUG。
ImmediateFlush=true:表示所有消息都會被立即輸出,設(shè)為false則不輸出,默認(rèn)值是true。
Append=false:true表示消息增加到指定文件中,false則將消息覆蓋指定的文件內(nèi)容,默認(rèn)值是true。
File=D:/logs/logging.log4j:指定消息輸出到logging.log4j文件中。
MaxFileSize=100KB:后綴可以是KB, MB 或者GB。在日志文件到達(dá)該大小時(shí),將會自動(dòng)滾動(dòng),即將原來的內(nèi)容移到logging.log4j.1文件中。
MaxBackupIndex=2:指定可以產(chǎn)生的滾動(dòng)文件的最大數(shù),例如,設(shè)為2則可以產(chǎn)生logging.log4j.1,logging.log4j.2兩個(gè)滾動(dòng)文件和一個(gè)logging.log4j文件。
3.3 配置日志信息的格式(布局)layout
Log4j提供的layout有以下幾種:
org.apache.log4j.HTMLLayout(以HTML表格形式布局),
org.apache.log4j.PatternLayout(可以靈活地指定布局模式),
org.apache.log4j.SimpleLayout(包含日志信息的級別和信息字符串),
org.apache.log4j.TTCCLayout(包含日志產(chǎn)生的時(shí)間、線程、類別等等信息)
Log4j采用類似C語言中的printf函數(shù)的打印格式格式化日志信息,打印參數(shù)如下: %m 輸出代碼中指定的消息
%p 輸出優(yōu)先級,即DEBUG,INFO,WARN,ERROR,F(xiàn)ATAL
%r 輸出自應(yīng)用啟動(dòng)到輸出該log信息耗費(fèi)的毫秒數(shù)
%c 輸出所屬的類目,通常就是所在類的全名
%t 輸出產(chǎn)生該日志事件的線程名
%n 輸出一個(gè)回車換行符,Windows平臺為“rn”,Unix平臺為“n”
%d 輸出日志時(shí)間點(diǎn)的日期或時(shí)間,默認(rèn)格式為ISO8601,也可以在其后指定格式,比如:%d{yyy MMM dd HH:mm:ss,SSS},輸出類似:2002年10月18日 22:10:28,921
%l 輸出日志事件的發(fā)生位置,包括類目名、發(fā)生的線程,以及在代碼中的行數(shù)。舉例:Testlog4.main(TestLog4.java:10)
基本語法為:

實(shí)際例子:
log4j.appender.ROLLING_ERROR_FILE.layout=org.apache.log4j.PatternLayout
log4j.appender.ROLLING_ERROR_FILE.layout.ConversionPattern=[log] %d -%-4r [%t] %c %x%n %-5p - %m [%l] %n