給你的Java應用程式加上日志功能
來源：互連網
作者：佚名
時間：2006-04-07
Tag：
點選：
每個應用程式都需要某種方式同外部世界進行通信并收集資料。這可以利用資料庫通過接口來實作，也可以用文本檔案來完成。在面對這麼多選擇的時候，使用普通文本檔案來收集和調試資料似乎已經被遺忘了。盡管文本檔案無法像最新、最酷的技術那樣帶給你快感，但是它們(确實)是收集資料和診斷應用程式故障的有效手段。
Log4j程式包
Java程式設計語言裡可以用的庫使得向檔案寫入資料變容易了，但是為什麼還要在有好程式包可用的情況下重新發明車輪呢？Java 2 SDK的1.4版将一個日志編寫API内置進了語言裡，但是在它變得更加成熟之前，我還是更願意堅持使用更加可靠的工具——比如Log4j程式包。我發現它很強健，很可靠，很容易擴充，而且很容易實作。你可以從Apache Jakarta計劃獲得Log4j。要使用這個程式包，你隻需要把log4j.jar檔案放在用于應用程式的CLASSPATH目錄裡。
類别從根開始
Log4j這個程式包按照類别的概念來組織。在你的應用程式運作期間，Log4j可以有任意多個類别。但是總會有一個根類别，它是類别層次開始的地方。類别用點符号來命名，就像Java程式包一樣。這使得将專門的日志放在你的應用程式變得很容易，而應用程式能夠使用代碼的已有結構來控制日志statement的處理方式。
類别是可以繼承的，是以一個叫做com.versatilesolutions.example的類别可以從com.versatilesolutions類别繼承其設定。你可以為類别賦予優先權，讓其控制應用程式能夠記錄的日志量。可用的優先權有調試(debug)、資訊(info)、警告(warn)、錯誤(error)，以及緻命錯誤(fatal)等。在調用日志記錄程式的時候，你要使用和不同優先權相對應的方法，來指定日志statement的優先權。如果你正在進行的操作很耗資源，那麼你可以檢查一下目前的優先權是否在活動，以保證耗資源的操作隻在statement真正被日志記錄的時候進行。
日志的類型和布局
當日志程式包接收到statement的時候，Log4j用appender來指定進行什麼類型的日志記錄。Log4j的标準appender有螢幕、檔案、旋轉檔案，以及能夠在中央地點收集日志資料的遠端appender。Appender被用于類别，這樣的話，應用程式不同的部分就有不同的日志目的地。
一旦你為類别設定好了優先權和appender，那麼剩下的唯一要求就是指定布局了。布局被用來控制你日志statement的具體格式，例如日期、時間、子產品名稱，以及線程的ID。我不會講到所有可用的格式，因為你可以從Log4j的文檔裡獲得這些格式完整的摘要。
Log4j的配置可以用XML檔案或者Java屬性檔案來完成。我更喜歡利用Java屬性檔案這一技術，因為使用XML檔案實作這一目的的例子太多了。Listing A裡是一個用來配置Log4j的屬性檔案。
這個屬性檔案裡的第一個非注釋行指出，根類别具有調試的優先權，而且擁有三個appender，分别由A1、A2和A3來識别。剩下的部分指定了用于每個辨別符的appender。在這個屬性裡，appender是一個控制台(螢幕)、一個旋轉檔案(rotating file)，以及一個UDP廣播器。
UDP廣播器是我加到Log4j程式包裡的一個appender，這樣我可以用互動方式來觀察日志statement。每個appender都附加有一個布局對象。在本文裡，我們用到了PatternLayout，它後面接有轉化模式。這個轉化模式裡的字元被用來指定輸出。%這個符号用于指定格式字元。在這個例子裡，%-5p表示用5個字元取得優先權(p)的左對齊。然後是日期(%d)、線程資訊(%t)，以及消息(%m)，後面還接有行結束字元(%n)。
要在你的應用程式裡使用Log4j，你需要使用PropertyConfigurator來加載這個屬性檔案。在你啟動類裡加上下面這一行就能夠實作目的：
import org.apache.log4j.PropertyConfigurator;
….
PropertyConfigurator.configure("path/to/file.properties");
一旦配置被加載，那麼要求日志記錄能力的應用程式裡的每個類都需要參考類别對象。由于類别采用程式包命名的慣例，是以我常常将類的名稱用作類别(名稱)，即使這不是必需的，是否需要還取決于你如何安排配置。聲明一個用于類的靜态變量就會讓日志程式可供使用：
import org.apache.log4j.Category;
….
private static final Category log = Category.getInstance(MyClass.class.getName());
記錄事件
現在，在你的應用程式裡記錄日志就很容易了。你隻需要調用一個方法就行了，這個方法和你正在記錄的消息的優先權相對應。例如下面是一條調試消息：
log.debug("Log4j really works!");
如果你想要確定調試優先權是活動的，那麼你就要在進行調試調用之前檢查它。要注意，即使你發送消息，它也不會被記錄下來，除非優先權被正确地設定。檢查目前的優先權，隻是在嘗試日志操作之前避免耗資源操作的一種方法。下面是在日志陳述之前檢查優先權的一個例子。
if ( log.isDebugEnabled() ) {
log.debug("Another log statement.”);
}
你還可以給日志方法加上一個異常，這樣的話，異常的細節就會被記錄在日志消息裡。這個調用的格式如下：
log.warn("Oops caught an exception.", myException);
這應該就是你需要的一切
如果你目前的應用程式或者未來的發展需要一個強健的日志記錄工具，那麼試一下Log4j程式包。它提供了極大的靈活性，有了可配置的appender和優先權系統，你可以控制日志記錄，并為你産品的釋出調整它，而不需要消耗系統的大量資源。
[收藏]
[推薦]
[評論]
[列印]
[關閉]