使用Log4J進行日誌操作
Log4J簡介
Log4J是Apache的一個開放源代碼項目，它是一個日誌操作包，通過使用Log4J，可以指定日誌信息輸出的目的地，如控制檯、文件、ＣＵＩ組件、NT的事件記錄器；還可以控制每一條日誌輸出格式。此外，通過定義日誌信息的級別，能夠非常細緻地控制日誌的輸出，最令人感興趣的是，這些功能可以通過一個配置文件來靈活進行配置，而不需要修改應程序代碼。
在應用程序中輸出日誌有３個目的：
l 監視代碼中變量的變化情況，把數據週期性記錄到文件中供其他應用進行統計分析工作
l 跟蹤代碼運行時軌跡，作爲日後審計的依據
l 擔當集成開發環境中的調試器的作用，向文件和控制檯打印代碼的調試信息
要在程序中輸出日誌，最普通的做法就是在代碼中嵌入語句，這些打印語句可以把日誌輸出到控制檯或文件中，比較好的做法就是構造一個日誌操作類來封裝此類操作，而不是讓一系列的打印語句充斥代碼的主體。
在強調可重用組件的今天，除了自己從頭到尾開發一個可重用的日誌操作類名，Apache爲我們提供了一個強有力的現成的日誌操作包Log4J。
Log4J主要由三大組件構成：
l Logger:負責生成日誌，並能夠對日誌信息進行分類篩選，通俗地講就是決定什麼日誌信息應該輸出，什麼日誌信息應該被忽略
l Appender：定義了日誌信息輸出的目的地，指定日誌信息應該被輸出到什麼地方，這些地方可以是控制檯、文件、網絡設備等
l Layout: 指定日誌信息的輸出格式
這個３個組件協同工作，使得開發者能夠依據日誌信息類別記錄信息，並能夠在程序運行期間，控制日誌信息的輸出格式以及日誌存放地點。
一個Logger可以有多個Appender，這意味着日誌信息可以同時輸出到多個設備上，每個Appender都對應一種Layout,Layout決定了輸出日誌信息的格式。
假定根據實際需要，要求程序中的日誌信息既能輸出到程序運行的控制檯下，又能輸出到指定的文件中，並且當日志信息輸出到控制檯時SimplLayout佈局，當日志信息輸出到文件時PatternLayout佈局，此時Logger、Appender和Layout3個組件的關係如圖
Appender組件 （指定輸出目的）
Log4J的Appender組件決定將日誌信息輸出到什麼地方。日前Log4J的Ａｐｐｅｎｄｅｒ支持將日誌信息輸出到以下的目的：
l 控制檯(Console)
l 文件
l ＧＵＩ組件
一個logger可以同時對應多個Appender,也就是說，一個Logger的日誌信息可以同時輸出到多個目的地，例如：要爲rootLogger配置兩個Appender; 一個是file，一個是console,則可以採用如下配置代碼：
|
log4j.rootLogger =WARN,file,console rootLogger 配置日誌級別、輸出目的； log4j.appender.file=org.apache.log4jRollingFileAppender log4j.appender.console=org.apache.log4j.ConsoleAppender |
Layout組件
Layout組件用來決定日誌的輸出格式，它有以下幾種類型
l org.apache.log4j.HTMLLayout(以ＨＴＭＬ表格形式佈局)
l org.apache.log4j.PatternLayout(可以靈活地指定佈局模式)
l org.apache.log4j.SimpleLayout(包含日誌信息級別和信息字符串)
l org.apache.log4j.TTCCLayout(包含日誌產生的時間、線程和類別等信息)
Log4j的基本使用方法
在應用程序中使用Log4J，首先在一個配置文件中配置Log4j的各個組件，然後就可以在程序中通過Log4ＪAPI來操作日誌
定義配置文件
Log4J由３個重要的組件構成：Logger、Appender和layout。Log4J支持在程序中以編程的方式設置這些組件，還支持通過配置文件來配置組件，後一種方式更爲靈活。
Log4J支持兩種配置文件格式，一種是ＸＭＬ格式，一種是Java屬性文件，
1. 配置Logger組件
其語法爲：
log4j.rootLogger = [ level ] , appenderName1, appenderName2, …
舉例：
log4j.rootLogger =WARN,file,console
level : 是日誌記錄的優先級，分爲OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者您定義的級別。
Log4j建議只使用四個級別，優先級從高到低分別是ERROR>WARN>INFO>DEBUG。通過在這裏定義的級別，您可以控制到應用程序中相應級別的日誌信息的開關。比如在這裏定 義了INFO級別，則應用程序中所有DEBUG級別的日誌信息將不被打印出來。
appenderName:就是指定日誌信息輸出到哪個地方。您可以同時指定多個輸出目的地。
All：打印所有日誌。
Off：關閉所有的日誌。
例如：log4j.rootLogger＝info,A1,B2,C3
2. 配置Appender組件
其語法爲：
log4j.appender.appenderName =fully.qualified.name.of.appender.class.
舉例：
log4j.appender.console=org.apache.log4j.ConsoleAppender
"fully.qualified.name.of.appender.class" 可以指定下面五個目的地中的一個：
1.org.apache.log4j.ConsoleAppender（控制檯）
2.org.apache.log4j.FileAppender（文件） 【只能把日誌輸出一個文件，不推薦】
3.org.apache.log4j.DailyRollingFileAppender（每天產生一個日誌文件）
4.org.apache.log4j.RollingFileAppender（文件大小到達指定尺寸的時候產生一個新的文件）
5.org.apache.log4j.WriterAppender（將日誌信息以流格式發送到任意指定的地方）
A.ConsoleAppender選項
Threshold=WARN:指定日誌消息的輸出最低層次。
ImmediateFlush=true:默認值是true,意謂着所有的消息都會被立即輸出。
Target=System.err：默認情況下是：System.out,指定輸出控制檯
B.FileAppender 選項
Threshold=WARN:指定日誌消息的輸出最低層次。
ImmediateFlush=true:默認值是true,意謂着所有的消息都會被立即輸出。
File=mylog.txt:指定消息輸出到mylog.txt文件。
Append=false:默認值是true,即將消息增加到指定文件中，false指將消息覆蓋
指定的文件內容。
C.DailyRollingFileAppender 選項
Threshold=WARN:指定日誌消息的輸出最低層次。
ImmediateFlush=true:默認值是true,意謂着所有的消息都會被立即輸出。
File=mylog.txt:指定消息輸出到mylog.txt文件。
Append=false:默認值是true,即將消息增加到指定文件中，false指將消息覆蓋指定
的文件內容。
DatePattern='.'yyyy-ww:每週滾動一次文件，即每週產生一個新的文件。當然也可
以指定按月、周、天、時和分。即對應的格式如下：
1)'.'yyyy-MM: 每月
2)'.'yyyy-ww: 每週
3)'.'yyyy-MM-dd: 每天
4)'.'yyyy-MM-dd-a: 每天兩次
5)'.'yyyy-MM-dd-HH: 每小時
6)'.'yyyy-MM-dd-HH-mm: 每分鐘
D.RollingFileAppender 選項
Threshold=WARN:指定日誌消息的輸出最低層次。
ImmediateFlush=true:默認值是true,意謂着所有的消息都會被立即輸出。
File=mylog.log:指定消息輸出到mylog.txt文件。
Append=false:默認值是true,即將消息增加到指定文件中，false指將消息覆蓋指
定的文件內容。
MaxFileSize=100KB: 後綴可以是KB, MB
或者是 GB.
在日誌文件到達該大小
時，將會自動滾動，即將原來的內容移到mylog.log.1文件。
MaxBackupIndex=2:指定可以產生的滾動文件的最大數。
3、配置日誌信息的格式
其語法爲：
1)log4j.appender.appenderName.layout=fully.qualified.name.of.layout.class
"fully.qualified.name.of.layout.class" 可以指定下面4個格式中的一個：
舉例：log4j.appender.console.layout=org.apache.log4j.PatternLayout
log4j.appender.console.layout.ConversionPattern=%d %p %c.%M()-%m%n
1.org.apache.log4j.HTMLLayout（以HTML表格形式佈局）包含選項：
LocationInfo=true:默認值是false,輸出java文件名稱和行號
Title=my app file: 默認值是
Log4J Log Messages.
2.org.apache.log4j.PatternLayout（可以靈活地指定佈局模式）包含選項：
ConversionPattern=%m%n :指定怎樣格式化指定的消息。
3.org.apache.log4j.SimpleLayout（包含日誌信息的級別和信息字符串）
4.org.apache.log4j.TTCCLayout（包含日誌產生的時間、線程、類別等等信息）
2)log4j.appender.A1.layout.ConversionPattern=%-4r %-5p %d{yyyy-MM-dd HH:mm:ssS} %c %m%n
日誌信息格式中幾個符號所代表的含義：
－X號: X信息輸出時左對齊；
%p: 輸出日誌信息優先級，即DEBUG，INFO，WARN，ERROR，FATAL,
%d: 輸出日誌時間點的日期或時間，默認格式爲ISO8601，也可以在其後指定格式，比如： %d{yyy MMM dd HH:mm:ss,SSS}，輸出類似：2002年10月18日
22：10：28，921
%r: 輸出自應用啓動到輸出該log信息耗費的毫秒數
%c: 輸出日誌信息所屬的類目，通常就是所在類的全名
%t: 輸出產生該日誌事件的線程名
%l: 輸出日誌事件的發生位置，相當於%C.%M(%F:%L)的組合,包括類目名、發生的線程， 以及在代碼中的行數。舉例：Testlog4.main(TestLog4.java:10)
%x: 輸出和當前線程相關聯的NDC(嵌套診斷環境),尤其用到像java
servlets這樣的多客戶多線程的應用中。
%%: 輸出一個"%"字符
%F: 輸出日誌消息產生時所在的文件名稱
%L: 輸出代碼中的行號
%m: 輸出代碼中指定的消息,產生的日誌具體信息
%n: 輸出一個回車換行符，Windows平臺爲"\r\n"，Unix平臺爲"\n"輸出日誌信息換行
%M 代表方法的名字
可以在%與模式字符之間加上修飾符來控制其最小寬度、最大寬度、和文本的對齊方式。如：
1)%20c：指定輸出category的名稱，最小的寬度是20，如果category的名稱小於20。
2)%-20c:指定輸出category的名稱，最小的寬度是20，如果category的名稱小於20的話，"-"號指定左對齊。
3)%.30c:指定輸出category的名稱，最大的寬度是30，如果category的名稱大於30的話，就會將左邊多出的字符截掉，但小於30的話也不會有空格。
4)%20.30c:如果category的名稱小於20就補空格，並且右對齊，如果其名稱長於30字符，就從左邊交遠銷出的字符截掉。
在程序中訪問Log4J,需要用到Log4J的ＪＡＲ文件。
在程序中使用Log4J包含以下過程：
l 獲得日誌記錄器
l 讀取配置文件，配置Log4J環境
l 輸出日誌信息
在進入學習Log4J之前，我們要了解通用日誌包中的兩個常用接口LogFactory和Log，下面分別介紹它們的用法。
Log接口
通用日誌包把日誌消息分爲6種級別：FATAL(致命的)、ERROR(錯誤)、WARN(警告)、INFO(信息)、DEBUG(調試)和TRACE(細節)。其中FATAL級別最高，TRACE級別最低。通用日誌包採用日誌級別機制，可以靈活的控制輸出的日誌內容。
org.apache.commons.logging.Log接口代表日誌器，它提供了一組輸出日誌的方法：
l fatal(Object message): 輸出FATAL級別的日誌消息。
l error(Object message): 輸出ERROR級別的日誌消息。
l ……
l trace(Object message): 輸出TRACE級別的日誌消息。
對於以上輸出日誌的方法，只有當它輸出日誌的級別大於或等於爲日誌其配置的日誌級別時，這個方法纔會被真正執行。例如，如果日誌器的日誌級別爲WARN，那麼在程序中，它的fatal()、error()和warn()方法會被執行，而info()、debug()和trace()方法不會被執行。
Log接口還提供了一組判斷是否允許輸出特定級別的日誌消息的方法：
l isFatalEnabled()
l isErrorEnabled()
l ……
l isTraceEnabled()
在程序輸出某種級別的日誌消息之前，提倡先調用以上方法來判斷該級別的日誌是否允許輸出，這有助於提高應用的性能。例如以下代碼先把日誌消息添加到StringBuffer中，最後在調用日誌器的debug()方法輸出日誌：
StringBuffer buf = new StringBuffer();
buf.append(“Login Successsul - ”);
buf.append(“Name:”);
buf.append(username);
log.debug(buf.toString());
對於以上代碼，如果日誌器實際上不允許輸出DEBUG級別的日誌，那麼執行日誌器的debug()方法不會輸出任何消息，此時向StringBuffer中添加消息的一大串操做都將是多餘的。爲了提高性能，可以合理的使用isDebugEnabled()方法，避免應用執行多餘的操作：
if(log.isDebugEnabled){
StringBuffer buf = new StringBuffer();
buf.append(“Login Successsul - ”);
buf.append(“Name:”);
buf.append(username);
log.debug(bug.toString());
}
(二)LogFactory接口
org.apache.commons.logging.LogFactory接口提供了獲得日誌器實例的兩個靜態方法：
public static Log getLog(String name)throws LogConfigurationException;
public static Log getLog(Class class) throws LogConfigurationException;
第一個getLog()方法以name參數作爲日誌器的名字；第二個getLog()方法以class參數指定的類的名字作爲日誌器的名字，以下是第二個getLog()方法的一種實現方式：
public static Log getLog(Class class) throws LogConfigurationException{
getLog(class.getName); //call getLog(String name)
}
小結
Log4J主要由３大組件構成：Logger、Appender和Layout。Logger控制日誌信息的輸出；Appender決定日誌信息的輸出目的地；Layout決定日誌信息的輸出格式。Log4J允許用戶在配置文件中靈活地配置這些組件。在程序中使用Log4J非常方便，只要先取得日誌記錄器，然後讀取配置文件並配置Log4J環境，接下來就可以在程序中任何需要輸出日誌的地方，調用Logger類的適當方法來生成日誌。