文章版權(quán)由作者李曉暉和博客園共有,若轉(zhuǎn)載請(qǐng)于明顯處標(biāo)明出處:http://www.cnblogs.com/naaoveGIS/
1.背景
Log4j作為常用的日志生成工具童谒,其清除日志的策略卻十分有限饥伊。只有在RollingFileAppender中可以通過(guò)設(shè)置MaxFileSize和maxBackupIndex屬性來(lái)指定要保留的日志文件大小以及個(gè)數(shù)蔫饰,從而實(shí)現(xiàn)自動(dòng)清除。
但是實(shí)際生產(chǎn)中茫因,我們的真實(shí)的需求常常是定時(shí)生成日志冻押,然后保留最近幾天的日志,歷史日志需要及時(shí)清理括袒「遘裕可是Log4j中的DailyRollingFileAppender這個(gè)類卻不帶屬性maxBackupIndex,maxFileSize等,所以無(wú)法通過(guò)直接配置實(shí)現(xiàn)城须。
針對(duì)這種情況米苹,一般方法是寫一個(gè)定時(shí)刪除日志的腳本等蘸嘶,這里我們討論一種通過(guò)繼承FileAppender,重新實(shí)現(xiàn)DailyRollingFileAppender類褥蚯,并且?guī)в邪磿r(shí)間順序清理日志的功能况增。
2.具體實(shí)現(xiàn)
2.1代碼實(shí)現(xiàn)
a.完成自定義的日期類和文件過(guò)濾類澳骤,為進(jìn)行文件命名和查找做準(zhǔn)備。
b.繼承FileAppender類摊册,定義好文件輸出日期格式以及文件備份參數(shù)茅特。
c.重寫核心的RollOver函數(shù)棋枕。
d.在RollOver函數(shù)中完成對(duì)備份數(shù)量的監(jiān)測(cè)以及歷史日志的刪除戒悠。
2.2配置實(shí)現(xiàn)
3.Log4j各配置的含義
Log4j由三個(gè)重要的組件構(gòu)成:日志信息的優(yōu)先級(jí)绸狐,日志信息的輸出目的地寒矿,日志信息的輸出格式。日志信息的優(yōu)先級(jí)從高到低有ERROR拆融、WARN啊终、 INFO、DEBUG趟脂,分別用來(lái)指定這條日志信息的重要程度例衍;日志信息的輸出目的地指定了日志將打印到控制臺(tái)還是文件中佛玄;而輸出格式則控制了日志信息的顯示內(nèi)容。Log4j支持兩種配置文件格式般贼,一種是XML格式的文件奥吩,一種是Java特性文件(鍵=值)。這里人芽,我們主要探討基于XML的配置方式绩脆。
3.1配置根logger
基本語(yǔ)法是:
其中靴迫,level 是日志記錄的優(yōu)先級(jí),分為OFF名挥、FATAL主守、ERROR、WARN救湖、INFO鞋既、DEBUG、ALL或者您定義的級(jí)別跌前。Log4j建議只使用四個(gè)級(jí)別陡舅,優(yōu) 先級(jí)從高到低分別是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(控制臺(tái))酌儒,
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ā)送到任意指定的地方)
基本語(yǔ)法為:
實(shí)際例子:
log4j.appender.ROLLING_ERROR_FILE=org.apache.log4j.DailyRollingFileAppender
針對(duì)不同的Appender鸥印,它們的屬性也有一定的差別,這些屬性主要是針對(duì)日志文件的命名規(guī)則狂鞋、保存路徑璃弄、刪除策略等有關(guān)系夏块。
3.2.1 ConsoleAppender的屬性
Threshold=WARN:指定日志信息的最低輸出級(jí)別纤掸,默認(rèn)為DEBUG。
ImmediateFlush=true:表示所有消息都會(huì)被立即輸出政己,設(shè)為false則不輸出歇由,默認(rèn)值是true果港。
Target=System.err:默認(rèn)值是System.out。
3.2.2 FileAppender的屬性
Threshold=WARN:指定日志信息的最低輸出級(jí)別谢谦,默認(rèn)為DEBUG萝衩。
ImmediateFlush=true:表示所有消息都會(huì)被立即輸出猩谊,設(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:指定日志信息的最低輸出級(jí)別,默認(rèn)為DEBUG合敦。
ImmediateFlush=true:表示所有消息都會(huì)被立即輸出验游,設(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í)乙埃、分等來(lái)滾動(dòng)日志文件,對(duì)應(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:指定日志信息的最低輸出級(jí)別甫何,默認(rèn)為DEBUG辙喂。
ImmediateFlush=true:表示所有消息都會(huì)被立即輸出鸠珠,設(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í)缘滥,將會(huì)自動(dòng)滾動(dòng)朝扼,即將原來(lái)的內(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(包含日志信息的級(jí)別和信息字符串)瓣戚,
org.apache.log4j.TTCCLayout(包含日志產(chǎn)生的時(shí)間、線程舱权、類別等等信息)
Log4j采用類似C語(yǔ)言中的printf函數(shù)的打印格式格式化日志信息仑嗅,打印參數(shù)如下: %m 輸出代碼中指定的消息
%p 輸出優(yōu)先級(jí)仓技,即DEBUG,INFO阔逼,WARN嗜浮,ERROR摩疑,F(xiàn)ATAL
%r 輸出自應(yīng)用啟動(dòng)到輸出該log信息耗費(fèi)的毫秒數(shù)
%c 輸出所屬的類目未荒,通常就是所在類的全名
%t 輸出產(chǎn)生該日志事件的線程名
%n 輸出一個(gè)回車換行符,Windows平臺(tái)為“rn”寨腔,Unix平臺(tái)為“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)
基本語(yǔ)法為:
實(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