自定義日志 Handler

所有的 Handler 類都是繼承自 java.util.logging.Handler 抽象類，該類結構圖 如圖  所示。

圖- Handler 類圖

由該類圖可見，Handler 抽象類提供了抽象接口：publish， flush 和 close .這些接口提供了日志輸出的基本功能。同時 Handler 類保存了 Formatter，Filter 和 Level 對象用來控制日志輸出。因此，編寫自定義的Handler 類需要如下步驟：

1、繼承 Handler 抽象類

2、實現 publish，flush 和 close 方法。其中publish 方法是用于發布一條日志記錄。 flush 方法是清空內存緩沖區。 close 方法是當應用程序關閉的時候，釋放該 Handler 類所申請的資源（如文件，socket 等）

3、設置默認的 Formatter，Filter 和 Level 對象。必要的時候，可以在類的初始化時候讀取配置文件來設置這些參數。

一個典型的自定義 Handler 類實現如清單 1 所示。

清單 1 自定義 Handler 類

public class MyHandler extends Handler {   
private bOOlean doneHeader = false;   
 
public MyHandler() {   
setLevel(Level.INFO);   
setFilter(null);   
setFormatter(new SimpleFormatter());   
}   
 
_cnnew1@Override   
public void close() throws SecurityException {   
if (!doneHeader) {   
output(getFormatter().getHead(this));   
doneHeader = true;   
}   
output(getFormatter().getTail(this));   
flush();   
}   
 
@Override   
public void flush() {   
// 清空緩沖區  
}   
 
@Override   
public void publish(LogRecord record) {   
if (!isLoggable(record)) {   
return;   
}   
String msg = getFormatter().format(record);   
 
try {   
if (!doneHeader ) {   
output(getFormatter().getHead(this));   
doneHeader = true;   
}   
output(msg);   
} catch (Exception ex) {   
reportError(null, ex, ErrorManager.WRITE_FAILURE);   
}   
}   
 
private void output(String message) {   
// 實現日志輸出  
}   
}  

這里 reportError 方法是將日志類中的錯誤信息輸出到外界，這個是由 ErrorManager 類實現的，ErrorManager 類負責記錄日志框架中Handler 的錯誤，一般情況下是將該錯誤打印到控制臺中。具體的每條日志消息被JDK日志框架封裝成 LogRecord 對象，該類部分定義如 清單 2 所示。

清單 2 LogRecord 類定義

public class LogRecord implements java.io.Serializable {   
public String getLoggerName();   
public void setLoggerName(String name);   
public ResourceBundle getResourceBundle();   
public void setResourceBundle(ResourceBundle bundle);   
public Level getLevel();   
public void setLevel(Level level);   
public String getMessage();   
public void setMessage(String message);   
public Object[] getParameters();   
public void setParameters(Object parameters[]);   
public int getThreadID();   
public void setThreadID(int threadID);   
public long getMillis();   
public void setMillis(long millis);   
public Throwable getThrown();   
public void setThrown(Throwable thrown);   
...   
}  

由清單 2 可見，LogRecord 類包含了一個日志消息的級別、消息文本、時間、參數、線程等等所有的信息，這些都交給 Handler，Formatter 和 Filter 這些對象來處理。同時該類也是可序列化的，可以序列化到網絡和文件中。該類還可以和一個 ResourceBundle 對象綁定，實現消息字符串的本地化處理。

本文描述了一個典型的自定義的Handler 類的實現。那么現在你對JDK日志框架之自定義日志Handler是不是更加有感覺了呢？

【編輯推薦】

1. Java虛擬機內部構成淺析
2. Java中兩個特殊變量this和super 的使用
3. 3.6.3 this關鍵字和構造方法的調用
4. 5.7.8 null和this關鍵字
5. Java學習筆記－JSF