1.Log4j
1.1了解Log4j
Log4j是Apache的一個開源項目,通過使用log4j,我們可以控制日志信息輸送的目的地可以是控制台、文件、GUI組件,我們也可以控制每一條日志的輸出格式,通過定義每一條日志信息的級別,我們能夠更加細致的控制日志的生成過程。
1.2配置Log4j步驟(java項目)
在java程序中配置Log4j日志共分為4步:
1.第一步
加入log4j-1.2.8.jar(可以選擇log4j的更高版本)到lib下。
如果使用maven項目,也可以選擇在pom.xml中新增依賴:
<!-- 加入log4j支持 -->
<dependency>
<groupId>log4j</groupId>
<artifactId>log4j</artifactId>
<version>1.2.17</version>
</dependency>
2.第二步
在CLASSPATH下建立log4j.prope相應的修改其中屬性,修改之前就必須知道這些都是干log4j.rootLogger=INFO,stdout,R
#setting
#Logger
log4j.rootLogger=debug,stdout
#appender
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.Append = true
#過濾(不記錄)INFO級別以下的消息
log4j.appender.stdout.Threshold = INFO
#layout
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
#conversion
log4j.appender.stdout.layout.ConversionPattern=[%p] %d{yyyy-MM-dd HH\:mm\:ss,SSS} method\:%l%n%m%n
消息級別:ALL<DEBUG<INFO<WARN<ERROR<FATAL<OFF。
4.第四步
在要輸出日志的類中加入相關語句:
定義屬性:static Logger logger = Logger.getLogger(LogDemo.class); //LogDemo為相關的類
在相應的方法中:
if (logger.isDebugEnabled()){
logger.debug("System …..");
}
1.3配置說明
以下是配置文件log4j.properties的配置說明。
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 輸出代碼中指定的消息;
%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 輸出日志事件的發生位置,及在代碼中的行數;
[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.5\\logs\\qc.log
此句為定義名為R的輸出端的文件名為D:\\Tomcat 5.5\\logs\\qc.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=ERROR
13、log4j.logger.org.apache.struts=WARN
這兩句是struts的包。
14、log4j.logger.org.displaytag=ERROR
這句是displaytag的包。(QC問題列表頁面所用)
15、log4j.logger.org.springframework=DEBUG
此句為Spring的包。
16、log4j.logger.org.hibernate.ps.PreparedStatementCache=WARN
17、log4j.logger.org.hibernate=DEBUG
此兩句是hibernate的包。
以上這些包的設置可根據項目的實際情況而自行定制。
1.4配置文件詳解
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(包含日志產生的時間、線程、類別等等信息)
1.5格式化日志
當log4j.applender.appendlerName=org.apache.log4j.PatternLayout時,那么表示想要自定義輸出格式,因此需要設置log4j.appender.stdout.layout.ConversionPattern。
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.6定義及獲取不同層次的記錄器
任何一個記錄器的使用都有兩個步驟:
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()函數。
1.7基於java web項目配置log4j
到目前為止,這篇文章講的都是如何在application中應用log4j,而Java現在的應用主流是J2EE和J2ME。現在,我們來看一下要如何在 J2EE開發中應用log4j。其實在Web application中應用log4j也很簡單,與在application中應用log4j不同之處就是要在所有應用log4j的代碼之前對log4j進行初始化。所以,我們在web application中就要把log4j的初始化工作獨立出來,把它放在Servlet中。下面,我們看一個例子。
例5-a: 進行初始化的Servlet: import org.apache.log4j.PropertyConfigurator; import javax.servlet.http.HttpServlet; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; /** * log4j.jar的初始化類,參考web.xml */ public class Log4jInit extends HttpServlet { public void init() { //通過web.xml來動態取得配置文件 String prefix = getServletContext().getRealPath("/"); String file = getInitParameter("log4j-init-file"); // 如果沒有給出相應的配置文件,則不進行初始化 if(file != null) { PropertyConfigurator.configure(prefix+file); //(1) } } public void doGet(HttpServletRequest req, HttpServletResponse res) {} }
下面來看一下這個Servlet在web.xml中的定義。
例5-b: <servlet> <servlet-name>log4j-init</servlet-name> <servlet-class>TestLog4j.Log4jInit</servlet-class> <init-param> <param-name>log4j-init-file</param-name> <param-value>sort.properties</param-value> </init-param> <load-on-startup>1</load-on-startup> </servlet>
因為log4j的初始化要在所有的log4j調用之前完成,所以在web.xml文件中,我們一定要把對應的Servlet定義的load-on-startup應設為1,以便在Web容器啟動時即裝入該Servlet。
完成了這兩個步驟這后,我們就可以象在application開發中一樣在web application任何地方應用log4j了。