目錄
- 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. 參考資料 (以及一些有參考價值的鏈接)
為了使用我們即將要安裝的日志記錄工具,還必須要設(shè)置操作環(huán)境,只有這樣,工具才能知道從哪里找到它所需要的信息,并且操作系統(tǒng)知道從哪里找到這個工具。那么,怎樣做呢?實際上,它要求更改操作環(huán)境。我有一些這方面的資格文檔。 Configuring A Windows Working Environment 和 Configuring A Unix Working Environment.
-
從 http://jakarta.apache.org/log4j/docs/download.html下載log4j發(fā)行版。
-
解壓存檔文件到合適的目錄中。
-
添加文件 dist/lib/log4j-1.2.6.jar 到 CLASSPATH 環(huán)境變量中。
日志記錄器(Logger)是日志處理的核心組件。log4j具有5種正常級別(Level)。 日志記錄器(Logger)的可用級別Level (不包括自定義級別 Level), 以下內(nèi)容就是摘自log4j API (http://jakarta.apache.org/log4j/docs/api/index.html):
-
static Level DEBUG
DEBUG Level指出細(xì)粒度信息事件對調(diào)試應(yīng)用程序是非常有幫助的。
-
static Level INFO
INFO level表明 消息在粗粒度級別上突出強調(diào)應(yīng)用程序的運行過程。
-
static Level WARN
WARN level表明會出現(xiàn)潛在錯誤的情形。
-
static Level ERROR
ERROR level指出雖然發(fā)生錯誤事件,但仍然不影響系統(tǒng)的繼續(xù)運行。
-
static Level FATAL
FATAL level指出每個嚴(yán)重的錯誤事件將會導(dǎo)致應(yīng)用程序的退出。
另外,還有兩個可用的特別的日志記錄級別: (以下描述來自log4j API http://jakarta.apache.org/log4j/docs/api/index.html):
-
static Level ALL
ALL Level是最低等級的,用于打開所有日志記錄。
-
static Level OFF
OFF Level是最高等級的,用于關(guān)閉所有日志記錄。
日志記錄器(Logger)的行為是分等級的。如下表所示:
有很多方法可以創(chuàng)建一個日志記錄器(Logger),下面方法可以取回root日志記錄器:
Logger logger = Logger.getRootLogger(); |
Logger logger = Logger.getLogger("MyLogger"); |
比較常用的用法,就是根據(jù)類名實例化一個靜態(tài)的全局日志記錄器:
static Logger logger = Logger.getLogger(test.class); |
所有這些創(chuàng)建的叫"logger"的日志記錄器都可以用下面方法設(shè)置級別:
logger.setLevel((Level)Level.WARN); |
Appender 控制日志怎樣輸出。下面列出一些可用的Appender(log4j API中所描述的 http://jakarta.apache.org/log4j/docs/api/index.html):
-
ConsoleAppender:使用用戶指定的布局(layout) 輸出日志事件到System.out或者 System.err。默認(rèn)的目標(biāo)是System.out。
-
DailyRollingFileAppender 擴展FileAppender,因此多個日志文件可以以一個用戶選定的頻率進行循環(huán)日志記錄。
-
FileAppender 把日志事件寫入一個文件
-
RollingFileAppender 擴展FileAppender備份容量達到一定大小的日志文件。
-
WriterAppender根據(jù)用戶的選擇把日志事件寫入到Writer或者OutputStream。
-
SMTPAppender 當(dāng)特定的日志事件發(fā)生時,一般是指發(fā)生錯誤或者重大錯誤時,發(fā)送一封郵件。
-
SocketAppender 給遠程日志服務(wù)器(通常是網(wǎng)絡(luò)套接字節(jié)點)發(fā)送日志事件(LoggingEvent)對象。
-
SocketHubAppender 給遠程日志服務(wù)器群組(通常是網(wǎng)絡(luò)套接字節(jié)點)發(fā)送日志事件(LoggingEvent)對象。
-
SyslogAppender給遠程異步日志記錄的后臺精靈程序(daemon)發(fā)送消息。
-
TelnetAppender 一個專用于向只讀網(wǎng)絡(luò)套接字發(fā)送消息的log4j appender。
還可以實現(xiàn) Appender 接口,創(chuàng)建以自己的方式進行日志輸出的Appender。
ConsoleAppender可以用這種方式創(chuàng)建:
ConsoleAppender appender = new ConsoleAppender(new PatternLayout()); |
創(chuàng)建了一個控制臺appender,具有一個默認(rèn)的PatternLayout。它使用了默認(rèn)的System.out 輸出。
FileAppender可以用這種方式創(chuàng)建:
FileAppender appender = null; |
FileAppender(Layout layout, String filename) |
FileAppender(Layout layout, String filename, boolean append) |
這個構(gòu)造函數(shù)還可以選擇是否對指定的文件進行追加的方式輸出。如果沒有指定值,那么默認(rèn)的方式就是追加。
WriterAppender可以用這種方式創(chuàng)建:
WriterAppender appender = null; |
這里是一個非常簡單的例子,程序?qū)崿F(xiàn)了SimpleLayout和FileAppender:
import org.apache.log4j.Level; |
你可以下載: simpandfile.java。 還可以查看它的輸出: output1.txt.
這里是一個非常簡單的例子,程序?qū)崿F(xiàn)了 HTMLLayout和WriterAppender:
import java.io.*; |
你可以下載: simpandfile.java. 還可以查看它的輸出:output1.txt.
這里是一個非常簡單的例子,程序?qū)崿F(xiàn)了PatternLayout和ConsoleAppender:
import org.apache.log4j.Level; |
你可以下載:simpandfile.java. 還可以查看它的輸出: output2.txt.
<?xml version="1.0" encoding="UTF-8" ?> |
<appender name="ConsoleAppender" class="org.apache.log4j.ConsoleAppender"> |
<root> |
DOMConfigurator.configure("configurationfile.xml"); |
DOMConfigurator 用一棵DOM樹來初始化log4j環(huán)境。這里是示例中的XML配置文件:plainlog4jconfig.xml。這里是執(zhí)行該配置文件的程序: files/externalxmltest.java:
import org.apache.log4j.Logger; |
這里是一個實現(xiàn)帶有PatternLayout的FileAppender的日志記錄器Logger的XML配置文件:
<?xml version="1.0" encoding="UTF-8" ?> |
你可以從這里下載示例: xmllog4jconfig2.xml。 想要得到更多的使用XML文件配置log4j環(huán)境的例子,請查看log4j發(fā)行版的目錄src/java/org/apache/log4j/xml/examples/ 。
這就是上面討論的文本文件形式的配置文件:
# initialise root logger with level DEBUG and call it BLAH |
從這里可以下載: plainlog4jconfig.txt。這就是執(zhí)行該配置文件的程序:
import org.apache.log4j.Logger; |
你可以下載使用該配置文件的示例: externalplaintest.java。想要獲得更多的使用文本文件配置log4j環(huán)境的例子,請查看log4j發(fā)行版中的目錄examples。
使用外部配置文件的例子就簡單的討論到這里,現(xiàn)在應(yīng)該可以肯定你已經(jīng)有能力獨立學(xué)習(xí)更多的log4j發(fā)行版和測試版中提供的例子。
-
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應(yīng)用程序添加日志記錄 - Kevin Brown