log4j配置祥解

log4j配置祥解

第一步：加入log4j-1.2.8.jar到lib下。

第二步：在CLASSPATH下建立log4j.properties。內容如下：

l###setloglevels###
log4j.rootLogger=info,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 [%t] %-5p [%c] - %m%n
log4j.appender.stdout.Encoding=UTF-8

### 輸出到日誌文件 ###
log4j.appender.D = org.apache.log4j.DailyRollingFileAppender
##${webapp.root}的值爲應用所在的路徑
log4j.appender.D.File = ${webapp.root}/logs/log.log
log4j.appender.D.Append = true
## 輸出DEBUG級別以上的日誌
log4j.appender.D.Threshold = DEBUG 
log4j.appender.D.layout = org.apache.log4j.PatternLayout
log4j.appender.D.layout.ConversionPattern = %d [%t] %-5p [%c] - %m%n
log4j.appender.D.Encoding=UTF-8

### 保存異常信息到單獨文件 ###
log4j.appender.E = org.apache.log4j.DailyRollingFileAppender
## 異常日誌文件名
log4j.appender.E.File =  ${webapp.root}/logs/error.log 
log4j.appender.E.Append = true
## 只輸出ERROR級別以上的日誌!!!
log4j.appender.E.Threshold = ERROR 
log4j.appender.E.layout = org.apache.log4j.PatternLayout
log4j.appender.E.layout.ConversionPattern = %d [%t] %-5p [%c] - %m%n
log4j.appender.E.Encoding=UTF-8

第三步：相應的修改其中屬性，修改之前就必須知道這些都是幹什麼的，在第二部分講解。
第四步：在要輸出日誌的類中加入相關語句：

定義屬性：protected final Log log = LogFactory.getLog(getClass());
在相應的方法中：
if (log.isDebugEnabled())
{
log.debug(“System …..”);
}

二、Log4j說明
log4j.rootCategory=INFO, stdout , R
此句爲將等級爲INFO的日誌信息輸出到stdout和R這兩個目的地，stdout和R的定義在下面的代碼，可以任意起名。等級可分爲OFF、 FATAL、ERROR、WARN、INFO、DEBUG、ALL，如果配置OFF則不打出任何信息，如果配置爲INFO這樣只顯示INFO, WARN, ERROR的log信息，而DEBUG信息不會被顯示，具體講解可參照第三部分定義配置文件中的logger。
 log4j.appender.stdout=org.apache.log4j.ConsoleAppender
此句爲定義名爲stdout的輸出端是哪種類型，可以是
org.apache.log4j.ConsoleAppender（控制檯），
org.apache.log4j.FileAppender（文件），
org.apache.log4j.DailyRollingFileAppender（每天產生一個日誌文件），
org.apache.log4j.RollingFileAppender（文件大小到達指定尺寸的時候產生一個新的文件）
org.apache.log4j.WriterAppender（將日誌信息以流格式發送到任意指定的地方）

具體講解可參照第三部分定義配置文件中的Appender。
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
此句爲定義名爲stdout的輸出端的layout是哪種類型，可以是
org.apache.log4j.HTMLLayout（以HTML表格形式佈局），
org.apache.log4j.PatternLayout（可以靈活地指定佈局模式），
org.apache.log4j.SimpleLayout（包含日誌信息的級別和信息字符串），
org.apache.log4j.TTCCLayout（包含日誌產生的時間、線程、類別等等信息）

具體講解可參照第三部分定義配置文件中的Layout。
log4j.appender.stdout.layout.ConversionPattern= [QC] %p [%t] %C.%M(%L) | %m%n
如果使用pattern佈局就要指定的打印信息的具體格式ConversionPattern，打印參數如下：
%m 輸出代碼中指定的消息
%p 輸出優先級，即DEBUG，INFO，WARN，ERROR，FATAL
%r 輸出自應用啓動到輸出該log信息耗費的毫秒數
%c 輸出所屬的類目，通常就是所在類的全名
%t 輸出產生該日誌事件的線程名
%n 輸出一個回車換行符，Windows平臺爲“rn”，Unix平臺爲“n”
%d 輸出日誌時間點的日期或時間，默認格式爲ISO8601，也可以在其後指定格式，比如：%d{yyyy MMM dd HH:mm:ss,SSS}，輸出類似：2002年10月18日 22：10：28，921
%l 輸出日誌事件的發生位置，包括類目名、發生的線程，以及在代碼中的行數。
[QC]是log信息的開頭，可以爲任意字符，一般爲項目簡稱。

輸出的信息
[TS] DEBUG [main] AbstractBeanFactory.getBean(189) | Returning cached instance of singleton bean 'MyAutoProxy'
具體講解可參照第三部分定義配置文件中的格式化日誌信息。
 log4j.appender.R=org.apache.log4j.DailyRollingFileAppender
此句與第3行一樣。定義名爲R的輸出端的類型爲每天產生一個日誌文件。
 log4j.appender.R.File=D:\Tomcat 5.5\logs\qc.log
此句爲定義名爲R的輸出端的文件名爲D:\Tomcat 5.5\logs\qc.log
可以自行修改。
log4j.appender.R.layout=org.apache.log4j.PatternLayout
與第4行相同。
log4j.appender.R.layout.ConversionPattern=%d-[TS] %p %t %c - %m%n
與第5行相同。
log4j.logger.com. neusoft =DEBUG
指定com.neusoft包下的所有類的等級爲DEBUG。
可以把com.neusoft改爲自己項目所用的包名。
log4j.logger.com.opensymphony.oscache=ERROR
 log4j.logger.net.sf.navigator=ERROR
這兩句是把這兩個包下出現的錯誤的等級設爲ERROR，如果項目中沒有配置EHCache，則不需要這兩句。
log4j.logger.org.apache.commons=ERROR
 log4j.logger.org.apache.struts=WARN
這兩句是struts的包。
 log4j.logger.org.displaytag=ERROR
這句是displaytag的包。（QC問題列表頁面所用）
log4j.logger.org.springframework=DEBUG
此句爲Spring的包。
 log4j.logger.org.hibernate.ps.PreparedStatementCache=WARN
log4j.logger.org.hibernate=DEBUG
此兩句是hibernate的包。
以上這些包的設置可根據項目的實際情況而自行定製。

三、log4j詳解

1、定義配置文件
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（包含日誌產生的時間、線程、類別等等信息）

2、格式化日誌信息
Log4J採用類似C語言中的printf函數的打印格式格式化日誌信息，打印參數如下：
%m 輸出代碼中指定的消息
%p 輸出優先級，即DEBUG，INFO，WARN，ERROR，FATAL
%r 輸出自應用啓動到輸出該log信息耗費的毫秒數
%c 輸出所屬的類目，通常就是所在類的全名
%t 輸出產生該日誌事件的線程名
%n 輸出一個回車換行符，Windows平臺爲“rn”，Unix平臺爲“n”
%d 輸出日誌時間點的日期或時間，默認格式爲ISO8601，也可以在其後指定格式，比如：%d{yyyy MMM dd HH:mm:ss,SSS}，輸出類似：2002年10月18日 22：10：28，921
%l 輸出日誌事件的發生位置，包括類目名、發生的線程，以及在代碼中的行數。
3、在代碼中使用Log4j

我們在需要輸出日誌信息的類中做如下的三個工作：

1、導入所有需的commongs-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")
}