定義
log4j--log for java(java的日志)n
在強調可重用組件開發的今天,除了自己從頭到尾開發一個可重用的日志操作類外,Apache為我們提供了一個強有力的日志操作包-Log4j。n
此外,通過Log4j其他語言接口,您可以在C、C++、.Net、PL/SQL程序中使用Log4j,其語法和用法與在Java程序中一樣,使得多語言分布式系統得到一個統一一緻的日志組件模塊。而且,通過使用各種第三方擴展,您可以很方便地将Log4j集成到J2EE、JINI甚至是SNMP應用中。n
說明:下面分為三部分,n
第一部分講解如何配置log4j;n
第二部分為對log4j.properties配置文件中的各個屬性的講解;n
第三部分為對log4j的詳細講解。n
如果隻想配置上log4j,那麼隻需要看前兩個部分就可以,如果想對log4j深入了解,則還需看第三部分。n使用的license:Apache License V2.0。
配置
第一步n
加入log4j-1.2.8.jar(可以選擇log4j的更高版本)到lib下。n
如果使用maven項目,也可以選擇在pom.xml中新增依賴:n
第二步n
在CLASSPATH下建立log4j.properties。内容如下(數字為行号):
第三步n
相應的修改其中屬性,修改之前就必須知道這些都是幹什麼的,在第二部分講解。
第四步n
在要輸出日志的類中加入相關語句:n
定義屬性:static Logger logger=Logger.getLogger(LogDemo.class);//LogDemo為相關的類。n
在相應的方法中:n
if(logger.isDebugEnabled()){n
logger.debug(“System…..”);n}
說明
1、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。
2、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。
3、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。
4、log4j.appender.stdout.layout.ConversionPattern=【QC】 %p 【%t】 %C.%M(%L) | %m%n
如果使用pattern布局就要指定的打印信息的具體格式ConversionPattern,打印參數如下:
%m輸出代碼中指定的消息;n
%M輸出打印該條日志的方法名;n
%p輸出優先級,即DEBUG,INFO,WARN,ERROR,FATAL;n
%r輸出自應用啟動到輸出該log信息耗費的毫秒數;n
%c輸出所屬的類目,通常就是所在類的全名;n
%t輸出産生該日志事件的線程名;n
%n輸出一個回車換行符,Windows平台為"rn”,Unix平台為"n”;n
%d輸出日志時間點的日期或時間,默認格式為ISO8601,也可以在其後指定格式,比如:%d{yyyy-MM-dd HH:mm:ss,SSS},輸出類似:2002-10-18 22:10:28,921;n
%l輸出日志事件的發生位置,及在代碼中的行數;
【QC】是log信息的開頭,可以為任意字符,一般為項目簡稱。
輸出的信息
【TS】DEBUG【main】AbstractBeanFactory.getBean(189) | Returning cached instance of singleton bean'MyAutoProxy'
具體講解可參照第三部分定義配置文件中的格式化日志信息。
5、log4j.appender.R=org.apache.log4j.DailyRollingFileAppender
此句與第3行一樣。定義名為R的輸出端的類型為每天産生一個日志文件。
6、log4j.appender.R.File=D:Tomcat 5.5logsqc.log
此句為定義名為R的輸出端的文件名為D:Tomcat 5.5logsqc.log可以自行修改。
7、log4j.appender.R.layout=org.apache.log4j.PatternLayout
與第4行相同。
8、log4j.appender.R.layout.ConversionPattern=%d-【TS】 %p %t %c-%m%n
與第5行相同。
9、log4j.logger.com.neusoft=DEBUG
指定com.neusoft包下的所有類的等級為DEBUG。
可以把com.neusoft改為自己項目所用的包名。
10、log4j.logger.com.opensymphony.oscache=ERROR
11、log4j.logger.net.sf.navigator=ERROR
這兩句是把這兩個包下出現的錯誤的等級設為ERROR,如果項目中沒有配置ehcache,則不需要這兩句。
12、log4j.logger.org.apache.commons=ERRORn
13、log4j.logger.org.apache.struts=WARNn
這兩句是struts的包。n
14、log4j.logger.org.displaytag=ERRORn
這句是displaytag的包。(QC問題列表頁面所用)n
15、log4j.logger.org.springframework=DEBUGn
此句為Spring的包。n
16、log4j.logger.org.hibernate.ps.PreparedStatementCache=WARNn
17、log4j.logger.org.hibernate=DEBUGn
此兩句是hibernate的包。n
以上這些包的設置可根據項目的實際情況而自行定制。
詳解
定義配置文件
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函數的打印格式格式化日志信息,打印參數如下:n
%m輸出代碼中指定的消息;n
%M輸出打印該條日志的方法名;n
%p輸出優先級,即DEBUG,INFO,WARN,ERROR,FATAL;n
%r輸出自應用啟動到輸出該log信息耗費的毫秒數;n
%c輸出所屬的類目,通常就是所在類的全名;n
%t輸出産生該日志事件的線程名;n
%n輸出一個回車換行符,Windows平台為"rn”,Unix平台為"n”;n
%d輸出日志時間點的日期或時間,默認格式為ISO8601,也可以在其後指定格式,比如:%d{yyyy-MM-dd HH:mm:ss,SSS},輸
出類似:2002-10-18 22:10:28,921;n
%l輸出日志事件的發生位置,及在代碼中的行數。
運用在代碼中
我們在需要輸出日志信息的類中做如下的三個工作:n
1、導入所有需的commons-logging類:n
import org.apache.commons.logging.Log;n
import org.apache.commons.logging.LogFactory;n
2、在自己的類中定義一個org.apache.commons.logging.Log類的私有靜态類成員:n
private final Log log=LogFactory.getLog(getClass());n
LogFactory.getLog()方法的參數使用的是當前類的class。n
3、使用org.apache.commons.logging.Log類的成員方法輸出日志信息:n
if(log.isDebugEnabled()){n
log.debug("111");n
}n
if(log.isInfoEnabled()){n
log.info("222");n
}n
if(log.isWarnEnabled()){n
log.warn("333");n
}n
if(log.isErrorEnabled()){n
log.error("444");n
}n
if(log.isFatalEnabled()){n
log.fatal("555");n
}n
2.3如何應用記錄器的層次n
2.3.1如何定義及獲取不同層次的記錄器n
任何一個記錄器的使用都有兩個步驟:n
1)在配置文件中定義相應的記錄器。n
在配置文件中定義記錄器的格式有兩種n
?定義根記錄器的格式為n
log4j.rootLogger=[level],appendName1,appendName2,…appendNameNn
?定義一個非根記錄器的格式為n
log4j.logger.loggerName1=[level],appendName1,…appendNameNn
……n
log4j.logger.loggerNameM=[level],appendName1,…appendNameNn
我們可以定義任意個非根記錄器。n
2)在代碼中調用Logger類的取得記錄器方法取得相應的記錄器對象。n
要取得根記錄器對象可通過Logger.getRootLogger()函數,要取得非根記錄器可通過Logger.getLogger()函數。