程序師世界是廣大編程愛好者互助、分享、學習的平台,程序師世界有你更精彩!
首頁
編程語言
C語言|JAVA編程
Python編程
網頁編程
ASP編程|PHP編程
JSP編程
數據庫知識
MYSQL數據庫|SqlServer數據庫
Oracle數據庫|DB2數據庫
 程式師世界 >> 編程語言 >> JAVA編程 >> 關於JAVA >> 給你的Java應用程序加上日志功能

給你的Java應用程序加上日志功能

編輯:關於JAVA

每個應用程序都需要某種方式同外部世界進行通信並收集數據。這可以利用數據庫通過接口來實現,也可以用文本文件來完成。在面對這麼多選擇的時候,使用普通文本文件來收集和調試數據似乎已經被遺忘了。盡管文本文件無法像最新、最酷的技術那樣帶給你快感,但是它們(確實)是收集數據和診斷應用程序故障的有效手段。

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和優先權系統,你可以控制日志記錄,並為你產品的發布調整它,而不需要消耗系統的大量資源。

  1. 上一頁:
  2. 下一頁:
Copyright © 程式師世界 All Rights Reserved