Log4j基本使用方

 


Log4j基本使用方法



Log4j由三個重要的組件構(gòu)成：日志信息的優(yōu)先級，日志信息的輸出目的地，日志信息的輸出格式。日志信息的優(yōu)先級從高到低有ERROR、WARN、INFO、DEBUG，分別用來指定這條日志信息的重要程度；日志信息的輸出目的地指定了日志將打印到控制臺還是文件中；而輸出格式則控制了日志信息的顯示內(nèi)容。


一、定義配置文件

其實(shí)您也可以完全不使用配置文件，而是在代碼中配置Log4j環(huán)境。但是，使用配置文件將使您的應(yīng)用程序更加靈活。Log4j支持兩種配置文件格式，一種是XML格式的文件，一種是Java特性文件（鍵=值）。下面我們介紹使用Java特性文件做為配置文件的方法：



1.配置根Logger，其語法為：



log4j.rootLogger = [ level ] , appenderName, appenderName, … </pre>


其中，level 是日志記錄的優(yōu)先級，分為OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者您定義的級別。Log4j建議只使用四個級別，優(yōu)先級從高到低分別是ERROR、WARN、INFO、DEBUG。



通過在這里定義的級別，您可以控制到應(yīng)用程序中相應(yīng)級別的日志信息的開關(guān)。比如在這里定義了INFO級別，則應(yīng)用程序中所有DEBUG級別的日志信息將不被打印出來。 appenderName就是指定日志信息輸出到哪個地方。您可以同時指定多個輸出目的地。



2.配置日志信息輸出目的地Appender，其語法為：



log4j.appender.appenderName = fully.qualified.name.of.appender.class </pre>


　　log4j.appender.appenderName.option1 = value1 　　… 　　log4j.appender.appenderName.option = valueN



　　其中，Log4j提供的appender有以下幾種： 　　org.apache.log4j.ConsoleAppender（控制臺）， 　　org.apache.log4j.FileAppender（文件）， 　　org.apache.log4j.DailyRollingFileAppender（每天產(chǎn)生一個日志文件），　　org.apache.log4j.RollingFileAppender（文件大小到達(dá)指定尺寸的時候產(chǎn)生一個新的文件），



org.apache.log4j.WriterAppender（將日志信息以流格式發(fā)送到任意指定的地方） </pre>


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



log4j.appender.appenderName.layout = fully.qualified.name.of.layout.class </pre>


　　log4j.appender.appenderName.layout.option1 = value1 　　…



log4j.appender.appenderName.layout.option = valueN </pre>


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



org.apache.log4j.HTMLLayout（以HTML表格形式布局）， org.apache.log4j.PatternLayout（可以靈活地指定布局模式）， org.apache.log4j.SimpleLayout（包含日志信息的級別和信息字符串）， org.apache.log4j.TTCCLayout（包含日志產(chǎn)生的時間、線程、類別等等信息） </pre>


Log4J采用類似C語言中的printf函數(shù)的打印格式格式化日志信息，打印參數(shù)如下： %m 輸出代碼中指定的消息



%p 輸出優(yōu)先級，即DEBUG，INFO，WARN，ERROR，F(xiàn)ATAL %r 輸出自應(yīng)用啟動到輸出該log信息耗費(fèi)的毫秒數(shù) %c 輸出所屬的類目，通常就是所在類的全名 %t 輸出產(chǎn)生該日志事件的線程名 %n 輸出一個回車換行符，Windows平臺為“\r\n”，Unix平臺為“\n” %d 輸出日志時間點(diǎn)的日期或時間，默認(rèn)格式為ISO8601，也可以在其后指定格式，比如：%d{yyy MMM dd HH:mm:ss,SSS}，輸出類似：2002年10月18日 22：10：28，921 %l 輸出日志事件的發(fā)生位置，包括類目名、發(fā)生的線程，以及在代碼中的行數(shù)。舉例：Testlog4.main(TestLog4.java:10) </pre>

二、在代碼中使用Log4j

1.得到記錄器



使用Log4j，第一步就是獲取日志記錄器，這個記錄器將負(fù)責(zé)控制日志信息。其語法為：



public static Logger getLogger( String name) </pre>


通過指定的名字獲得記錄器，如果必要的話，則為這個名字創(chuàng)建一個新的記錄器。Name一般取本類的名字，比如：



static Logger logger = Logger.getLogger ( ServerWithLog4j.class.getName () ) </pre>


2.讀取配置文件



當(dāng)獲得了日志記錄器之后，第二步將配置Log4j環(huán)境，其語法為：



BasicConfigurator.configure ()： 自動快速地使用缺省Log4j環(huán)境。 PropertyConfigurator.configure ( String configFilename) ：讀取使用Java的特性文件編寫的配置文件。 DOMConfigurator.configure ( String filename ) ：讀取XML形式的配置文件。 </pre>


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



當(dāng)上兩個必要步驟執(zhí)行完畢，您就可以輕松地使用不同優(yōu)先級別的日志記錄語句插入到您想記錄日志的任何地方，其語法如下：



Logger.debug ( Object message ) ; Logger.info ( Object message ) ; Logger.warn ( Object message ) ; Logger.error ( Object message ) ; </pre>