Eclipse的log4j插件log4e的用法

簡單的說log4j就是幫助開發人員進行日誌輸出管理的API類庫。它最重要的特色就能夠配置文件靈活的設置日誌信息的優先級、日誌信息的輸出目的地以及日誌信息的輸出格式。

Log4j除了能夠記錄程序運行日誌信息外還有一重要的功能就是用來顯示調試信息。程序員常常會遇到脫離java ide環境調試程序的狀況，這時大多數人會選擇使用System.out.println語句輸出某個變量值的方法進行調試。這樣會帶來一個很是麻煩的問題：一旦哪天程序員決定不要顯示這些System.out.println的東西了就只能一行行的把這些垃圾語句註釋掉。若哪天又需調試變量值，則只能再一行行去掉這些註釋恢復System.out.println語句。使用log4j能夠很好的處理相似狀況。

log4j使用方法
下面介紹的是log4j一些理論方面的知識，讀者以爲枯燥的話能夠跳過本節直接閱讀第三節實例部分。

　　一、定義配置文件

　   首先使用配置文件將使咱們的應用程序更加靈活配置log日誌輸出方式包括輸出優先級、輸出目的地、輸出格式。Log4j支持兩種配置文件格式，一種是XML格式的文件，一種是Java特性文件log4j.properties（鍵=值）。下面將介紹使用log4j.properties文件做爲配置文件的方法：

　　①配置根Logger，其語法爲：0

　　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採用相似C語言中的printf函數的打印格式格式化日誌信息，打印參數以下： %m 輸出代碼中指定的消息

　　%p 輸出優先級，即DEBUG，INFO，WARN，ERROR，FATAL 
　　%r 輸出自應用啓動到輸出該log信息耗費的毫秒數 
　　%c 輸出所屬的類目，一般就是所在類的全名 
　　%t 輸出產生該日誌事件的線程名 
　　%n 輸出一個回車換行符，Windows平臺爲「\r\n」，Unix平臺爲「\n」 
　　%d 輸出日誌時間點的日期或時間，默認格式爲ISO8601，也能夠在其後指定格式，好比：%d{yyy MMM dd HH:mm:ss,SSS}，輸出相似：2002年10月18日 22：10：28，921 
　　%l 輸出日誌事件的發生位置，包括類目名、發生的線程，以及在代碼中的行數。舉例：Testlog4.main(TestLog4.java:10)

　　二、在代碼中使用Log4j

　　①獲得記錄器

　　使用Log4j，第一步就是獲取日誌記錄器，這個記錄器將負責控制日誌信息。其語法爲：

　　public static Logger getLogger( String name)

　　經過指定的名字得到記錄器，若是必要的話，則爲這個名字建立一個新的記錄器。Name通常取本類的名字，好比：

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

　　②讀取配置文件

　　當得到了日誌記錄器以後，第二步將配置Log4j環境，其語法爲：

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

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

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

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

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

log4j範例程序

下面將使用一個最簡單的範例程序來進一步說明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());就是建立一個屬於LogTest類的Logger對象，建立時要告知Logger你當前的Class是什麼。

② PropertyConfigurator.configure ( 「log4j.properties」)就是說使用當前工程目錄下的src文件夾中的log4j.properties文件做爲配置文件。若將log4j.properties放在工程根目錄下也可不寫此句，程序會自動找到配置文件。

③ logger.debug就是輸出debug的信息，logger.info就是輸出提示信息，logger.warn就是顯示警告信息，logger.error就是顯示錯誤信息。

下面是配置文件log4j.properties的內容：

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

就是說我要顯示全部優先權等於和高於Debug的信息。
"stdout"，」R」表示我定義了兩個輸出端(隨便什麼名字都好)。

②下面的三行說stdout輸出端實際上是標準輸出Console，也就是屏幕。輸出的格式是PatternLayout。轉換方式是%5p (%F:%L) - %m%n，即前五格用來顯示優先權，再顯示當前的文件名，加當前的行數。最後是logger.debug()或logger.info()或logger.warn()或logger.error()裏的信息。%n表示回車空行。

③再加上下面六行則log信息不光顯示在屏幕上，並且將被保存在一個叫"log.txt"的文件裏，文件最大爲100KB。若是文件大小超過100KB，文件會被備份成"log.txt.1"，新的"log.txt"繼續記錄log信息。

接下來咱們能夠改變log4j.properties，而不需從新編譯就能夠控制log信息是否顯示、log信息的輸出端類型、輸出方式、輸出格式，等等。舉例以下：

①在log4j.properties文件裏把"log4j.rootCategory=DEBUG,stdout,R"改寫成"log4j.rootCategory=OFF, stdout,R"，這樣全部的log信息都不會顯示了；解決了本文開始提出的問題。
②在log4j.properties文件裏把"log4j.rootCategory=DEBUG,stdout,R"改寫成"log4j.rootCategory=INFO, stdout,R"，這樣只顯示INFO, WARN, ERROR的log信息，而DEBUG信息不會被顯示；

在web程序中使用log4j注意問題

一、 因爲jsp或servlet在執行狀態時沒有當前路徑概念，全部使用PropertyConfigurator.configure（String）語句找log4j.properties文件時要給出相對於當前jsp或servlet的路徑轉化成爲一個絕對的文件系統路徑。方法是使用servletcontext.getrealpath(string)語句。例：

//獲得當前jsp路徑

String prefix =   getServletContext().getRealPath("/");

//讀取log4j.properties

PropertyConfigurator.configure(prefix+"\\WEB-INF\\log4j.properties");

二、相應的log4j.properties設置某個屬性時也要在程序中設置絕對路徑。例：

log4j.appender.R.File屬性設置日誌文件存放位置。咱們能夠用讀寫.properties配置文件的方法進行靈活設置。

 

Eclipse的log4j插件log4e的用法  

eclipse, Log4j配置（詳細）

 

IT-Homer 專欄