log4j教程

y_keven發表於2013-10-29
log4j教程
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. 參考資料 (以及一些有參考價值的連結)

使用log4j大概涉及3個主要概念:

日誌記錄器(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），下面方法可以取回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.

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

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

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

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

  4. RollingFileAppender 擴充套件FileAppender備份容量達到一定大小的日誌檔案。

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

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

  7. SocketAppender 給遠端日誌伺服器（通常是網路套接位元組點）傳送日誌事件（LoggingEvent）物件。

  8. SocketHubAppender 給遠端日誌伺服器群組（通常是網路套接位元組點）傳送日誌事件（LoggingEvent）物件。

  9. SyslogAppender給遠端非同步日誌記錄的後臺精靈程式(daemon)傳送訊息。

  10. TelnetAppender 一個專用於向只讀網路套接字傳送訊息的log4j appender。

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

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"指定的檔案。

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

這裡是一個非常簡單的例子，程式實現了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.

這裡是一個非常簡單的例子，程式實現了 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.

這裡是一個非常簡單的例子，程式實現了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.

Log4j經常與外部日誌檔案聯合使用，這樣很多可選項不必硬編碼在軟體中。使用外部配置檔案的優點就是修改可選項不需要重新編譯程式。唯一的缺點就是，由於用到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 BLAHlog4j.rootLogger=DEBUG,
BLAH# add a ConsoleAppender to the logger BLAHlog4j.appender.BLAH=
org.apache.log4j.ConsoleAppender# set set that layout to be SimpleLayoutlog4j.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發行版和測試版中提供的例子。

 

文章轉自：http://www.blogjava.net/hellxoul/archive/2011/11/30/365181.html

相關文章