- 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. 參考資料 (以及一些有參考價(jià)值的鏈接)
從 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表明 消息在粗粒度級別上突出強(qiáng)調(diào)應(yīng)用程序的運(yùn)行過程。
static Level WARN
WARN level表明會(huì)出現(xiàn)潛在錯(cuò)誤的情形。
static Level ERROR
ERROR level指出雖然發(fā)生錯(cuò)誤事件,但仍然不影響系統(tǒng)的繼續(xù)運(yùn)行。
static Level FATAL
FATAL level指出每個(gè)嚴(yán)重的錯(cuò)誤事件將會(huì)導(dǎo)致應(yīng)用程序的退出。
另外,還有兩個(gè)可用的特別的日志記錄級別: (以下描述來自log4j APIhttp://jakarta.apache.org/log4j/docs/api/index.html):
static Level ALL
ALL Level是最低等級的,用于打開所有日志記錄。
static Level OFF
OFF Level是最高等級的,用于關(guān)閉所有日志記錄。
日志記錄器(Logger)的行為是分等級的。
有很多方法可以創(chuàng)建一個(gè)日志記錄器(Logger),下面方法可以取回root日志記錄器:
Logger logger = Logger.getRootLogger(); |
Logger logger = Logger.getLogger("MyLogger"); |
比較常用的用法,就是根據(jù)類名實(shí)例化一個(gè)靜態(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 擴(kuò)展FileAppender,因此多個(gè)日志文件可以以一個(gè)用戶選定的頻率進(jìn)行循環(huán)日志記錄。
FileAppender 把日志事件寫入一個(gè)文件
RollingFileAppender 擴(kuò)展FileAppender備份容量達(dá)到一定大小的日志文件。
WriterAppender根據(jù)用戶的選擇把日志事件寫入到Writer或者OutputStream。
SMTPAppender 當(dāng)特定的日志事件發(fā)生時(shí),一般是指發(fā)生錯(cuò)誤或者重大錯(cuò)誤時(shí),發(fā)送一封郵件。
SocketAppender 給遠(yuǎn)程日志服務(wù)器(通常是網(wǎng)絡(luò)套接字節(jié)點(diǎn))發(fā)送日志事件(LoggingEvent)對象。
SocketHubAppender 給遠(yuǎn)程日志服務(wù)器群組(通常是網(wǎng)絡(luò)套接字節(jié)點(diǎn))發(fā)送日志事件(LoggingEvent)對象。
SyslogAppender給遠(yuǎn)程異步日志記錄的后臺(tái)精靈程序(daemon)發(fā)送消息。
TelnetAppender 一個(gè)專用于向只讀網(wǎng)絡(luò)套接字發(fā)送消息的log4j appender。
還可以實(shí)現(xiàn) Appender 接口,創(chuàng)建以自己的方式進(jìn)行日志輸出的Appender。
ConsoleAppender可以用這種方式創(chuàng)建:
ConsoleAppender appender = new ConsoleAppender(new PatternLayout()); |
創(chuàng)建了一個(gè)控制臺(tái)appender,具有一個(gè)默認(rèn)的PatternLayout。它使用了默認(rèn)的System.out 輸出。
FileAppender可以用這種方式創(chuàng)建:
FileAppender appender = null; try { appender = new FileAppender(new PatternLayout(),"filename"); } catch(Exception e) {} |
FileAppender(Layout layout, String filename) 實(shí)例化一個(gè)FileAppender并且打開變量"filename"指定的文件。 |
FileAppender(Layout layout, String filename, boolean append) 實(shí)例化一個(gè)FileAppender并且打開變量"filename"指定的文件。 |
這個(gè)構(gòu)造函數(shù)還可以選擇是否對指定的文件進(jìn)行追加的方式輸出。如果沒有指定值,那么默認(rèn)的方式就是追加。
WriterAppender可以用這種方式創(chuàng)建:
WriterAppender appender = null; try { appender = new WriterAppender(new PatternLayout(),new FileOutputStream("filename")); } catch(Exception e) {} |
這里是一個(gè)非常簡單的例子,程序?qū)崿F(xiàn)了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.
這里是一個(gè)非常簡單的例子,程序?qū)崿F(xiàn)了 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.
這里是一個(gè)非常簡單的例子,程序?qū)崿F(xiàn)了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.
<?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> |
<appender name="ConsoleAppender" class="org.apache.log4j.ConsoleAppender"> <layout class="org.apache.log4j.SimpleLayout"/> </appender> |
<root> <priority value ="debug" /> <appender-ref ref="ConsoleAppender"/> </root> |
DOMConfigurator.configure("configurationfile.xml"); |
DOMConfigurator 用一棵DOM樹來初始化log4j環(huán)境。這里是示例中的XML配置文件:plainlog4jconfig.xml。這里是執(zhí)行該配置文件的程序: 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"); } } |
這里是一個(gè)實(shí)現(xiàn)帶有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環(huán)境的例子,請查看log4j發(fā)行版的目錄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。這就是執(zhí)行該配置文件的程序:
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環(huán)境的例子,請查看log4j發(fā)行版中的目錄examples。
使用外部配置文件的例子就簡單的討論到這里,現(xiàn)在應(yīng)該可以肯定你已經(jīng)有能力獨(dú)立學(xué)習(xí)更多的log4j發(fā)行版和測試版中提供的例子。