- 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. 參考資料 (以及一些有參考價值的鏈接)
爲了使用我們即將要安裝的日誌記錄工具,還必須要設置操作環境,只有這樣,工具才能知道從哪裏找到它所需要的信息,並且操作系統知道從哪裏找到這個工具。那麼,怎樣做呢?實際上,它要求更改操作環境。
-
從 http://jakarta.apache.org/log4j/docs/download.html下載log4j發行版。
-
解壓存檔文件到合適的目錄中。
-
添加文件 dist/lib/log4j-1.2.6.jar 到 CLASSPATH 環境變量中。
日誌記錄器(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); |
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。
ConsoleAppender appender = new ConsoleAppender(new PatternLayout()); |
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"指定的文件。 |
WriterAppender appender = null; try { appender = new WriterAppender(new PatternLayout(),new FileOutputStream("filename")); } catch(Exception e) {} |
這裏是一個非常簡單的例子,程序實現了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> |
<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環境。這裏是示例中的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
demo下載鏈接: