Log4j支持兩種配置文件格式,壹種是XML(標準通用標記語言下的壹個應用)格式的文件,壹種是Java特性文件log4j.properties(鍵=值)。下面將介紹使用log4j.properties文件作為配置文件的方法:
①、配置根Logger
Logger 負責處理日誌記錄的大部分操作。
其語法為:
log4j.rootLogger = [ level ] , appenderName, appenderName, …
其中,level 是日誌記錄的優先級,分為OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者自定義的級別。Log4j建議只使用四個級別,優先級從高到低分別是ERROR、WARN、INFO、DEBUG。通過在這裏定義的級別,您可以控制到應用程序中相應級別的日誌信息的開關。比如在這裏定義了INFO級別,只有等於及高於這個級別的才進行處理,則應用程序中所有DEBUG級別的日誌信息將不被打印出來。ALL:打印所有的日誌,OFF:關閉所有的日誌輸出。 appenderName就是指定日誌信息輸出到哪個地方。可同時指定多個輸出目的地。
②、配置日誌信息輸出目的地 Appender
Appender 負責控制日誌記錄操作的輸出。
其語法為:
log4j.appender.appenderName = fully.qualified.name.of.appender.class
log4j.appender.appenderName.option1 = value1
…
log4j.appender.appenderName.optionN = valueN
這裏的appenderName為在①裏定義的,可任意起名。
其中,Log4j提供的appender有以下幾種:
org.apache.log4j.ConsoleAppender(控制臺),
org.apache.log4j.FileAppender(文件),
org.apache.log4j.DailyRollingFileAppender(每天產生壹個日誌文件),
org.apache.log4j.RollingFileAppender(文件大小到達指定尺寸的時候產生壹個新的文件),可通過log4j.appender.R.MaxFileSize=100KB設置文件大小,還可通過log4j.appender.R.MaxBackupIndex=1設置為保存壹個備份文件。
org.apache.log4j.WriterAppender(將日誌信息以流格式發送到任意指定的地方)
例如:log4j.appender.stdout=org.apache.log4j.ConsoleAppender
定義壹個名為stdout的輸出目的地,ConsoleAppender為控制臺。
③、配置日誌信息的格式(布局)Layout
Layout 負責格式化Appender的輸出。
其語法為:
log4j.appender.appenderName.layout = fully.qualified.name.of.layout.class
log4j.appender.appenderName.layout.option1 = value1
…
log4j.appender.appenderName.layout.optionN = valueN
其中,Log4j提供的layout有以下幾種:
org.apache.log4j.HTMLLayout(以HTML表格形式布局),
org.apache.log4j.PatternLayout(可以靈活地指定布局模式),
org.apache.log4j.SimpleLayout(包含日誌信息的級別和信息字符串),
org.apache.log4j.TTCCLayout(包含日誌產生的時間、線程、類別等等信息) Log4J采用類似C語言中的printf函數的打印格式格式化日誌信息,打印參數如下:
%m 輸出代碼中指定的消息;
%M 輸出打印該條日誌的方法名;
%p 輸出優先級,即DEBUG,INFO,WARN,ERROR,FATAL;
%r 輸出自應用啟動到輸出該log信息耗費的毫秒數;
%c 輸出所屬的類目,通常就是所在類的全名;
%t 輸出產生該日誌事件的線程名;
%n 輸出壹個回車換行符,Windows平臺為"rn”,Unix平臺為"n”;
%d 輸出日誌時間點的日期或時間,默認格式為ISO8601,也可以在其後指定格式,比如:%d{yyyy-MM-dd HH:mm:ss,SSS},輸出類似:2002-10-18 22:10:28,921;
%l 輸出日誌事件的發生位置,及在代碼中的行數。 我們在需要輸出日誌信息的類中做如下的三個工作:
1、導入所有需的commons-logging類:
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
2、在自己的類中定義壹個org.apache.commons.logging.Log類的私有靜態類成員:
private final Log log = LogFactory.getLog(getClass());
LogFactory.getLog()方法的參數使用的是當前類的class。
3、使用org.apache.commons.logging.Log類的成員方法輸出日誌信息:
if (log.isDebugEnabled()){
log.debug("111");
}
if (log.isInfoEnabled()){
log.info("222");
}
if (log.isWarnEnabled()){
log.warn("333");
}
if (log.isErrorEnabled()){
log.error("444");
}
if (log.isFatalEnabled()){
log.fatal("555");
}
2.3 如何應用記錄器的層次
2.3.1 如何定義及獲取不同層次的記錄器
任何壹個記錄器的使用都有兩個步驟:
1) 在配置文件中定義相應的記錄器。
在配置文件中定義記錄器的格式有兩種
定義根記錄器的格式為log4j.rootLogger = [ level ], appendName1, appendName2, …appendNameN
定義壹個非根記錄器的格式為log4j.logger.loggerName1 = [ level ], appendName1,…appendNameN
……
log4j.logger.loggerNameM = [ level ], appendName1, …appendNameN
我們可以定義任意個非根記錄器。
2) 在代碼中調用Logger類的取得記錄器方法取得相應的記錄器對象。
要取得根記錄器對象可通過Logger.getRootLogger()函數,要取得非根記錄器可通過Logger.getLogger()函數。
理論知道就講到這裏,紙上得來終覺淺,下面,我們來小小演練壹下。
例4-a: package?TestLog4j;import?org.apache.log4j.Logger;import?org.apache.log4j.PropertyConfigurator;import?org.apache.log4j.Priority;import?TestLog4j.TestLog4j2.TestLog4j2;public?class?TestLog4j{static?Logger?logger?=?Logger.getLogger(TestLog4j.class.getName()); //(2)public?TestLog4j(){}public?static?void?main(String[]?args){//同時輸出到控制臺和壹個文件的實例並實現了Logger的繼承PropertyConfigurator.configure("F:\\nepalon\\log4j2.properties");logger.debug("Start?of?the?main()?in?TestLog4j");logger.info("Just?testing?a?log?message?with?priority?set?to?INFO");logger.warn("Just?testing?a?log?message?with?priority?set?to?WARN");logger.error("Just?testing?a?log?message?with?priority?set?to?ERROR");logger.fatal("Just?testing?a?log?message?with?priority?set?to?FATAL");logger.log(Priority.WARN,?"Testing?a?log?message?use?a?alternate?form");logger.debug(TestLog4j.class.getName());TestLog4j2?testLog4j2?=?new?TestLog4j2(); //(1)testLog4j2.testLog();}}在類TestLog4j中我們調用了另壹個類TestLog4j2,下面看壹下類TestLog4j2的代碼。例4-b:package?TestLog4j.TestLog4j2;import?org.apache.log4j.Logger;import?org.apache.log4j.PropertyConfigurator;import?org.apache.log4j.Priority;public?class?TestLog4j2{static?Logger?logger?=?Logger.getLogger(TestLog4j2.class.getName()); //(1)public?TestLog4j2(){}public?void?testLog(){//同時輸出到控制臺和壹個文件的實例PropertyConfigurator.configure("F:\\nepalon\\log4j2.properties");logger.debug("2Start?of?the?main()");logger.info("2Just?testing?a?log?message?with?priority?set?to?INFO");logger.warn("2Just?testing?a?log?message?with?priority?set?to?WARN");logger.error("2Just?testing?a?log?message?with?priority?set?to?ERROR");logger.fatal("2Just?testing?a?log?message?with?priority?set?to?FATAL");logger.log(Priority.DEBUG,?"Testing?a?log?message?use?a?alternate?form");logger.debug("2End?of?the?main()");}}最後我們來看壹下配置文件。
例4-c:
log4j2.properties文件內容
#1區
#### Use two appenders, one to log to console, another to log to a file
log4j.rootLogger = debug, stdout,R
#2區
#Print only messages of priority WARN or higher for your category
log4j.logger.TestLog4j= , R
log4j.logger.TestLog4j.TestLog4j2=WARN
#3區
#### First appender writes to console
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
# Pattern to output the caller's file name and line number.
log4j.appender.stdout.layout.ConversionPattern=%5p [%t] (%F:%L) - %m%n
#4區
#### Second appender writes to a file
log4j.appender.R=org.apache.log4j.RollingFileAppender
log4j.appender.R.File=F:\\nepalon\\classes\\TestLog4j\\example.log
# Control the maximum log file size
log4j.appender.R.MaxFileSize=100KB
# Archive log files (one backup file here)
log4j.appender.R.MaxBackupIndex=1
log4j.appender.R.layout=org.apache.log4j.PatternLayout
log4j.appender.R.layout.ConversionPattern=%d{yyyy-MM-dd hh:mm:ss}:%p %t %c - %m%n
先看壹下運行結果。
在控制臺中的結果為:
DEBUG [main] (?:?) - Start of the main() in TestLog4j
INFO [main] (?:?) - Just testing a log message with priority set to INFO
WARN [main] (?:?) - Just testing a log message with priority set to WARN
ERROR [main] (?:?) - Just testing a log message with priority set to ERROR
FATAL [main] (?:?) - Just testing a log message with priority set to FATAL
WARN [main] (?:?) - Testing a log message use a alternate form
DEBUG [main] (?:?) - TestLog4j.TestLog4j
WARN [main] (?:?) - 2Just testing a log message with priority set to WARN
ERROR [main] (?:?) - 2Just testing a log message with priority set to ERROR
FATAL [main] (?:?) - 2Just testing a log message with priority set to FATAL
輸出文件的結果為:
2003-12-19 04:19:44:DEBUG main TestLog4j.TestLog4j - Start of the main() in TestLog4j
2003-12-19 04:19:44:INFO main TestLog4j.TestLog4j - Just testing a log message with priority set to INFO
2003-12-19 04:19:44:WARN main TestLog4j.TestLog4j - Just testing a log message with priority set to WARN
2003-12-19 04:19:44:ERROR main TestLog4j.TestLog4j - Just testing a log message with priority set to ERROR
2003-12-19 04:19:44:FATAL main TestLog4j.TestLog4j - Just testing a log message with priority set to FATAL
2003-12-19 04:19:44:WARN main TestLog4j.TestLog4j - Testing a log message use a alternate form
2003-12-19 04:19:44:DEBUG main TestLog4j.TestLog4j - TestLog4j.TestLog4j
2003-12-19 04:19:44:WARN main TestLog4j.TestLog4j2.TestLog4j2 - 2Just testing a log message with priority set to WARN
2003-12-19 04:19:44:ERROR main TestLog4j.TestLog4j2.TestLog4j2 - 2Just testing a log message with priority set to ERROR
2003-12-19 04:19:44:FATAL main TestLog4j.TestLog4j2.TestLog4j2 - 2Just testing a log message with priority set to FATAL
首先,先來看壹下配置文件都有些什麽東西。
1) 在1區中定義了壹個根記錄器。這個根記錄器具有DEBUG級別並有壹個名稱為stdout的輸出端appender。
2) 2區中的內容是這壹節的重點,也是應用到記錄器層次的地方,但其實也只有兩句,充分體現了log4j的簡單性。在這裏,我們定義了兩個名稱分別為TestLog4j和TestLog4j.TestLog4j2設計器。
在定義TestLog4j記錄器時沒有指定級別,所以它的級別繼承自它的父記錄器,即根記錄器,所以它的級別也為DEBUG。在定義TestLog4j記錄器時又定義了壹個名稱為R的輸出端,所以它的輸出端有兩個,壹個從根記錄器繼承而來的名為stdout的輸出端,另壹個為在此定義的名為R的輸出端。在此需要註意的是,在定義記錄器時必須先定義記錄器的級別,然後才是記錄器的輸出端。如果只想定義輸出端而不定義級別,則雖然級別可以為空,但逗號分隔符不能省略。如定義TestLog4j記錄器的做法。 在定義TestLog4j.TestLog4j2記錄器時又指定了它的級別,由於壹個記錄器的級別只能有壹個,所以新指定的級別將覆寫掉它的父記錄器的級別(這就象Java中的多態)。我們沒有定義TestLog4j.TestLog4j2記錄器的輸出端,所以它的輸出端將從它的父記錄器中繼承而來。它的父記錄器為estLog4j記錄器,所以它和estLog4j記錄器壹樣具有兩個名稱分別為 stdout和R的輸出端。3) 剩下的3區和4區分別設置了兩個輸出端的參數值。
接下來,回到我們的代碼,看壹下是如何取得記錄器,在取記錄器時又發生了什麽。
1) 例4-a中的代碼(2)中,語句Logger.getLogger()中的參數TestLog4j.class.getName()的值為 TestLog4j. TestLog4j,所以此語句的結果是取得壹個名為TestLog4j. TestLog4j的記錄器的對象。但在配置文件中並沒有定義這樣的記錄器,所以最終將返回與所需的名稱TestLog4j. TestLog4j最接近的記錄器對象,即名為TestLog4j的記錄器的對象。
2) 例4-b中的代碼(1)的原理與例4-a中的代碼(2)相似,期望取得的是名為TestLog4j.TestLog4j2. TestLog4j2的記錄器對象,但最終返回的是TestLog4j.TestLog4j2記錄器的對象。