log4j教程(轉)

時間  2021-01-02
標籤 html java apache api 服務器 網絡 app 異步 函數 工具 欄目 Log4j 简体版
原文   原文鏈接

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

日誌記錄器(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發行版和測試版中提供的例子。

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程