log4j使用詳細(xì)解析

更新時(shí)間：2017年10月19日 14:20:24 作者：動(dòng)力節(jié)點(diǎn)

Log4j 除了可以記錄程序運(yùn)行日志信息外還有一重要的功能就是用來(lái)顯示調(diào)試信息。下面通過(guò)本文給大家介紹log4j使用詳細(xì)解析，感興趣的朋友一起看看吧

簡(jiǎn)單的說(shuō)log4j就是幫助開(kāi)發(fā)人員進(jìn)行日志輸出管理的API類(lèi)庫(kù)。它最重要的特點(diǎn)就可以配置文件靈活的設(shè)置日志信息的優(yōu)先級(jí)、日志信息的輸出目的地、日志信息的輸出格式

Log4j 除了可以記錄程序運(yùn)行日志信息外還有一重要的功能就是用來(lái)顯示調(diào)試信息。

程序員經(jīng)常會(huì)遇到脫離Java ide環(huán)境調(diào)試程序的情況，這時(shí)大多數(shù)人會(huì)選擇使用System.out.println語(yǔ)句輸出某個(gè)變量值的方法進(jìn)行調(diào)試。這樣會(huì)帶來(lái)一個(gè)非常麻煩的問(wèn)題：一旦哪天程序員決定不要顯示這些System.out.println的東西了就只能一行行的把這些垃圾語(yǔ)句注釋掉。若哪天又需調(diào)試變量值，則只能再一行行去掉這些注釋恢復(fù)System.out.println語(yǔ)句。使用log4j可以很好的處理類(lèi)似情況。

log4j使用方法

下面介紹的是log4j一些理論方面的知識(shí)。

1、定義配置文件

首先使用配置文件將使我們的應(yīng)用程序更加靈活配置log日志輸出方式包括輸出優(yōu)先級(jí)、輸出目的地、輸出格式。

Log4j支持兩種配置文件格式，

1）XML格式的文件，

2）Java特性文件log4j.properties（鍵=值）。

下面將介紹使用log4j.properties文件作為配置文件的方法：

①配置根Logger，其語(yǔ)法為：0　　

log4j.rootLogger = [ level ] , appenderName, appenderName, …

其中，level 是日志記錄的優(yōu)先級(jí)，分為OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者自定義的級(jí)別。

Log4j建議只使用四個(gè)級(jí)別，優(yōu)先級(jí)從高到低分別是 ERROR、WARN、INFO、DEBUG

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

②配置日志信息輸出目的地Appender，其語(yǔ)法為：

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（控制臺(tái)）， 
　　org.apache.log4j.FileAppender（文件）， 
　　org.apache.log4j.DailyRollingFileAppender（每天產(chǎn)生一個(gè)日志文件），
　　org.apache.log4j.RollingFileAppender（文件大小到達(dá)指定尺寸的時(shí)候產(chǎn)生一個(gè)新的文件）， 
　　org.apache.log4j.WriterAppender（將日志信息以流格式發(fā)送到任意指定的地方）

③配置日志信息的格式（布局），其語(yǔ)法為：

　　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（包含日志信息的級(jí)別和信息字符串）， 
　　org.apache.log4j.TTCCLayout（包含日志產(chǎn)生的時(shí)間、線程、類(lèi)別等等信息）

Log4J采用類(lèi)似C語(yǔ)言中的printf函數(shù)的打印格式格式化日志信息，打印參數(shù)如下：

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

2、在代碼中使用Log4j

①得到記錄器

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

public static Logger getLogger( String name)

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

static Logger logger = Logger.getLogger ( ServerWithLog4j.class.getName () )

②讀取配置文件

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

　BasicConfigurator.configure ()： 自動(dòng)快速地使用缺省Log4j環(huán)境。
　　PropertyConfigurator.configure ( String configFilename) ：讀取使用Java的特性文件編寫(xiě)的配置文件。

例：

PropertyConfigurator.configure(".\\src\\log4j.properties")
　　DOMConfigurator.configure ( String filename ) ：讀取XML形式的配置文件。

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

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

 Logger.debug ( Object message ) ;
　　Logger.info ( Object message ) ;
　　Logger.warn ( Object message ) ;
　　Logger.error ( Object message ) ;

log4j范例程序

下面將使用一個(gè)最簡(jiǎn)單的范例程序來(lái)進(jìn)一步說(shuō)明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 ...");
   }
}

程序說(shuō)明：

① static Logger logger = Logger.getLogger(LogTest.class.getName());就是創(chuàng)建一個(gè)屬于LogTest類(lèi)的Logger對(duì)象，創(chuàng)建時(shí)要告知Logger你當(dāng)前的Class是什么。

② PropertyConfigurator.configure ("src/log4j.properties")就是說(shuō)使用當(dāng)前工程目錄下的src文件夾中的log4j.properties文件作為配置文件。若將log4j.properties放在工程根目錄下也可不寫(xiě)此句，程序會(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

程序說(shuō)明：

① log4j.rootCategory=DEBUG, stdout，R

就是說(shuō)我要顯示所有優(yōu)先權(quán)等於和高于Debug的信息。

"stdout"，”R”表示我定義了兩個(gè)輸出端(隨便什么名字都好)

②下面的三行說(shuō)stdout輸出端其實(shí)是標(biāo)準(zhǔn)輸出Console，也就是屏幕。輸出的格式是PatternLayout。轉(zhuǎn)換方式是%5p (%F:%L) - %m%n，即前五格用來(lái)顯示優(yōu)先權(quán)，再顯示當(dāng)前的文件名，加當(dāng)前的行數(shù)。最后%m是logger.debug()或logger.info()或logger.warn()或logger.error()里的信息。%n表示回車(chē)空行

③再加上下面六行則log信息不光顯示在屏幕上，而且將被保存在一個(gè)叫"log.txt"的文件里，文件最大為100KB。如果文件大小超過(guò)100KB，文件會(huì)被備份成"log.txt.1"，新的"log.txt"繼續(xù)記錄log信息。

接下來(lái)我們可以改變log4j.properties，而不需重新編譯就可以控制log信息是否顯示、log信息的輸出端類(lèi)型、輸出方式、輸出格式，等等。

舉例如下：

①在log4j.properties文件里把"log4j.rootCategory=DEBUG,stdout,R"改寫(xiě)成"log4j.rootCategory=OFF, stdout,R"，這樣所有的log信息都不會(huì)顯示了；解決了本文開(kāi)始提出的問(wèn)題。

②在log4j.properties文件里把"log4j.rootCategory=DEBUG,stdout,R"改寫(xiě)成"log4j.rootCategory=INFO, stdout,R"，這樣只顯示INFO, WARN, ERROR的log信息，而DEBUG信息不會(huì)被顯示；

在web程序中使用log4j注意問(wèn)題

1、由于jsp或servlet在執(zhí)行狀態(tài)時(shí)沒(méi)有當(dāng)前路徑概念，所有使用PropertyConfigurator.configure（String）語(yǔ)句找log4j.properties文件時(shí)要給出相對(duì)于當(dāng)前jsp或servlet的路徑轉(zhuǎn)化成為一個(gè)絕對(duì)的文件系統(tǒng)路徑。

方法是使用servletcontext.getrealpath(string)語(yǔ)句。例：

//得到當(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è)置絕對(duì)路徑。例：

log4j.appender.R.File屬性設(shè)置日志文件存放位置。我們可以用讀寫(xiě).properties配置文件的方法進(jìn)行靈活設(shè)置。

在spring框架下，使用log4j更是容易，下面介紹一下spring下的log4j應(yīng)用。

1）首先要下載相應(yīng)的jar包（log4j.jar）

2）配置web.xml，在web.xml中加入如下配置

<context-param>
    <param-name>log4jConfigLocation</param-name>
    <param-value>/WEB-INF/config/log4j.properties</param-value>
  </context-param>
  <context-param>
    <param-name>log4jRefreshInterval</param-name>
    <param-value>6000</param-value>
  </context-param>
  <listener>
    <listener-class>
     org.springframework.web.util.Log4jConfigListener
    </listener-class>
  </listener>

說(shuō)明：在上文的配置里，Log4jConfigListener會(huì)去WEB-INF/config/log4j.propeties 讀取配置文件;

開(kāi)一條watchdog線程每60秒掃描一下配置文件的變化（這樣在web服務(wù)啟動(dòng)后再去修改配置文件也不用重新啟動(dòng)web服務(wù)了）;

并把web目錄的路徑壓入一個(gè)叫webapp.root的系統(tǒng)變量（webapp.root將在log4j.properties文件中使用）。

總結(jié)

以上所述是小編給大家介紹的log4j使用詳細(xì)解析，希望對(duì)大家有所幫助，如果大家有任何疑問(wèn)請(qǐng)給我留言，小編會(huì)及時(shí)回復(fù)大家的。在此也非常感謝大家對(duì)腳本之家網(wǎng)站的支持！

您可能感興趣的文章: