Log4j配置檔案以及配置方法

Log4J的配置檔案(Configuration File)就是用來設定記錄器的級别、存放器和布局的，它可接key=value格式的設定或xml格式的設定資訊。通過配置，可以建立出Log4J的運作環境。Log4j的配置檔案是一個叫做Log4j.properties的檔案。

log4j.properties檔案：

#newhappy  log4j.properties start

log4j.rootLogger=DEBUG,myConsole,myLogFile

#console appender

log4j.appender.myConsole=org.apache.log4j.ConsoleAppender

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

log4j.appender.myConsole.layout.ConversionPattern=%5p [%t] (%F:%L) -%m%n

log4j.appender.myConsole.threshold=FATAL

#rolling file appender

log4j.appender.myLogFile=org.apache.log4j.RollingFileAppender

log4j.appender.myLogFile.File=mylog.log

log4j.appender.myLogFile.MaxFileSize=100KB

log4j.appender.myLogFile.MaxBackupIndex=2

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

log4j.appender.myLogFile.layout.ConversionPattern=%d{mmm d,yyyy hh:mm:ss a} : %p [%t] %m%n

log4j.appender.myLogFile.threshold=ERROR

#newhappy log4j.properties end

1. 配置檔案

Log4J配置檔案的基本格式如下： 

 #配置根Logger

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

#配置日志資訊輸出目的地Appender

log4j.appender.appenderName  =  fully.qualified.name.of.appender.class 

　　log4j.appender.appenderName.option1  =  value1 

　　… 

　　log4j.appender.appenderName.optionN  =  valueN 

#配置日志資訊的格式（布局）

log4j.appender.appenderName.layout  =  fully.qualified.name.of.layout.class 

　　log4j.appender.appenderName.layout.option1  =  value1 

　　log4j.appender.appenderName.layout.optionN  =  valueN 

其中 [level] 是日志輸出級别，共有5級：

 FATAL      0  

ERROR      3  

WARN       4  

INFO       6  

DEBUG      7 

Appender 為日志輸出目的地，Log4j提供的appender有以下幾種：

 org.apache.log4j.ConsoleAppender（控制台），

org.apache.log4j.FileAppender（檔案），

org.apache.log4j.DailyRollingFileAppender（每天産生一個日志檔案），

org.apache.log4j.RollingFileAppender（檔案大小到達指定尺寸的時候産生一個新的檔案），

org.apache.log4j.WriterAppender（将日志資訊以流格式發送到任意指定的地方）

Layout：日志輸出格式，Log4j提供的layout有以下幾種：

 org.apache.log4j.HTMLLayout（以HTML表格形式布局），

org.apache.log4j.PatternLayout（可以靈活地指定布局模式），

org.apache.log4j.SimpleLayout（包含日志資訊的級别和資訊字元串），

org.apache.log4j.TTCCLayout（包含日志産生的時間、線程、類别等等資訊）

列印參數: Log4J采用類似C語言中的printf函數的列印格式格式化日志資訊，如下:

 　 %m 輸出代碼中指定的消息

　　%p   輸出優先級，即DEBUG，INFO，WARN，ERROR，FATAL 

　　%r   輸出自應用啟動到輸出該log資訊耗費的毫秒數 

　　%c   輸出所屬的類目，通常就是所在類的全名 

　　%t   輸出産生該日志事件的線程名 

　　%n   輸出一個回車換行符，Windows平台為“\r\n”，Unix平台為“\n” 

　　%d   輸出日志時間點的日期或時間，預設格式為ISO8601，也可以在其後指定格式，比如：%d{yyy MMM dd HH:mm:ss , SSS}，輸出類似：2002年10月18日  22 ： 10 ： 28 ， 921  

　　%l   輸出日志事件的發生位置，包括類目名、發生的線程，以及在代碼中的行數。舉例：Testlog4.main(TestLog4.java: 10 ) 

2. 在代碼中初始化Logger: 

1）在程式中調用BasicConfigurator.configure()方法：給根記錄器增加一個ConsoleAppender，輸出格式通過PatternLayout設為"%-4r [%t] %-5p %c %x - %m%n"，還有根記錄器的預設級别是Level.DEBUG. 

2）配置放在檔案裡，通過指令行參數傳遞檔案名字，通過PropertyConfigurator.configure(args[x])解析并配置；

3）配置放在檔案裡，通過環境變量傳遞檔案名等資訊，利用log4j預設的初始化過程解析并配置；

4）配置放在檔案裡，通過應用伺服器配置傳遞檔案名等資訊，利用一個特殊的servlet來完成配置。

3. 為不同的 Appender 設定日志輸出級别：

當調試系統時，我們往往注意的隻是異常級别的日志輸出，但是通常所有級别的輸出都是放在一個檔案裡的，如果日志輸出的級别是BUG！？那就慢慢去找吧。

這時我們也許會想要是能把異常資訊單獨輸出到一個檔案裡該多好啊。當然可以，Log4j已經提供了這樣的功能，我們隻需要在配置中修改Appender的Threshold 就能實作,比如下面的例子：

[配置檔案]

 ### set log levels ###

log4j.rootLogger = debug ,  stdout ,  D ,  E

### 輸出到控制台 ###

log4j.appender.stdout = org.apache.log4j.ConsoleAppender

log4j.appender.stdout.Target = System.out

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

log4j.appender.stdout.layout.ConversionPattern =  %d{ABSOLUTE} %5p %c{ 1 }:%L - %m%n

### 輸出到日志檔案 ###

log4j.appender.D = org.apache.log4j.DailyRollingFileAppender

log4j.appender.D.File = logs/log.log

log4j.appender.D.Append = true

log4j.appender.D.Threshold = DEBUG ## 輸出DEBUG級别以上的日志

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

log4j.appender.D.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss}  [ %t:%r ] - [ %p ]  %m%n

### 儲存異常資訊到單獨檔案 ###

  log4j.appender.D.File = logs/error.log ## 異常日志檔案名

log4j.appender.D.Threshold = ERROR ## 隻輸出ERROR級别以上的日志!!!

log4j.appender.D.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss}  [ %t:%r ] - [ %p ]  %m%n

[代碼中使用] 

 public   class  TestLog4j   {

     public   static   void  main(String[] args)   {

        PropertyConfigurator.configure( " D:/Code/conf/log4j.properties " );

        Logger logger  =  Logger.getLogger(TestLog4j. class );

        logger.debug( " debug " );

        logger.error( " error " );

    } 

}

運作一下，看看異常資訊是不是儲存在了一個單獨的檔案error.log中。 

4、對不同的包設定不同輸出資訊級别

eg：

列印OppenSessionInViewFilter中debug級别資訊方法：

log4j.logger.org.springframework.orm.hibernate3.support.OpenSessionInViewFilter=debug

列印Struts标簽中warn級别資訊的方法：

log4j.logger.org.apache.struts.util=WARN

原理：

 Suppose   we   are   no   longer   interested   in   seeing   the   output   of   any   component   belonging   to   the   com.foo   package.   The   following   configuration   file   shows   one   possible   way   of   achieving   this.     

  log4j.rootLogger=DEBUG,   A1   

  log4j.appender.A1=org.apache.log4j.ConsoleAppender   

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

  #   Print   the   date   in   ISO   8601   format   

  log4j.appender.A1.layout.ConversionPattern=%d   [%t]   %-5p   %c   -   %m%n   

  #   Print   only   messages   of   level   WARN   or   above   in   the   package   com.foo.   

  log4j.logger.com.foo=WARN  

本文轉自 牛海彬 51CTO部落格，原文連結：http://blog.51cto.com/newhappy/135703，如需轉載請自行聯系原作者