Log4j是Apache的一個開放源代碼項目,通過使用Log4j,我們可以控制日誌信息輸送的目的地是控制檯、文件、GUI組件、甚至是套接口服務 器、NT的事件記錄器、UNIX Syslog守護進程等;我們也可以控制每一條日誌的輸出格式;通過定義每一條日誌信息的級別,我們能夠更加細緻地控制日誌的生成過程。
Log4j由三個重要的組件構成:日誌信息的優先級,日誌信息的輸出目的地,日誌信息的輸出格式。日誌信息的優先級從高到低有ERROR、WARN、 INFO、DEBUG,分別用來指定這條日誌信息的重要程度;日誌信息的輸出目的地指定了日誌將打印到控制檯還是文件中;而輸出格式則控制了日誌信息的顯示內容。
其實您也可以完全不使用配置文件,而是在代碼中配置Log4j環境。但是,使用配置文件將使您的應用程序更加靈活。 Log4j支持兩種配置文件格式,一種是XML格式的文件,一種是properties格式的文件。下面我們介紹使用properties格式做爲配置文件的方法: 示例: log4j.rootLogger=INFO, A1 log4j.appender.A1=org.apache.log4j.ConsoleAppender log4j.appender.A1.layout=org.apache.log4j.PatternLayout log4j.appender.A1.layout.ConversionPattern=%-4r %-5p [%t] %37c %3x - %m%n 1. 配置根Logger,其語法爲: log4j.rootLogger = [ level ] , appenderName, appenderName, … 其中,level 是日誌記錄的優先級,分爲OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者您定義的級別。Log4j建議只使用四個級別,優先級從高到低分別是ERROR、WARN、INFO、DEBUG。通過在這裏定義的級別,您可以控制到應用程序中相應級別的日誌信息的開關。比如在這裏定義了INFO級別,則應用程序中所有DEBUG級別的日誌信息將不被打印出來。 appenderName就是指定日誌信息輸出到哪個地方。您可以同時指定多個輸出目的地。 2. 配置日誌信息輸出目的地Appender,其語法爲: log4j.appender.appenderName = fully.qualified.name.of.appender.class log4j.appender.appenderName.option1 = value1 … log4j.appender.appenderName.option = valueN 其中,Log4j提供的appender有以下幾種: org.apache.log4j.ConsoleAppender(控制檯), org.apache.log4j.FileAppender(文件), org.apache.log4j.DailyRollingFileAppender(每天產生一個日誌文件), org.apache.log4j.RollingFileAppender(文件大小到達指定尺寸的時候產生一個新的文件), org.apache.log4j.WriterAppender(將日誌信息以流格式發送到任意指定的地方) (1).ConsoleAppender選項 Threshold=WARN:指定日誌消息的輸出最低層次。 ImmediateFlush=true:默認值是true,意謂着所有的消息都會被立即輸出。 Target=System.err:默認情況下是:System.out,指定輸出控制檯 (2).FileAppender 選項 Threshold=WARN:指定日誌消息的輸出最低層次。 ImmediateFlush=true:默認值是true,意謂着所有的消息都會被立即輸出。 File=mylog.txt:指定消息輸出到mylog.txt文件。 Append=false:默認值是true,即將消息增加到指定文件中,false指將消息覆蓋指定的文件內容。 (3).DailyRollingFileAppender 選項 Threshold=WARN:指定日誌消息的輸出最低層次。 ImmediateFlush=true:默認值是true,意謂着所有的消息都會被立即輸出。 File=mylog.txt:指定消息輸出到mylog.txt文件。 Append=false:默認值是true,即將消息增加到指定文件中,false指將消息覆蓋指定的文件內容。 DatePattern=’.'yyyy-ww:每週滾動一次文件,即每週產生一個新的文件。當然也可以指定按月、周、天、時和分。即對應的格式如下: 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:指定日誌消息的輸出最低層次。 ImmediateFlush=true:默認值是true,意謂着所有的消息都會被立即輸出。 File=mylog.txt:指定消息輸出到mylog.txt文件。 Append=false:默認值是true,即將消息增加到指定文件中,false指將消息覆蓋指定的文件內容。 MaxFileSize=100KB: 後綴可以是KB, MB 或者是 GB. 在日誌文件到達該大小時,將會自動滾動,即將原來的內容移到mylog.log.1文件。 MaxBackupIndex=2:指定可以產生的滾動文件的最大數。 3. 配置日誌信息的佈局,其語法爲: log4j.appender.appenderName.layout = fully.qualified.name.of.layout.class log4j.appender.appenderName.layout.option1 = value1 … log4j.appender.appenderName.layout.option = valueN 其中,Log4j提供的layout有以下幾種: org.apache.log4j.HTMLLayout(以HTML表格形式佈局), org.apache.log4j.PatternLayout(可以靈活地指定佈局模式), org.apache.log4j.SimpleLayout(包含日誌信息的級別和信息字符串), org.apache.log4j.TTCCLayout(包含日誌產生的時間、線程、類別等等信息) 4、輸出格式設置 在配置文件中可以通過log4j.appender.A1.layout.ConversionPattern設置日誌輸出格式。 參數: %p: 輸出日誌信息優先級,即DEBUG,INFO,WARN,ERROR,FATAL, %d: 輸出日誌時間點的日期或時間,默認格式爲ISO8601,也可以在其後指定格式,比如:%d{yyy MMM dd HH:mm:ss,SSS},輸出類似:2002年10月18日 22:10:28,921 %r: 輸出自應用啓動到輸出該log信息耗費的毫秒數 %c: 輸出日誌信息所屬的類目,通常就是所在類的全名 %t: 輸出產生該日誌事件的線程名 %l: 輸出日誌事件的發生位置,相當於%C.%M(%F:%L)的組合,包括類目名、發生的線程,以及在代碼中的行數。舉例:Testlog4.main(TestLog4.Java:10) %x: 輸出和當前線程相關聯的NDC(嵌套診斷環境),尤其用到像Java servlets這樣的多客戶多線程的應用中。 %%: 輸出一個”%”字符 %F: 輸出日誌消息產生時所在的文件名稱 %L: 輸出代碼中的行號 %m: 輸出代碼中指定的消息,產生的日誌具體信息 %n: 輸出一個回車換行符,Windows平臺爲”\r\n”,Unix平臺爲”\n”輸出日誌信息換行 可以在%與模式字符之間加上修飾符來控制其最小寬度、最大寬度、和文本的對齊方式。如: 1)%20c:指定輸出category的名稱,最小的寬度是20,如果category的名稱小於20的話,默認的情況下右對齊。 2)%-20c:指定輸出category的名稱,最小的寬度是20,如果category的名稱小於20的話,”-”號指定左對齊。 3)%.30c:指定輸出category的名稱,最大的寬度是30,如果category的名稱大於30的話,就會將左邊多出的字符截掉,但小於30的話也不會有空格。 4)%20.30c:如果category的名稱小於20就補空格,並且右對齊,如果其名稱長於30字符,就從左邊交遠銷出的字符截掉。
log4j應用實例
測試log4j的項目結構
Log4j.properties的路徑爲 src/config/log4j
Log4j.properties文件的內容
下面定義日誌輸出級別是 INFO,並且配置了2個輸出目的地,一個是A3,一個是console
log4j.rootLogger = INFO,A3,CONSOLE
//日誌最低的輸出級別
log4j.appender.A3.Threshold=INFO
log4j.appender.A3.encoding=UTF-8
//每天產生一個文件DailyRollingFileAppender
log4j.appender.A3 = org.apache.log4j.DailyRollingFileAppender
//file 屬性 指定產生日誌文件的保存位置及文件名,這裏是windows下的配置
// c:/logtest/logtest.log,
//公司項目在linux下的配置是/app/weblogic/applications/logs/sxvip_logs
log4j.appender.A3.File=c:/logtest/logtest.log
//當有日誌時立即輸出,默認是true
log4j.appender.A3.ImmediateFlush=true
log4j.appender.A3.DatePattern='_'yyyy-MM-dd
//日誌佈局方式
log4j.appender.A3.layout=org.apache.log4j.PatternLayout
//日誌文件中日誌的格式
log4j.appender.A3.layout.ConversionPattern=%-d{yyyy/MM/dd HH:mm:ss} OSS %-5p [%c] - %m%n
//這裏使用org.apache.log4j.ConsoleAppender指定要把日誌輸出到控制檯
log4j.appender.CONSOLE=org.apache.log4j.ConsoleAppender
log4j.appender.Threshold=INFO
//輸出目標是 控制檯
log4j.appender.CONSOLE.Target=System.out
log4j.appender.CONSOLE.layout=org.apache.log4j.PatternLayout
log4j.appender.CONSOLE.layout.ConversionPattern=%-d{yyyy/MM/dd HH:mm:ss} OSS %-5p [%c] - %m%n