一墨礁、 Log4j簡(jiǎn)介
Log4j有三個(gè)主要的組件:
- Loggers(記錄器):日志類別和級(jí)別;
- Appenders (輸出源):日志要輸出的地方;
- Layouts(布局):日志以何種形式輸出
1.1 Loggers
Loggers組件在此系統(tǒng)中被分為五個(gè)級(jí)別:DEBUG椎侠、INFO、WARN雏亚、ERROR和FATAL。這五個(gè)級(jí)別是有順序的,DEBUG < INFO < WARN < ERROR < FATAL乾闰,分別用來(lái)指定這條日志信息的重要程度冕广,明白這一點(diǎn)很重要疏日,
Log4j有一個(gè)規(guī)則:只輸出級(jí)別不低于設(shè)定級(jí)別的日志信息,假設(shè)Loggers級(jí)別設(shè)定為INFO撒汉,則INFO沟优、WARN、ERROR和FATAL級(jí)別的日志信息都會(huì)輸出睬辐,而級(jí)別比INFO低的DEBUG則不會(huì)輸出挠阁。
1.2 Appenders
禁用和使用日志請(qǐng)求只是Log4j的基本功能,Log4j日志系統(tǒng)還提供許多強(qiáng)大的功能溯饵,比如允許把日志輸出到不同的地方侵俗,如控制臺(tái)(Console)、文件(Files)等丰刊,可以根據(jù)天數(shù)或者文件大小產(chǎn)生新的文件隘谣,可以以流的形式發(fā)送到其它地方等等。
常使用的類如下:
- 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ā)送到任意指定的地方)
配置模式:
log4j.appender.appenderName = className
log4j.appender.appenderName.Option1 = value1
…
log4j.appender.appenderName.OptionN = valueN
1.3 Layouts
Log4j可以在Appenders的后面附加Layouts來(lái)完成這個(gè)功能啄巧。
Layouts提供四種日志輸出樣式寻歧,如根據(jù)HTML樣式擂错、自由指定樣式关划、包含日志級(jí)別與信息的樣式和包含日志時(shí)間、線程蔑鹦、類別等信息的樣式逗概。
常使用的類如下:
- org.apache.log4j.HTMLLayout(以HTML表格形式布局)
- org.apache.log4j.PatternLayout(可以靈活地指定布局模式)
- org.apache.log4j.SimpleLayout(包含日志信息的級(jí)別和信息字符串)
- org.apache.log4j.TTCCLayout(包含日志產(chǎn)生的時(shí)間弟晚、線程、類別等信息)
配置模式:
log4j.appender.appenderName.layout =className
log4j.appender.appenderName.layout.Option1 = value1
...
log4j.appender.appenderName.layout.OptionN = valueN
二、配置詳解
在實(shí)際應(yīng)用中卿城,要使Log4j在系統(tǒng)中運(yùn)行須事先設(shè)定配置文件枚钓。配置文件事實(shí)上也就是對(duì)Logger、Appender及Layout進(jìn)行相應(yīng)設(shè)定瑟押。
Log4j支持兩種配置文件格式:
- 一種是XML格式的文件搀捷,
- 一種是properties屬性文件。
下面以properties屬性文件為例介紹log4j.properties的配置多望。
2.1 配置根Logger:
log4j.rootLogger = [ level ] , appenderName1, appenderName2, …
log4j.additivity.org.apache=false:表示Logger不會(huì)在父Logger的appender里輸出嫩舟,默認(rèn)為true。
1. level :設(shè)定日志記錄的最低級(jí)別怀偷,可設(shè)的值有OFF家厌、FATAL、ERROR椎工、WARN饭于、INFO、DEBUG维蒙、ALL或者自定義的級(jí)別掰吕,Log4j建議只使用中間四個(gè)級(jí)別。通過(guò)在這里設(shè)定級(jí)別颅痊,您可以控制應(yīng)用程序中相應(yīng)級(jí)別的日志信息的開(kāi)關(guān)殖熟,比如在這里設(shè)定了INFO級(jí)別,則應(yīng)用程序中所有DEBUG級(jí)別的日志信息將不會(huì)被打印出來(lái)八千。
2. appenderName:就是指定日志信息要輸出到哪里吗讶。可以同時(shí)指定多個(gè)輸出目的地恋捆,用逗號(hào)隔開(kāi)照皆。
例如:log4j.rootLogger=INFO,A1,B2,C3
2.2 配置日志信息輸出目的地(appender):
log4j.appender.appenderName = className
appenderName:自定義appderName,在log4j.rootLogger設(shè)置中使用沸停;
className:可設(shè)值如下:
- (1)org.apache.log4j.ConsoleAppender(控制臺(tái))
- (2)org.apache.log4j.FileAppender(文件)
- (3)org.apache.log4j.DailyRollingFileAppender(每天產(chǎn)生一個(gè)日志文件)
- (4)org.apache.log4j.RollingFileAppender(文件大小到達(dá)指定尺寸的時(shí)候產(chǎn)生一個(gè)新的文件)
- (5)org.apache.log4j.WriterAppender(將日志信息以流格式發(fā)送到任意指定的地方)
(1) ConsoleAppender選項(xiàng)
- Threshold=WARN:指定日志信息的最低輸出級(jí)別膜毁,默認(rèn)為DEBUG。
- ImmediateFlush=true:表示所有消息都會(huì)被立即輸出愤钾,設(shè)為false則不輸出瘟滨,默認(rèn)值是true。
- Target=System.err:默認(rèn)值是System.out能颁。
(2) FileAppender選項(xiàng)
- 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) DailyRollingFileAppender選項(xiàng)
- 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)的格式如下:
- '.'yyyy-MM:每月
- '.'yyyy-ww:每周
- '.'yyyy-MM-dd:每天
- '.'yyyy-MM-dd-a:每天兩次
- '.'yyyy-MM-dd-HH:每小時(shí)
- '.'yyyy-MM-dd-HH-mm:每分鐘
(4) RollingFileAppender選項(xiàng)
- 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文件棚唆。
2.3 配置日志信息的輸出格式(Layout)
log4j.appender.appenderName.layout=className
className:可設(shè)值如下:
(1)org.apache.log4j.HTMLLayout(以HTML表格形式布局)
(2)org.apache.log4j.PatternLayout(可以靈活地指定布局模式)
(3)org.apache.log4j.SimpleLayout(包含日志信息的級(jí)別和信息字符串)
(4)org.apache.log4j.TTCCLayout(包含日志產(chǎn)生的時(shí)間、線程搬卒、類別等等信息)
(1) HTMLLayout選項(xiàng)
- LocationInfo=true:輸出java文件名稱和行號(hào)瑟俭,默認(rèn)值是false。
- Title=My Logging: 默認(rèn)值是Log4J Log Messages契邀。
(2) PatternLayout選項(xiàng):
ConversionPattern=%m%n:設(shè)定以怎樣的格式顯示消息摆寄。
格式化符號(hào)說(shuō)明:
- %p:輸出日志信息的優(yōu)先級(jí),即DEBUG坯门,INFO微饥,WARN,ERROR古戴,F(xiàn)ATAL欠橘。
- %d:輸出日志時(shí)間點(diǎn)的日期或時(shí)間,默認(rèn)格式為ISO8601现恼,也可以在其后指定格式肃续,如:%d{yyyy/MM/dd HH:mm:ss,SSS}。
- %r:輸出自應(yīng)用程序啟動(dòng)到輸出該log信息耗費(fèi)的毫秒數(shù)叉袍。
- %t:輸出產(chǎn)生該日志事件的線程名始锚。
- %l:輸出日志事件的發(fā)生位置,相當(dāng)于%c.%M(%F:%L)的組合喳逛,包括類全名瞧捌、方法、文件名以及在代碼中的行數(shù)润文。例如:test.TestLog4j.main(TestLog4j.java:10)姐呐。
- %c:輸出日志信息所屬的類目,通常就是所在類的全名典蝌。
- %M:輸出產(chǎn)生日志信息的方法名曙砂。
- %F:輸出日志消息產(chǎn)生時(shí)所在的文件名稱。
- %L::輸出代碼中的行號(hào)赠法。
- %m::輸出代碼中指定的具體日志信息麦轰。
- %n:輸出一個(gè)回車換行符,Windows平臺(tái)為"\r\n"砖织,Unix平臺(tái)為"\n"款侵。
- %x:輸出和當(dāng)前線程相關(guān)聯(lián)的NDC(嵌套診斷環(huán)境),尤其用到像java servlets這樣的多客戶多線程的應(yīng)用中侧纯。
- %%:輸出一個(gè)"%"字符新锈。
另外,還可以在%與格式字符之間加上修飾符來(lái)控制其最小長(zhǎng)度眶熬、最大長(zhǎng)度妹笆、和文本的對(duì)齊方式块请。如:
- c:指定輸出category的名稱,最小的長(zhǎng)度是20拳缠,如果category的名稱長(zhǎng)度小于20的話墩新,默認(rèn)的情況下右對(duì)齊。
- 2)%-20c:"-"號(hào)表示左對(duì)齊窟坐。
- 3)%.30c:指定輸出category的名稱海渊,最大的長(zhǎng)度是30,如果category的名稱長(zhǎng)度大于30的話哲鸳,就會(huì)將左邊多出的字符截掉臣疑,但小于30的話也不會(huì)補(bǔ)空格。
附:Log4j比較全面的配置
Log4j配置文件實(shí)現(xiàn)了輸出到控制臺(tái)徙菠、文件讯沈、回滾文件、發(fā)送日志郵件婿奔、輸出到數(shù)據(jù)庫(kù)日志表缺狠、自定義標(biāo)簽等全套功能。
log4j.rootLogger=DEBUG,console,dailyFile,im
log4j.additivity.org.apache=true
# 控制臺(tái)(console)
log4j.appender.console=org.apache.log4j.ConsoleAppender
log4j.appender.console.Threshold=DEBUG
log4j.appender.console.ImmediateFlush=true
log4j.appender.console.Target=System.err
log4j.appender.console.layout=org.apache.log4j.PatternLayout
log4j.appender.console.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %n
# 日志文件(logFile)
log4j.appender.logFile=org.apache.log4j.FileAppender
log4j.appender.logFile.Threshold=DEBUG
log4j.appender.logFile.ImmediateFlush=true
log4j.appender.logFile.Append=true
log4j.appender.logFile.File=D:/logs/log.log4j
log4j.appender.logFile.layout=org.apache.log4j.PatternLayout
log4j.appender.logFile.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %n
# 回滾文件(rollingFile)
log4j.appender.rollingFile=org.apache.log4j.RollingFileAppender
log4j.appender.rollingFile.Threshold=DEBUG
log4j.appender.rollingFile.ImmediateFlush=true
log4j.appender.rollingFile.Append=true
log4j.appender.rollingFile.File=D:/logs/log.log4j
log4j.appender.rollingFile.MaxFileSize=200KB
log4j.appender.rollingFile.MaxBackupIndex=50
log4j.appender.rollingFile.layout=org.apache.log4j.PatternLayout
log4j.appender.rollingFile.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %n
# 定期回滾日志文件(dailyFile)
log4j.appender.dailyFile=org.apache.log4j.DailyRollingFileAppender
log4j.appender.dailyFile.Threshold=DEBUG
log4j.appender.dailyFile.ImmediateFlush=true
log4j.appender.dailyFile.Append=true
log4j.appender.dailyFile.File=D:/logs/log.log4j
log4j.appender.dailyFile.DatePattern='.'yyyy-MM-dd
log4j.appender.dailyFile.layout=org.apache.log4j.PatternLayout
log4j.appender.dailyFile.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %n
# 應(yīng)用于socket
log4j.appender.socket=org.apache.log4j.RollingFileAppender
log4j.appender.socket.RemoteHost=localhost
log4j.appender.socket.Port=5001
log4j.appender.socket.LocationInfo=true
# Set up for Log Factor 5
log4j.appender.socket.layout=org.apache.log4j.PatternLayout
log4j.appender.socket.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %n
# Log Factor 5 Appender
log4j.appender.LF5_APPENDER=org.apache.log4j.lf5.LF5Appender
log4j.appender.LF5_APPENDER.MaxNumberOfRecords=2000
# 發(fā)送日志到指定郵件
log4j.appender.mail=org.apache.log4j.net.SMTPAppender
log4j.appender.mail.Threshold=FATAL
log4j.appender.mail.BufferSize=10
log4j.appender.mail.From = xxx@mail.com
log4j.appender.mail.SMTPHost=mail.com
log4j.appender.mail.Subject=Log4J Message
log4j.appender.mail.To= xxx@mail.com
log4j.appender.mail.layout=org.apache.log4j.PatternLayout
log4j.appender.mail.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %n
# 應(yīng)用于數(shù)據(jù)庫(kù)
log4j.appender.database=org.apache.log4j.jdbc.JDBCAppender
log4j.appender.database.URL=jdbc:mysql://localhost:3306/test
log4j.appender.database.driver=com.mysql.jdbc.Driver
log4j.appender.database.user=root
log4j.appender.database.password=
log4j.appender.database.sql=INSERT INTO LOG4J (Message) VALUES('=[%-5p] %d(%r) --> [%t] %l: %m %x %n')
log4j.appender.database.layout=org.apache.log4j.PatternLayout
log4j.appender.database.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %n
# 自定義Appender
log4j.appender.im = net.cybercorlin.util.logger.appender.IMAppender
log4j.appender.im.host = mail.cybercorlin.net
log4j.appender.im.username = username
log4j.appender.im.password = password
log4j.appender.im.recipient = corlin@cybercorlin.net
log4j.appender.im.layout=org.apache.log4j.PatternLayout
log4j.appender.im.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %n
附: 輸出獨(dú)立日志文件
log4j的強(qiáng)大功能無(wú)可置疑萍摊,但實(shí)際應(yīng)用中免不了遇到某個(gè)功能需要輸出獨(dú)立的日志文件的情況儒老,怎樣才能把所需的內(nèi)容從原有日志中分離,形成單獨(dú)的日志文件呢记餐?其實(shí)只要在現(xiàn)有的log4j基礎(chǔ)上稍加配置即可輕松實(shí)現(xiàn)這一功能。
常見(jiàn)
先看一個(gè)常見(jiàn)的log4j.properties文件薇正,它是在控制臺(tái)和myweb.log文件中記錄日志:
log4j.rootLogger=DEBUG, stdout, logfile
log4j.category.org.springframework=ERROR
log4j.category.org.apache=INFO
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern=%d %p [%c] - %m%n
log4j.appender.logfile=org.apache.log4j.RollingFileAppender
log4j.appender.logfile.File=${myweb.root}/WEB-INF/log/myweb.log
log4j.appender.logfile.MaxFileSize=512KB
log4j.appender.logfile.MaxBackupIndex=5
log4j.appender.logfile.layout=org.apache.log4j.PatternLayout
log4j.appender.logfile.layout.ConversionPattern=%d %p [%c] - %m%n
不同類輸出不同文件
如果想對(duì)不同的類輸出不同的文件(以cn.com.Test為例)片酝,先要在Test.java中定義:
private static Log logger = LogFactory.getLog(Test.class);
然后在log4j.properties中加入:
log4j.logger.cn.com.Test= DEBUG, test
log4j.appender.test=org.apache.log4j.FileAppender
log4j.appender.test.File=${myweb.root}/WEB-INF/log/test.log
log4j.appender.test.layout=org.apache.log4j.PatternLayout
log4j.appender.test.layout.ConversionPattern=%d %p [%c] - %m%n
也就是讓cn.com.Test中的logger使用log4j.appender.test所做的配置。
同一類輸出多個(gè)日志文件
但是挖腰,如果在同一類中需要輸出多個(gè)日志文件呢雕沿?其實(shí)道理是一樣的,先在Test.java中定義:
private static Log logger1 = LogFactory.getLog("myTest1");
private static Log logger2 = LogFactory.getLog("myTest2");
然后在log4j.properties中加入:
log4j.logger.myTest1= DEBUG, test1
log4j.appender.test1=org.apache.log4j.FileAppender
log4j.appender.test1.File=${myweb.root}/WEB-INF/log/test1.log
log4j.appender.test1.layout=org.apache.log4j.PatternLayout
log4j.appender.test1.layout.ConversionPattern=%d %p [%c] - %m%n
log4j.logger.myTest2= DEBUG, test2
log4j.appender.test2=org.apache.log4j.FileAppender
log4j.appender.test2.File=${myweb.root}/WEB-INF/log/test2.log
log4j.appender.test2.layout=org.apache.log4j.PatternLayout
log4j.appender.test2.layout.ConversionPattern=%d %p [%c] - %m%n
```
也就是在用logger時(shí)給它一個(gè)自定義的名字(如這里的"myTest1")猴仑,然后在log4j.properties中做出相應(yīng)配置即可审轮。別忘了不同日志要使用不同的logger(如輸出到test1.log的要用logger1.info("abc"))。
還有一個(gè)問(wèn)題辽俗,就是這些自定義的**日志默認(rèn)是同時(shí)輸出到log4j.rootLogger所配置的日志中的**疾渣,如何能只讓它們輸出到自己指定的日志中呢?別急崖飘,這里有個(gè)開(kāi)關(guān):
log4j.additivity.myTest1 = false
它用來(lái)設(shè)置是否同時(shí)輸出到log4j.rootLogger所配置的日志中榴捡,設(shè)為false就不會(huì)輸出到其它地方啦!注意這里的"myTest1"是你在程序中給logger起的那個(gè)自定義的名字朱浴!
如果你說(shuō)吊圾,我只是不想同時(shí)輸出這個(gè)日志到log4j.rootLogger所配置的logfile中达椰,stdout里我還想同時(shí)輸出呢!那也好辦项乒,把你的log4j.logger.myTest1 = DEBUG, test1改為下式就OK啦啰劲!
log4j.logger.myTest1=DEBUG, test1