Log4j入門

蘇玉召 2009-9-18

一、概述

日志記錄通常有三個目的：監視代碼中變量的變化情況，周期性的記錄到文件中供其他應用進行統計和分析；跟蹤代碼運行軌跡，作為日后審計的依據；擔當集成開發環境中的調試器的作用，向文件或控制臺打印代碼的調試信息。

二、Log4j簡介

Log4j是Apache的一個開放源代碼項目，通過使用Log4j，我們可以控制日志信息輸送的目的地是控制臺、文件、GUI組件、甚至是套接口服務器、NT的事件記錄器、UNIX Syslog守護進程等；我們也可以控制每一條日志的輸出格式；通過定義每一條日志信息的級別，我們能夠更加細致地控制日志的生成過程。可以通過一個配置文件來進行配置，而不需要修改應用程序的代碼。

此外，通過Log4j其他語言接口，您可以在C、C++、.Net、PL/SQL程序中使用Log4j，其語法和用法與在Java程序中一樣，使得多語言分布式系統得到一個統一一致的日志組件模塊。通過使用各種第三方擴展，可以很方便地將Log4j集成到J2EE、JINI甚至是SNMP應用中。

三、Log4j組成

Log4j由三個重要的組件構成：Logger、Appender和Layout，Log4j 允許開發人員定義多個Logger，每個Logger擁有自己的名字，Logger之間通過名字來表明隸屬關系。有一個? Logger稱為Root，它永遠存在，且不能通過名字檢索或引用，可以通過Logger.getRootLogger（）方法獲得，其它Logger通過 Logger.getLogger（String name）方法。

Appender則是用來指明將所有的log信息存放到什么地方，Log4j中支持多種appender，如 console、files、GUI components、NT Event Loggers等，一個Logger可以擁有多個Appender，也就是你既可以將Log信息輸出到屏幕，同時存儲到一個文件中。

Layout的作用是控制Log信息的輸出方式，也就是格式化輸出的信息。

四、配置文件

Log4j支持兩種配置文件格式，一種是XML格式的文件，一種是Java特性文件（鍵=值）。下面介紹使用Java特性文件配置文件的方法：

配置根Logger，語法為： log4j.rootLogger = [ level ] , appenderName, appenderName, …其中，level 是日志記錄的優先級，分為OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者您定義的級別。Log4j建議只使用四個級別，優先級從高到低分別是ERROR、WARN、INFO、DEBUG。通過在這里定義的級別，您可以控制到應用程序中相應級別的日志信息的開關。比如在這里定義了INFO級別，則應用程序中所有DEBUG級別的日志信息將不被打印出來。appenderName就是指定日志信息輸出到哪個地方。您可以同時指定多個輸出目的地。

配置日志信息輸出目的地Appender，其語法為：log4j.appender.appenderName = fully.qualified.name.of.appender.class

log4j.appender.appenderName.option1 = value1

…

log4j.appender.appenderName.option = valueN

其中，Log4j提供的appender有以下幾種：org.apache.log4j.ConsoleAppender（控制臺），org.apache.log4j.FileAppender（文件），org.apache.log4j.DailyRollingFileAppender（每天產生一個日志文件），org.apache.log4j.RollingFileAppender（文件大小到達指定尺寸的時候產生一個新的文件），org.apache.log4j.WriterAppender（將日志信息以流格式發送到任意指定的地方）。

配置日志信息的格式（布局），其語法為：

log4j.appender.appenderName.layout = fully.qualified.name.of.layout.class

log4j.appender.appenderName.layout.option1 = value1

…

log4j.appender.appenderName.layout.option = valueN

其中，Log4j提供的layout有以下幾種：

org.apache.log4j.HTMLLayout（以HTML表格形式布局）

org.apache.log4j.PatternLayout（可以靈活地指定布局模式）

org.apache.log4j.SimpleLayout（包含日志信息的級別和信息字符串）

org.apache.log4j.TTCCLayout（包含日志產生的時間、線程、類別等等信息）

五、在代碼中使用Log4j

1．獲取記錄器

使用Log4j，第一步就是獲取日志記錄器，這個記錄器將負責控制日志信息。其語法為：public static Logger getLogger( String name)，通過指定的名字獲得記錄器，如果必要的話，則為這個名字創建一個新的記錄器。Name一般取本類的名字，比如：static Logger logger = Logger.getLogger ( ServerWithLog4j.class.getName () ) 。

2．讀取配置文件

當獲得了日志記錄器之后，第二步將配置Log4j環境，其語法為：BasicConfigurator.configure ()： 自動快速地使用缺省Log4j環境。PropertyConfigurator.configure ( String configFilename) ：讀取使用Java的特性文件編寫的配置文件。

DOMConfigurator.configure ( String filename ) ：讀取XML形式的配置文件。

3．插入記錄信息（格式化日志信息）

當上兩個必要步驟執行完畢，就可以使用不同優先級別的日志記錄語句插入到記錄日志的任何地方，其語法如下：

Logger.debug ( Object message )

Logger.info ( Object message )

Logger.warn ( Object message )

Logger.error ( Object message )

參考

http://www.ibm.com/developerworks/cn/java/l-log4j/index.html

http://www.log4j.org/

http://www.log4j.org/log4j/faq.html

http://jakarta.apache.org/log4j

http://java.chinaitlab.com/tools/727017.html

http://logging.apache.org/log4j/

?

轉載于:https://www.cnblogs.com/zysyz/archive/2009/09/18/1569608.html

總結

以上是生活随笔為你收集整理的Log4j入门的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。