Java Logger (java日誌)

標籤：

目錄

1. 簡介
2. 安裝
3. log4j基本概念
3.1. Logger
3.2. Appender
3.2.1. 使用ConsoleAppender
3.2.2. 使用FileAppender
3.2.3. 使用WriterAppender
3.3. Layout
3.4. 基本樣本
3.4.1. SimpleLayout和FileAppender
3.4.2. HTMLLayout和WriterAppender
3.4.3. PatternLayout和ConsoleAppender
4. 使用外部設定檔
5. 參考資料 (以及一些有參考價值的連結)
1.簡介
程式開發環境中的日誌記錄是由嵌入在程式中以輸出一些對開發人員有用資訊的語句所組成。例如，跟蹤語句（trace），結構轉儲和常見的System.out.println或printf調試語句。log4j提供分級方法在程式中嵌入日誌記錄語句。日誌資訊具有多種輸出格式和多個輸出層級。

使用一個專門的日誌記錄包，可以減輕對成千上萬的System.out.println語句的維護成本，因為日誌記錄可以通過配置指令碼在運行時得以控制。log4j維護嵌入在程式碼中的日誌記錄語句。通過規範日誌記錄的處理過程，一些人認為應該鼓勵更多的使用日誌記錄並且獲得更高程度的效率。

2.安裝
為了使用我們即將要安裝的日誌記錄工具，還必須要設定作業環境，只有這樣，工具才能知道從哪裡找到它所需要的資訊，並且作業系統知道從哪裡找到這個工具。那麼，怎樣做呢？實際上，它要求更改作業環境。我有一些這方面的資格文檔。 Configuring A Windows Working Environment 和 Configuring A Unix Working Environment.

從 http://jakarta.apache.org/log4j/docs/download.html下載log4j發行版。

解壓封存檔案到合適的目錄中。

添加檔案 dist/lib/log4j-1.2.6.jar 到 CLASSPATH 環境變數中。

3.log4j的基本概念
使用log4j大概涉及3個主要概念:

公用類 Logger

Logger 負責處理日誌記錄的大部分操作。

公用介面 Appender

Appender 負責控制日誌記錄操作的輸出。

公用抽象類別Layout

Layout 負責格式化Appender的輸出。

3.1.Logger
日誌記錄器(Logger)是Tlog的核心組件。log4j具有5種正常層級(Level)。日誌記錄器(Logger)的可用層級Level (不包括自訂層級 Level)， 以下內容就是摘自log4j API (http://jakarta.apache.org/log4j/docs/api/index.html):

static Level DEBUG

DEBUG Level指出細粒度資訊事件對調試應用程式是非常有協助的。

static Level INFO

INFO level表明 訊息在粗粒度層級上突出強調應用程式的運行過程。

static Level WARN

WARN level表明會出現潛在錯誤的情形。

static Level ERROR

ERROR level指出雖然發生錯誤事件，但仍然不影響系統的繼續運行。

static Level FATAL

FATAL level指出每個嚴重的錯誤事件將會導致應用程式的退出。

另外，還有兩個可用的特別的日誌記錄層級: (以下描述來自log4j APIhttp://jakarta.apache.org/log4j/docs/api/index.html):

static Level ALL

ALL Level是最低等級的，用於開啟所有日誌記錄。

static Level OFF

OFF Level是最高等級的，用於關閉所有日誌記錄。

日誌記錄器（Logger）的行為是分等級的。如下表所示：

圖.日誌輸出等級


日誌記錄器（Logger）將只輸出那些層級高於或等於它的層級的資訊。如果沒有設定日誌記錄器（Logger）的層級，那麼它將會繼承最近的祖先的層級。因此，如果在包com.foo.bar中建立一個日誌記錄器（Logger）並且沒有順位，那它將會繼承在包com.foo中建立的日誌記錄器（Logger）的層級。如果在com.foo中沒有建立日誌記錄器（Logger）的話,那麼在com.foo.bar中建立的日誌記錄器（Logger）將繼承root 日誌記錄器（Logger）的層級，root日誌記錄器（Logger）經常被執行個體化而可用，它的層級為DEBUG。

有很多方法可以建立一個日誌記錄器（Logger），下面方法可以取回root日誌記錄器:

Logger logger = Logger.getRootLogger();


還可以這樣建立一個新的日誌記錄器:

Logger logger = Logger.getLogger("MyLogger");


比較常用的用法，就是根據類名執行個體化一個靜態全域日誌記錄器:

static Logger logger = Logger.getLogger(test.class);


所有這些建立的叫"logger"的日誌記錄器都可以用下面方法順位:

logger.setLevel((Level)Level.WARN);


可以使用7個層級中的任何一個; Level.DEBUG, Level.INFO, Level.WARN, Level.ERROR, Level.FATAL, Level.ALL and Level.OFF.

3.2.Appender
Appender 控制日誌怎樣輸出。下面列出一些可用的Appender(log4j API中所描述的http://jakarta.apache.org/log4j/docs/api/index.html):

ConsoleAppender:使用使用者指定的布局(layout) 輸出日誌事件到System.out或者 System.err。預設的目標是System.out。

DailyRollingFileAppender 擴充FileAppender，因此多個記錄檔可以以一個使用者選定的頻率進行迴圈日誌記錄。

FileAppender 把日誌事件寫入一個檔案

RollingFileAppender 擴充FileAppender備份容量達到一定大小的記錄檔。

WriterAppender根據使用者的選擇把日誌事件寫入到Writer或者OutputStream。

SMTPAppender 當特定的日誌事件發生時，一般是指發生錯誤或者重大錯誤時，發送一封郵件。

SocketAppender 給遠程Log Service器（通常是網路通訊端節點）發送日誌事件（LoggingEvent）對象。

SocketHubAppender 給遠程Log Service器群組（通常是網路通訊端節點）發送日誌事件（LoggingEvent）對象。

SyslogAppender給遠程非同步日誌記錄的後台精靈程式(daemon)發送訊息。

TelnetAppender 一個專用於向唯讀網路通訊端發送訊息的log4j appender。

還可以實現 Appender 介面，建立以自己的方式進行日誌輸出的Appender。

3.2.1.使用ConsoleAppender
ConsoleAppender可以用這種方式建立：

ConsoleAppender appender = new ConsoleAppender(new PatternLayout());


建立了一個控制台appender，具有一個預設的PatternLayout。它使用了預設的System.out 輸出。

3.2.2.使用FileAppender
FileAppender可以用這種方式建立:

FileAppender appender = null;

try {

appender = new FileAppender(new PatternLayout(),"filename");

} catch(Exception e) {}




上面用到的建構函式:

FileAppender(Layout layout, String filename)

執行個體化一個FileAppender並且開啟變數"filename"指定的檔案。




另一個有用的建構函式是：

FileAppender(Layout layout, String filename, boolean append)

執行個體化一個FileAppender並且開啟變數"filename"指定的檔案。




這個建構函式還可以選擇是否對指定的檔案進行追加的方式輸出。如果沒有指定值，那麼預設的方式就是追加。

3.2.3.使用WriterAppender
WriterAppender可以用這種方式建立:

WriterAppender appender = null;

try {

appender = new WriterAppender(new PatternLayout(),new FileOutputStream("filename"));

} catch(Exception e) {}




這個WriterAppender使用的建構函式帶有PatternLayout和OutputStream參數，在這種情況下， FileOutputStream用於向一個檔案輸出。當然，它還具有其他可用的建構函式。

3.3.Layout
Appender必須使用一個與之相關聯的 Layout，這樣它才能知道怎樣格式化它的輸出。當前，log4j具有三種類型的Layout:

HTMLLayout 格式化日誌輸出為HTML表格。

PatternLayout 根據指定的 轉換模式格式化日誌輸出，或者如果沒有指定任何轉換模式，就使用預設的轉換模式。

SimpleLayout 以一種非常簡單的方式格式化日誌輸出，它列印層級 Level，然後跟著一個破折號“-“ ，最後才是日誌訊息。

3.4.基本樣本
3.4.1.SimpleLayout和 FileAppender
這裡是一個非常簡單的例子，程式實現了SimpleLayout和FileAppender:

import org.apache.log4j.Level;

import org.apache.log4j.Logger;

import org.apache.log4j.SimpleLayout;

import org.apache.log4j.FileAppender;

public class simpandfile {

static Logger logger = Logger.getLogger(simpandfile.class);

public static void main(String args[]) {

SimpleLayout layout = new SimpleLayout();

FileAppender appender = null;

try {

appender = new FileAppender(layout,"output1.txt",false);

} catch(Exception e) {}

logger.addAppender(appender);

logger.setLevel((Level) Level.DEBUG);

logger.debug("Here is some DEBUG");

logger.info("Here is some INFO");

logger.warn("Here is some WARN");

logger.error("Here is some ERROR");

logger.fatal("Here is some FATAL");

}

}




你可以下載: simpandfile.java。 還可以查看它的輸出： output1.txt.

3.4.2.HTMLLayout和 WriterAppender
這裡是一個非常簡單的例子，程式實現了 HTMLLayout和WriterAppender:

import java.io.*;

import org.apache.log4j.Level;

import org.apache.log4j.Logger;

import org.apache.log4j.HTMLLayout;

import org.apache.log4j.WriterAppender;

public class htmlandwrite {

static Logger logger = Logger.getLogger(htmlandwrite.class);

public static void main(String args[]) {

HTMLLayout layout = new HTMLLayout();

WriterAppender appender = null;

try {

FileOutputStream output = new FileOutputStream("output2.html");

appender = new WriterAppender(layout,output);

} catch(Exception e) {}

logger.addAppender(appender);

logger.setLevel((Level) Level.DEBUG);

logger.debug("Here is some DEBUG");

logger.info("Here is some INFO");

logger.warn("Here is some WARN");

logger.error("Here is some ERROR");

logger.fatal("Here is some FATAL");

}

}




你可以下載: simpandfile.java. 還可以查看它的輸出：output1.txt.

3.4.3.PatternLayout和 ConsoleAppender
這裡是一個非常簡單的例子，程式實現了PatternLayout和ConsoleAppender:

import org.apache.log4j.Level;

import org.apache.log4j.Logger;

import org.apache.log4j.PatternLayout;

import org.apache.log4j.ConsoleAppender;

public class consandpatt {

static Logger logger = Logger.getLogger(consandpatt.class);

public static void main(String args[]) {

// Note, %n is newline

String pattern = "Milliseconds since program start: %r %n";

pattern += "Classname of caller: %C %n";

pattern += "Date in ISO8601 format: %d{ISO8601} %n";

pattern += "Location of log event: %l %n";

pattern += "Message: %m %n %n";



PatternLayout layout = new PatternLayout(pattern);

ConsoleAppender appender = new ConsoleAppender(layout);

logger.addAppender(appender);

logger.setLevel((Level) Level.DEBUG);

logger.debug("Here is some DEBUG");

logger.info("Here is some INFO");

logger.warn("Here is some WARN");

logger.error("Here is some ERROR");

logger.fatal("Here is some FATAL");

}

}




你可以下載:simpandfile.java. 還可以查看它的輸出： output2.txt.

4.使用外部設定檔
經常與外部記錄檔聯合使用，這樣很多可選項不必寫入程式碼在軟體中。使用外部設定檔的優點就是修改可選項不需要重新編譯器。唯一的缺點就是，由於用到io 指令，速度稍微有些減慢。

有兩個方法可以用來指定外部設定檔：文字檔或者XML檔案。既然現在所有事情都寫成XML檔案，那麼該教程就重點講解XML檔案方法，但是也包含相關文字檔的例子。首先，看看下面的XML設定檔樣本：

<?xml version="1.0" encoding="UTF-8" ?>

<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">

<log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/">



<appender name="ConsoleAppender" class="org.apache.log4j.ConsoleAppender">

<layout class="org.apache.log4j.SimpleLayout"/>

</appender>

<root>

<priority value ="debug" />

<appender-ref ref="ConsoleAppender"/>

</root>

</log4j:configuration>




檔案以標準的XML聲明作為開始，後面跟著指出DTD（文件類型定義）的DOCTYPE聲明，它定義了XML檔案的結構，例如，什麼元素可以嵌入在其他元素中等等。上面檔案在log4j發行版的src/java/org/apache/log4j/xml目錄中。接著看看封裝所有元素的 log4j:configuration 元素，它在DOCTYPE聲明中被指定為根項目。嵌入在根項目中有兩個結構：

<appender name="ConsoleAppender" class="org.apache.log4j.ConsoleAppender">

<layout class="org.apache.log4j.SimpleLayout"/>

</appender>




這裡建立一個名叫"ConsoleAppender"的 Appender，注意，你可以選擇任何名字，該樣本之所以選擇"ConsoleAppender"，完全是為了樣本的設計。接著這個appender類以全名形式給出，經常用規範（fully qualified）類名。 Appender必須具有一個指定的 name和class。嵌入在 Appender之內的是 layout元素，這裡它被指定為SimpleLayout。 Layout 必須具有一個 class屬性。

<root>

<priority value ="debug" />

<appender-ref ref="ConsoleAppender"/>

</root>




root元素必須存在且不能被子類化。樣本中的優先順序被設定為"debug"，設定appender飽含一個appender-ref元素。還有更多的屬性或元素可以指定。查看log4j發行版中的src/java/org/apache/log4j/xml/log4j.dtd以瞭解關於XML設定檔結構的更多資訊。可以用下面這種方法把配置資訊檔讀入到Java程式中:

DOMConfigurator.configure("configurationfile.xml");




DOMConfigurator 用一棵DOM樹來初始化log4j環境。這裡是樣本中的XML設定檔：plainlog4jconfig.xml。這裡是執行該設定檔的程式: files/externalxmltest.java:

import org.apache.log4j.Logger;

import org.apache.log4j.xml.DOMConfigurator;

public class externalxmltest {

static Logger logger = Logger.getLogger(filetest.class);

public static void main(String args[]) {

DOMConfigurator.configure("xmllog4jconfig.xml");

logger.debug("Here is some DEBUG");

logger.info("Here is some INFO");

logger.warn("Here is some WARN");

logger.error("Here is some ERROR");

logger.fatal("Here is some FATAL");

}

}




這裡是一個實現帶有PatternLayout的FileAppender的日誌記錄器Logger的XML設定檔:

<?xml version="1.0" encoding="UTF-8" ?>

<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">

<log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/">



<appender name="appender" class="org.apache.log4j.FileAppender">

<param name="File" value="Indentify-Log.txt"/>

<param name="Append" value="false"/>

<layout class="org.apache.log4j.PatternLayout">

<param name="ConversionPattern" value="%d [%t] %p - %m%n"/>

</layout>

</appender>

<root>

<priority value ="debug"/>

<appender-ref ref="appender"/>

</root>

</log4j:configuration>




你可以從這裡下載樣本: xmllog4jconfig2.xml。想要得到更多的使用XML檔案配置log4j環境的例子，請查看log4j發行版的目錄src/java/org/apache/log4j/xml/examples/ 。

這就是上面討論的文字檔形式的設定檔:

# initialise root logger with level DEBUG and call it BLAH

log4j.rootLogger=DEBUG, BLAH

# add a ConsoleAppender to the logger BLAH

log4j.appender.BLAH=org.apache.log4j.ConsoleAppender

# set set that layout to be SimpleLayout

log4j.appender.BLAH.layout=org.apache.log4j.SimpleLayout




從這裡可以下載: plainlog4jconfig.txt。這就是執行該設定檔的程式:

import org.apache.log4j.Logger;

import org.apache.log4j.PropertyConfigurator;

public class externalplaintest {

static Logger logger = Logger.getLogger(externalplaintest.class);

public static void main(String args[]) {

PropertyConfigurator.configure("plainlog4jconfig.xml");

logger.debug("Here is some DEBUG");

logger.info("Here is some INFO");

logger.warn("Here is some WARN");

logger.error("Here is some ERROR");

logger.fatal("Here is some FATAL");

}

}




你可以下載使用該設定檔的樣本： externalplaintest.java。想要獲得更多的使用文字檔配置log4j環境的例子，請查看log4j發行版中的目錄examples。

使用外部設定檔的例子就簡單的討論到這裡，現在應該可以肯定你已經有能力獨立學習更多的log4j發行版和測試版中提供的例子。

5.參考資料 (以及一些有參考價值的連結)
http://jakarta.apache.org/log4j/docs/manual.html

log4j的簡明介紹 - Ceki G- 2002年3月

http://www.vipan.com/htdocs/log4jhelp.html

不要用System.out.println！用Log4j - Vipan Singla

http://www.opensymphony.com/guidelines/logging.jsp

LOG4J / OpenSymphony日誌記錄入門

http://builder.com.com/article.jhtml?id=u00820020124kev01.htm

Java Logger (java日誌)