給你的Java應(yīng)用程序加上日志技巧
發(fā)表時間:2024-02-08 來源:明輝站整理相關(guān)軟件相關(guān)文章人氣:
[摘要]每個應(yīng)用程序都需要某種方式同外部世界進(jìn)行通信并收集數(shù)據(jù)。這可以利用數(shù)據(jù)庫通過接口來實現(xiàn),也可以用文本文件來完成。在面對這么多選擇的時候,使用普通文本文件來收集和調(diào)試數(shù)據(jù)似乎已經(jīng)被遺忘了。盡管文本文件無法像最新、最酷的技術(shù)那樣帶給你快感,但是它們(確實)是收集數(shù)據(jù)和診斷應(yīng)用程序故障的有效手段。 L...
每個應(yīng)用程序都需要某種方式同外部世界進(jìn)行通信并收集數(shù)據(jù)。這可以利用數(shù)據(jù)庫通過接口來實現(xiàn),也可以用文本文件來完成。在面對這么多選擇的時候,使用普通文本文件來收集和調(diào)試數(shù)據(jù)似乎已經(jīng)被遺忘了。盡管文本文件無法像最新、最酷的技術(shù)那樣帶給你快感,但是它們(確實)是收集數(shù)據(jù)和診斷應(yīng)用程序故障的有效手段。
Log4j程序包
Java編程語言里可以用的庫使得向文件寫入數(shù)據(jù)變?nèi)菀琢,但是為什么還要在有好程序包可用的情況下重新發(fā)明車輪呢?Java 2 SDK的1.4版將一個日志編寫API內(nèi)置進(jìn)了語言里,但是在它變得更加成熟之前,我還是更愿意堅持使用更加可靠的工具——比如Log4j程序包。我發(fā)現(xiàn)它很強(qiáng)健,很可靠,很容易擴(kuò)展,而且很容易實現(xiàn)。你可以從Apache Jakarta計劃獲得Log4j。要使用這個程序包,你只需要把log4j.jar文件放在用于應(yīng)用程序的CLASSPATH目錄里。
類別從根開始
Log4j這個程序包按照類別的概念來組織。在你的應(yīng)用程序運行期間,Log4j可以有任意多個類別。但是總會有一個根類別,它是類別層次開始的地方。類別用點符號來命名,就像Java程序包一樣。這使得將專門的日志放在你的應(yīng)用程序變得很容易,而應(yīng)用程序能夠使用代碼的已有結(jié)構(gòu)來控制日志statement的處理方式。
類別是可以繼承的,所以一個叫做com.versatilesolutions.example的類別可以從com.versatilesolutions類別繼承其設(shè)置。你可以為類別賦予優(yōu)先權(quán),讓其控制應(yīng)用程序能夠記錄的日志量?捎玫膬(yōu)先權(quán)有調(diào)試(debug)、信息(info)、警告(warn)、錯誤(error),以及致命錯誤(fatal)等。在調(diào)用日志記錄程序的時候,你要使用和不同優(yōu)先權(quán)相對應(yīng)的方法,來指定日志statement的優(yōu)先權(quán)。如果你正在進(jìn)行的操作很耗資源,那么你可以檢查一下當(dāng)前的優(yōu)先權(quán)是否在活動,以保證耗資源的操作只在statement真正被日志記錄的時候進(jìn)行。
日志的類型和布局
當(dāng)日志程序包接收到statement的時候,Log4j用appender來指定進(jìn)行什么類型的日志記錄。Log4j的標(biāo)準(zhǔn)appender有屏幕、文件、旋轉(zhuǎn)文件,以及能夠在中央地點收集日志數(shù)據(jù)的遠(yuǎn)程appender。Appender被用于類別,這樣的話,應(yīng)用程序不同的部分就有不同的日志目的地。
一旦你為類別設(shè)置好了優(yōu)先權(quán)和appender,那么剩下的唯一要求就是指定布局了。布局被用來控制你日志statement的具體格式,例如日期、時間、模塊名稱,以及線程的ID。我不會講到所有可用的格式,因為你可以從Log4j的文檔里獲得這些格式完整的摘要。
Log4j的配置可以用XML文件或者Java屬性文件來完成。我更喜歡利用Java屬性文件這一技術(shù),因為使用XML文件實現(xiàn)這一目的的例子太多了。Listing A里是一個用來配置Log4j的屬性文件。
這個屬性文件里的第一個非注釋行指出,根類別具有調(diào)試的優(yōu)先權(quán),而且擁有三個appender,分別由A1、A2和A3來識別。剩下的部分指定了用于每個標(biāo)識符的appender。在這個屬性里,appender是一個控制臺(屏幕)、一個旋轉(zhuǎn)文件(rotating file),以及一個UDP廣播器。
UDP廣播器是我加到Log4j程序包里的一個appender,這樣我可以用交互方式來觀察日志statement。每個appender都附加有一個布局對象。在本文里,我們用到了PatternLayout,它后面接有轉(zhuǎn)化模式。這個轉(zhuǎn)化模式里的字符被用來指定輸出。%這個符號用于指定格式字符。在這個例子里,%-5p表示用5個字符取得優(yōu)先權(quán)(p)的左對齊。然后是日期(%d)、線程信息(%t),以及消息(%m),后面還接有行結(jié)束字符(%n)。
要在你的應(yīng)用程序里使用Log4j,你需要使用PropertyConfigurator來加載這個屬性文件。在你啟動類里加上下面這一行就能夠?qū)崿F(xiàn)目的:
import org.apache.log4j.PropertyConfigurator;
….
PropertyConfigurator.configure("path/to/file.properties");
一旦配置被加載,那么要求日志記錄能力的應(yīng)用程序里的每個類都需要參考類別對象。由于類別采用程序包命名的慣例,所以我常常將類的名稱用作類別(名稱),即使這不是必需的,是否需要還取決于你如何安排配置。聲明一個用于類的靜態(tài)變量就會讓日志程序可供使用:
import org.apache.log4j.Category;
….
private static final Category log = Category.getInstance(MyClass.class.getName());
記錄事件
現(xiàn)在,在你的應(yīng)用程序里記錄日志就很容易了。你只需要調(diào)用一個方法就行了,這個方法和你正在記錄的消息的優(yōu)先權(quán)相對應(yīng)。例如下面是一條調(diào)試消息:
log.debug("Log4j really works!");
如果你想要確保調(diào)試優(yōu)先權(quán)是活動的,那么你就要在進(jìn)行調(diào)試調(diào)用之前檢查它。要注意,即使你發(fā)送消息,它也不會被記錄下來,除非優(yōu)先權(quán)被正確地設(shè)置。檢查當(dāng)前的優(yōu)先權(quán),只是在嘗試日志操作之前避免耗資源操作的一種方法。下面是在日志陳述之前檢查優(yōu)先權(quán)的一個例子。
if ( log.isDebugEnabled() ) {
log.debug("Another log statement.”);
}
你還可以給日志方法加上一個異常,這樣的話,異常的細(xì)節(jié)就會被記錄在日志消息里。這個調(diào)用的格式如下:
log.warn("Oops caught an exception.", myException);
這應(yīng)該就是你需要的一切
如果你當(dāng)前的應(yīng)用程序或者未來的發(fā)展需要一個強(qiáng)健的日志記錄工具,那么試一下Log4j程序包。它提供了極大的靈活性,有了可配置的appender和優(yōu)先權(quán)系統(tǒng),你可以控制日志記錄,并為你產(chǎn)品的發(fā)布調(diào)整它,而不需要消耗系統(tǒng)的大量資源。