log4j簡介 簡單的說log4j就是幫助開發(fā)人員進(jìn)行日志輸出管理的API類庫。它最重要的特點(diǎn)就 可以配置文件靈活的設(shè)置日志信息的優(yōu)先級、日志信息的輸出目的地以及日志信息的輸出格式。 Log4j除了可以記錄程序運(yùn)行日志信息外還有一重要的功能就是用來顯示調(diào)試信息。程序員經(jīng)常會(huì)遇到脫離java ide環(huán)境調(diào)試程序的情況,這時(shí)大多數(shù)人會(huì)選擇使用System.out.println語句輸出某個(gè)變量值的方法進(jìn)行調(diào)試。這樣會(huì)帶來一個(gè)非常麻煩的問題:一旦哪天程序員決定不要顯示這些System.out.println的東西了就只能一行行的把這些垃圾語句注釋掉。若哪天又需調(diào)試變量值,則只能再一行行去掉這些注釋恢復(fù)System.out.println語句。使用log4j可以很好的處理類似情況。 log4j使用方法 下面介紹的是log4j一些理論方面的知識(shí),讀者覺得枯燥的話可以跳過本節(jié)直接閱讀第三節(jié)實(shí)例部分。 1、定義配置文件 首先使用配置文件將使我們的應(yīng)用程序更加靈活配置log日志輸出方式包括輸出優(yōu)先級、輸出目的地、輸出格式。Log4j支持兩種配置文件格式,一種是XML格式的文件,一種是Java特性文件log4j.properties(鍵=值)。下面將介紹使用log4j.properties文件作為配置文件的方法: ①配置根Logger,其語法為:0 log4j.rootLogger = [ level ] , appenderName, appenderName, … 其中,level 是日志記錄的優(yōu)先級,分為OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者自定義的級別。Log4j建議只使用四個(gè)級別,優(yōu)先級從高到低分別是ERROR、WARN、INFO、DEBUG。通過在這里定義的級別,您可以控制到應(yīng)用程序中相應(yīng)級別的日志信息的開關(guān)。比如在這里定義了INFO級別,則應(yīng)用程序中所有DEBUG級別的日志信息將不被打印出來。 appenderName就是指定日志信息輸出到哪個(gè)地方。可同時(shí)指定多個(gè)輸出目的地。 ②配置日志信息輸出目的地Appender,其語法為: log4j.appender.appenderName = fully.qualified.name.of.appender.class 其中,Log4j提供的appender有以下幾種: ③配置日志信息的格式(布局),其語法為: log4j.appender.appenderName.layout = fully.qualified.name.of.layout.class 其中,Log4j提供的layout有以下幾種: Log4J采用類似C語言中的printf函數(shù)的打印格式格式化日志信息,打印參數(shù)如下: %m 輸出代碼中指定的消息 %p 輸出優(yōu)先級,即DEBUG,INFO,WARN,ERROR,F(xiàn)ATAL 2、在代碼中使用Log4j ①得到記錄器 使用Log4j,第一步就是獲取日志記錄器,這個(gè)記錄器將負(fù)責(zé)控制日志信息。其語法為: public static Logger getLogger( String name) 通過指定的名字獲得記錄器,如果必要的話,則為這個(gè)名字創(chuàng)建一個(gè)新的記錄器。Name一般取本類的名字,比如: static Logger logger = Logger.getLogger ( ServerWithLog4j.class.getName () ) ②讀取配置文件 當(dāng)獲得了日志記錄器之后,第二步將配置Log4j環(huán)境,其語法為: BasicConfigurator.configure (): 自動(dòng)快速地使用缺省Log4j環(huán)境。 例:PropertyConfigurator.configure(".\\src\\log4j.properties") ③插入記錄信息(格式化日志信息) 當(dāng)上兩個(gè)必要步驟執(zhí)行完畢,就可輕松地使用不同優(yōu)先級別的日志記錄語句插入到您想記錄日志的任何地方,其語法如下: Logger.debug ( Object message ) ; log4j范例程序 下面將使用一個(gè)最簡單的范例程序來進(jìn)一步說明log4j的使用方法。程序代碼如下: import org.apache.log4j.*; public class LogTest { static Logger logger = Logger.getLogger(LogTest.class.getName()); public static void main(String[] args) { PropertyConfigurator.configure ( “.\\src\log4j.properties”); logger.debug("Debug ..."); logger.info("Info ..."); logger.warn("Warn ..."); logger.error("Error ..."); } } 程序說明: ① static Logger logger = Logger.getLogger(LogTest.class.getName());就是創(chuàng)建一個(gè)屬于LogTest類的Logger對象,創(chuàng)建時(shí)要告知Logger你當(dāng)前的Class是什么。 ② PropertyConfigurator.configure ( “log4j.properties”)就是說使用當(dāng)前工程目錄下的src文件夾中的log4j.properties文件作為配置文件。若將log4j.properties放在工程根目錄下也可不寫此句,程序會(huì)自動(dòng)找到配置文件。 ③ logger.debug就是輸出debug的信息,logger.info就是輸出提示信息,logger.warn就是顯示警告信息,logger.error就是顯示錯(cuò)誤信息。 下面是配置文件log4j.properties的內(nèi)容: log4j.rootCategory=DEBUG, stdout,R log4j.appender.stdout=org.apache.log4j.ConsoleAppender log4j.appender.stdout.layout=org.apache.log4j.PatternLayout log4j.appender.stdout.layout.ConversionPattern=%5p (%F:%L) - %m%n log4j.appender.R=org.apache.log4j.RollingFileAppender log4j.appender.R.File=log.txt log4j.appender.R.MaxFileSize=100KB log4j.appender.R.MaxBackupIndex=1 log4j.appender.R.layout=org.apache.log4j.PatternLayout log4j.appender.R.layout.ConversionPattern=%d{yyyy MMM dd HH:mm:ss} %-5p %c - %m%n 程序說明: ① log4j.rootCategory=DEBUG, stdout,R 就是說我要顯示所有優(yōu)先權(quán)等於和高于Debug的信息。 ②下面的三行說stdout輸出端其實(shí)是標(biāo)準(zhǔn)輸出Console,也就是屏幕。輸出的格式是PatternLayout。轉(zhuǎn)換方式是%5p (%F:%L) - %m%n,即前五格用來顯示優(yōu)先權(quán),再顯示當(dāng)前的文件名,加當(dāng)前的行數(shù)。最后是logger.debug()或logger.info()或logger.warn()或logger.error()里的信息。%n表示回車空行。 ③再加上下面六行則log信息不光顯示在屏幕上,而且將被保存在一個(gè)叫"log.txt"的文件里,文件最大為100KB。如果文件大小超過100KB,文件會(huì)被備份成"log.txt.1",新的"log.txt"繼續(xù)記錄log信息。 接下來我們可以改變log4j.properties,而不需重新編譯就可以控制log信息是否顯示、log信息的輸出端類型、輸出方式、輸出格式,等等。舉例如下: ①在log4j.properties文件里把"log4j.rootCategory=DEBUG,stdout,R"改寫成"log4j.rootCategory=OFF, stdout,R",這樣所有的log信息都不會(huì)顯示了;解決了本文開始提出的問題。 在web程序中使用log4j注意問題 1、 由于jsp或servlet在執(zhí)行狀態(tài)時(shí)沒有當(dāng)前路徑概念,所有使用PropertyConfigurator.configure(String)語句找log4j.properties文件時(shí)要給出相對于當(dāng)前jsp或servlet的路徑轉(zhuǎn)化成為一個(gè)絕對的文件系統(tǒng)路徑。方法是使用servletcontext.getrealpath(string)語句。例: //得到當(dāng)前jsp路徑 String prefix = getServletContext().getRealPath("/"); //讀取log4j.properties PropertyConfigurator.configure(prefix+"\\WEB-INF\\log4j.properties"); 2、相應(yīng)的log4j.properties設(shè)置某個(gè)屬性時(shí)也要在程序中設(shè)置絕對路徑。例: log4j.appender.R.File屬性設(shè)置日志文件存放位置。我們可以用讀寫.properties配置文件的方法進(jìn)行靈活設(shè)置。
在了解了log4j的功能后,我們肯定會(huì)我們的程序中編寫一些Log4j日志記錄。對于使用Eclipse的程序員Log4e將是我們最得力的log4j日志編寫助手,現(xiàn)在開始Log4e之旅。 Log4e是一個(gè)免費(fèi)的Eclipse Plugin,它可幫助你在你的Java工程中快速加入Log; 我們可以在http://log4e./index.php/Download網(wǎng)站上下載Log4e最新版本。下載后將相應(yīng)文件夾拷貝到Eclipse的插件目錄下,重新Eclipse,在首選項(xiàng)中會(huì)多出一個(gè)Log4e選項(xiàng)。 Log4e可以有多個(gè)插入Log為一個(gè)方法、類,當(dāng)然也可以在當(dāng)前位置插入Log,同時(shí)其也可以把Sysout.out.println()的轉(zhuǎn)換為log;所有的這一切只需要你點(diǎn)點(diǎn)鼠標(biāo)或者按一次快捷鍵,下面我們只以為一個(gè)方法插入Log為例來講解 在Java編輯上下文中點(diǎn)擊右鍵,選擇Log4E,你將看到如下界面:
|
|