Log4j簡介

Log4j有三個主要的組件:Loggers(記錄器),Appenders (輸出源)和Layouts(佈局)。這裡可簡單理解為日誌類別,日誌要輸出的地方和日誌以何種形式輸出。綜合使用這三個組件可以輕鬆地記錄信息的類型和級別,並可以在運行時控制日誌輸出的樣式和位置。

1、Loggers

Loggers組件在此係統中被分為五個級別:DEBUG、INFO、WARN、ERROR和FATAL。這五個級別是有順序的,DEBUG < INFO < WARN < ERROR < FATAL,分別用來指定這條日誌信息的重要程度,明白這一點很重要,Log4j有一個規則:只輸出級別不低於設定級別的日誌信息,假設Loggers級別設定為INFO,則INFO、WARN、ERROR和FATAL級別的日誌信息都會輸出,而級別比INFO低的DEBUG則不會輸出。

2、Appenders

禁用和使用日誌請求只是Log4j的基本功能,Log4j日誌系統還提供許多強大的功能,比如允許把日誌輸出到不同的地方,如控制檯(Console)、文件(Files)等,可以根據天數或者文件大小產生新的文件,可以以流的形式發送到其它地方等等。

常使用的類如下:

org.apache.log4j.ConsoleAppender(控制檯)

org.apache.log4j.FileAppender(文件)

org.apache.log4j.DailyRollingFileAppender(每天產生一個日誌文件)

org.apache.log4j.RollingFileAppender(文件大小到達指定尺寸的時候產生一個新的文件)

org.apache.log4j.WriterAppender(將日誌信息以流格式發送到任意指定的地方)

配置模式:

log4j.appender.appenderName = className

log4j.appender.appenderName.Option1 = value1

log4j.appender.appenderName.OptionN = valueN

3、Layouts

有時用戶希望根據自己的喜好格式化自己的日誌輸出,Log4j可以在Appenders的後面附加Layouts來完成這個功能。Layouts提供四種日誌輸出樣式,如根據HTML樣式、自由指定樣式、包含日誌級別與信息的樣式和包含日誌時間、線程、類別等信息的樣式。

常使用的類如下:

org.apache.log4j.HTMLLayout(以HTML表格形式佈局)

org.apache.log4j.PatternLayout(可以靈活地指定佈局模式)

org.apache.log4j.SimpleLayout(包含日誌信息的級別和信息字符串)

org.apache.log4j.TTCCLayout(包含日誌產生的時間、線程、類別等信息)

配置模式:

log4j.appender.appenderName.layout =className

log4j.appender.appenderName.layout.Option1 = value1

log4j.appender.appenderName.layout.OptionN = valueN

二、配置詳解

在實際應用中,要使Log4j在系統中運行須事先設定配置文件。配置文件事實上也就是對Logger、Appender及Layout進行相應設定。 Log4j支持兩種配置文件格式,一種是XML格式的文件,一種是properties屬性文件。下面以properties屬性文件為例介紹 log4j.properties的配置。

1、配置根Logger:

log4j.rootLogger = [ level ] , appenderName1, appenderName2, …

log4j.additivity.org.apache=false:表示Logger不會在父Logger的appender裡輸出,默認為true。

level :設定日誌記錄的最低級別,可設的值有OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者自定義的級別,Log4j建議只使用中間四個級別。通過在這裡設定級別,您可以控制應用程序中相應級別的日誌信息的開關,比如在這裡設定了INFO級別,則應用程序中所有DEBUG級別的日誌信息將不會被打印出來。

appenderName:就是指定日誌信息要輸出到哪裡。可以同時指定多個輸出目的地,用逗號隔開。

例如:log4j.rootLogger=INFO,A1,B2,C3

2、配置日誌信息輸出目的地(appender):

log4j.appender.appenderName = className

appenderName:自定義appderName,在log4j.rootLogger設置中使用;

className:可設值如下:

(1)org.apache.log4j.ConsoleAppender(控制檯)

(2)org.apache.log4j.FileAppender(文件)

(3)org.apache.log4j.DailyRollingFileAppender(每天產生一個日誌文件)

(4)org.apache.log4j.RollingFileAppender(文件大小到達指定尺寸的時候產生一個新的文件)

(5)org.apache.log4j.WriterAppender(將日誌信息以流格式發送到任意指定的地方)

(1)ConsoleAppender選項:

Threshold=WARN:指定日誌信息的最低輸出級別,默認為DEBUG。

ImmediateFlush=true:表示所有消息都會被立即輸出,設為false則不輸出,默認值是true。

Target=System.err:默認值是System.out。

(2)FileAppender選項:

Threshold=WARN:指定日誌信息的最低輸出級別,默認為DEBUG。

ImmediateFlush=true:表示所有消息都會被立即輸出,設為false則不輸出,默認值是true。

Append=false:true表示消息增加到指定文件中,false則將消息覆蓋指定的文件內容,默認值是true。

File=D:/logs/logging.log4j:指定消息輸出到logging.log4j文件中。

(3)DailyRollingFileAppender選項:

Threshold=WARN:指定日誌信息的最低輸出級別,默認為DEBUG。

ImmediateFlush=true:表示所有消息都會被立即輸出,設為false則不輸出,默認值是true。

Append=false:true表示消息增加到指定文件中,false則將消息覆蓋指定的文件內容,默認值是true。

File=D:/logs/logging.log4j:指定當前消息輸出到logging.log4j文件中。

DatePattern='.'yyyy-MM:每月滾動一次日誌文件,即每月產生一個新的日誌文件。當前月的日誌文件名為logging.log4j,前一個月的日誌文件名為logging.log4j.yyyy-MM。

另外,也可以指定按周、天、時、分等來滾動日誌文件,對應的格式如下:

1)'.'yyyy-MM:每月

2)'.'yyyy-ww:每週

3)'.'yyyy-MM-dd:每天

4)'.'yyyy-MM-dd-a:每天兩次

5)'.'yyyy-MM-dd-HH:每小時

6)'.'yyyy-MM-dd-HH-mm:每分鐘

(4)RollingFileAppender選項:

Threshold=WARN:指定日誌信息的最低輸出級別,默認為DEBUG。

ImmediateFlush=true:表示所有消息都會被立即輸出,設為false則不輸出,默認值是true。

Append=false:true表示消息增加到指定文件中,false則將消息覆蓋指定的文件內容,默認值是true。

File=D:/logs/logging.log4j:指定消息輸出到logging.log4j文件中。

MaxFileSize=100KB:後綴可以是KB, MB 或者GB。在日誌文件到達該大小時,將會自動滾動,即將原來的內容移到logging.log4j.1文件中。

MaxBackupIndex=2:指定可以產生的滾動文件的最大數,例如,設為2則可以產生logging.log4j.1,logging.log4j.2兩個滾動文件和一個logging.log4j文件。

3、配置日誌信息的輸出格式(Layout):

log4j.appender.appenderName.layout=className

className:可設值如下:

(1)org.apache.log4j.HTMLLayout(以HTML表格形式佈局)

(2)org.apache.log4j.PatternLayout(可以靈活地指定佈局模式)

(3)org.apache.log4j.SimpleLayout(包含日誌信息的級別和信息字符串)

(4)org.apache.log4j.TTCCLayout(包含日誌產生的時間、線程、類別等等信息)

(1)HTMLLayout選項:

LocationInfo=true:輸出java文件名稱和行號,默認值是false。

Title=My Logging: 默認值是Log4J Log Messages。

(2)PatternLayout選項:

ConversionPattern=%m%n:設定以怎樣的格式顯示消息。

格式化符號說明:

%p:輸出日誌信息的優先級,即DEBUG,INFO,WARN,ERROR,FATAL。

%d:輸出日誌時間點的日期或時間,默認格式為ISO8601,也可以在其後指定格式,如:%d{yyyy/MM/dd HH:mm:ss,SSS}。

%r:輸出自應用程序啟動到輸出該log信息耗費的毫秒數。

%t:輸出產生該日誌事件的線程名。

%l:輸出日誌事件的發生位置,相當於%c.%M(%F:%L)的組合,包括類全名、方法、文件名以及在代碼中的行數。例如:test.TestLog4j.main(TestLog4j.java:10)。

%c:輸出日誌信息所屬的類目,通常就是所在類的全名。

%M:輸出產生日誌信息的方法名。

%F:輸出日誌消息產生時所在的文件名稱。

%L::輸出代碼中的行號。

%m::輸出代碼中指定的具體日誌信息。

%n:輸出一個回車換行符,Windows平臺為"\r\n",Unix平臺為"\n"。

%x:輸出和當前線程相關聯的NDC(嵌套診斷環境),尤其用到像java servlets這樣的多客戶多線程的應用中。

%%:輸出一個"%"字符。

另外,還可以在%與格式字符之間加上修飾符來控制其最小長度、最大長度、和文本的對齊方式。如:

1) c:指定輸出category的名稱,最小的長度是20,如果category的名稱長度小於20的話,默認的情況下右對齊。

2)%-20c:"-"號表示左對齊。

3)%.30c:指定輸出category的名稱,最大的長度是30,如果category的名稱長度大於30的話,就會將左邊多出的字符截掉,但小於30的話也不會補空格。

附:Log4j比較全面的配置

Log4j配置文件實現了輸出到控制檯、文件、回滾文件、發送日誌郵件、輸出到數據庫日誌表、自定義標籤等全套功能。

log4j.rootLogger=DEBUG,console,dailyFile,im

log4j.additivity.org.apache=true

# 控制檯(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

# 應用於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

# 發送日誌到指定郵件

log4j.appender.mail=org.apache.log4j.net.SMTPAppender

log4j.appender.mail.Threshold=FATAL

log4j.appender.mail.BufferSize=10

log4j.appender.mail.From = [email protected]

log4j.appender.mail.SMTPHost=mail.com

log4j.appender.mail.Subject=Log4J Message

log4j.appender.mail.To= [email protected]

log4j.appender.mail.layout=org.apache.log4j.PatternLayout

log4j.appender.mail.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %n

# 應用於數據庫

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 = [email protected]

log4j.appender.im.layout=org.apache.log4j.PatternLayout

log4j.appender.im.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %n

log4j的強大功能無可置疑,但實際應用中免不了遇到某個功能需要輸出獨立的日誌文件的情況,怎樣才能把所需的內容從原有日誌中分離,形成單獨的日誌文件呢?其實只要在現有的log4j基礎上稍加配置即可輕鬆實現這一功能。

先看一個常見的log4j.properties文件,它是在控制檯和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

如果想對不同的類輸出不同的文件(以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所做的配置。

但是,如果在同一類中需要輸出多個日誌文件呢?其實道理是一樣的,先在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時給它一個自定義的名字(如這裡的"myTest1"),然後在log4j.properties中做出相應配置即可。別忘了不同日誌要使用不同的logger(如輸出到test1.log的要用logger1.info("abc"))。

還有一個問題,就是這些自定義的日誌默認是同時輸出到log4j.rootLogger所配置的日誌中的,如何能只讓它們輸出到自己指定的日誌中呢?別急,這裡有個開關:

1、log4j.additivity.myTest1 = false

它用來設置是否同時輸出到log4j.rootLogger所配置的日誌中,設為false就不會輸出到其它地方啦!注意這裡的"myTest1"是你在程序中給logger起的那個自定義的名字!

如果你說,我只是不想同時輸出這個日誌到log4j.rootLogger所配置的logfile中,stdout裡我還想同時輸出呢!那也好辦,把你的log4j.logger.myTest1 = DEBUG, test1改為下式就OK啦!

log4j.logger.myTest1=DEBUG, test1

如果項目中沒有配置 EHCache ,則配置以下兩句為 ERROR 。

log4j.logger.com.opensymphony.oscache=ERROR

log4j.logger.net.sf.navigator=ERROR


分享到:


相關文章: