Java Log4J 使用教程(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)是日誌處理的核心組件。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 給遠程日誌服務器（一般是網絡套接字節點）發送日誌事件（LoggingEvent）對象。

SocketHubAppender 給遠程日誌服務器羣組（一般是網絡套接字節點）發送日誌事件（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應用程序添加日誌記錄 - Kevin Brown