1.1 背景
在應用程序中添加日誌記錄總的來說基於三個目的：監視代碼中變量的變化情況，週期性的記錄到文件中供其他應用進行統計分析工作；跟蹤代碼運行時軌跡，作爲日後審計的依據；擔當集成開發環境中的調試器的作用，向文件或控制檯打印代碼的調試信息。
最普通的做法就是在代碼中嵌入許多的打印語句，這些打印語句可以輸出到控制檯或文件中，比較好的做法就是構造一個日誌操作類來封裝此類操作，而不是讓一系列的打印語句充斥了代碼的主體。
1.2 Log4j簡介
在強調可重用組件開發的今天，除了自己從頭到尾開發一個可重用的日誌操作類外，Apache爲我們提供了一個強有力的日誌操作包-Log4j。
通常，我們都提供一個名爲 log4j.properties的文件，在第一次調用到Log4J時，Log4J會在類路徑（../web-inf/class/當然也可以放到其它任何目錄，只要該目錄被包含到類路徑中即可）中定位這個文件，並讀入這個文件完成的配置。這個配置文件告訴Log4J以什麼樣的格式、把什麼樣的信息、輸出到什麼地方。
Log4j有三個主要的組件：Loggers(記錄器)，Appenders (輸出源)和Layouts(佈局)，這裏可簡單理解爲日誌類別，日誌要輸出的地方和日誌以何種形式輸出。綜合使用這三個組件可以輕鬆的記錄信息的類型和級別，並可以在運行時控制日誌輸出的樣式和位置。下面對三個組件分別進行說明：
1、 Loggers
Loggers組件在此係統中被分爲五個級別：DEBUG、INFO、WARN、ERROR和FATAL。這五個級別是有順序的，DEBUG < INFO < WARN < ERROR < FATAL，分別用來指定這條日誌信息的重要程度,明白這一點很重要，這裏Log4j有一個規則：假設Loggers級別爲P，如果在Loggers中發生了一個級別Q比P高，則可以啓動，否則屏蔽掉。
假設你定義的級別是info，那麼error和warn的日誌可以顯示而比他低的debug信息就不顯示了。
Java程序舉例來說：
//建立Logger的一個實例，命名爲“com.foo”
Logger logger = Logger.getLogger("com.foo"); //"com.foo"是實例進行命名，也可以任意
//設置logger的級別。通常不在程序中設置logger的級別。一般在配置文件中設置。
logger.setLevel(Level.INFO);
Logger barlogger = Logger.getLogger("com.foo.Bar");
//下面這個請求可用，因爲WARN >= INFO
logger.warn("Low fuel level.");
//下面這個請求不可用，因爲DEBUG < INFO
logger.debug("Starting search for nearest gas station.");
//命名爲“com.foo.bar”的實例barlogger會繼承實例“com.foo”的級別。因此，下面這個請求可用，因爲INFO >= INFO
barlogger.info("Located nearest gas station.");
//下面這個請求不可用，因爲DEBUG < INFO
barlogger.debug("Exiting gas station search");
這裏“是否可用”的意思是能否輸出Logger信息。
在對Logger實例進行命名時，沒有限制，可以取任意自己感興趣的名字。一般情況下建議以類的所在位置來命名Logger實例，這是目前來講比較有效的Logger命名方式。這樣可以使得每個類建立自己的日誌信息，便於管理。比如：
static Logger logger = Logger.getLogger(ClientWithLog4j.class.getName());
2、Appenders
禁用與使用日誌請求只是Log4j其中的一個小小的地方，Log4j日誌系統還允許把日誌輸出到不同的地方，如控制檯（Console）、文件（Files）、根據天數或者文件大小產生新的文件、以流的形式發送到其它地方等等。常用的Appender有：
org.apache.log4j.ConsoleAppender（控制檯）
org.apache.log4j.FileAppender（文件）
org.apache.log4j.DailyRollingFileAppender（每天產生一個日誌文件）
org.apache.log4j.RollingFileAppender（文件大小到達指定尺寸的時候產生一個新的文件）
org.apache.log4j.WriterAppender（將日誌信息以流格式發送到任意指定的地方）
配置時使用方式爲：
log4j.appender.appenderName = fully.qualified.name.of.appender.class
log4j.appender.appenderName.option1 = value1
…
log4j.appender.appenderName.optionN = valueN
這樣就爲日誌的輸出提供了相當大的便利。
3、Layouts
有時用戶希望根據自己的喜好格式化自己的日誌輸出。Log4j可以在Appenders的後面附加Layouts來完成這個功能。Layouts提供了四種日誌輸出樣式，如根據HTML樣式、自由指定樣式、包含日誌級別與信息的樣式和包含日誌時間、線程、類別等信息的樣式等等。常用的有：
org.apache.log4j.HTMLLayout（以HTML表格形式佈局），
org.apache.log4j.PatternLayout（可以靈活地指定佈局模式），
org.apache.log4j.SimpleLayout（包含日誌信息的級別和信息字符串），
org.apache.log4j.TTCCLayout（包含日誌產生的時間、線程、類別等等信息）
配置時使用方式爲：
log4j.appender.appenderName.layout =fully.qualified.name.of.layout.class
log4j.appender.appenderName.layout.option1 = value1
…
log4j.appender.appenderName.layout.optionN = valueN
1.3 Log4j配置
在實際編程時，要使Log4j真正在系統中運行事先還要對配置文件進行定義。定義步驟就是對Logger、Appender及Layout的分別配置。
Log4j支持兩種配置文件格式，一種是XML格式的文件，一種是java properties（key=value）。下面我們介紹使用Java特性文件做爲配置文件的方法
具體如下：
1、配置根Logger，其語法爲：
log4j.rootLogger = [ level ] , appenderName1, appenderName2, …
level : 是日誌記錄的優先級，分爲OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者您定義的級別。Log4j建議只使用四個級別，優先級從高到低分別是ERROR、WARN、INFO、DEBUG。通過在這裏定義的級別，您可以控制到應用程序中相應級別的日誌信息的開關。比如在這裏定義了INFO級別，則應用程序中所有DEBUG級別的日誌信息將不被打印出來。
appenderName:就是指定日誌信息輸出到哪個地方。您可以同時指定多個輸出目的地。
例如：log4j.rootLogger＝info,A1,B2,C3
2、配置日誌信息輸出目的地，其語法爲：
log4j.appender.appenderName = fully.qualified.name.of.appender.class //
"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（將日誌信息以流格式發送到任意指定的地方）
1.ConsoleAppender選項
Threshold=WARN:指定日誌消息的輸出最低層次。
ImmediateFlush=true:默認值是true,意謂着所有的消息都會被立即輸出。
Target=System.err：默認情況下是：System.out,指定輸出控制檯
2.FileAppender 選項
Threshold=WARN:指定日誌消息的輸出最低層次。
ImmediateFlush=true:默認值是true,意謂着所有的消息都會被立即輸出。
File=mylog.txt:指定消息輸出到mylog.txt文件。
Append=false:默認值是true,即將消息增加到指定文件中，false指將消息覆蓋指定的文件內容。
3.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: 每分鐘
4.RollingFileAppender 選項
Threshold=WARN:指定日誌消息的輸出最低層次。
ImmediateFlush=true:默認值是true,意謂着所有的消息都會被立即輸出。
File=mylog.txt:指定消息輸出到mylog.txt文件。
Append=false:默認值是true,即將消息增加到指定文件中，false指將消息覆蓋指定的文件內容。
MaxFileSize=100KB: 後綴可以是KB, MB 或者是 GB. 在日誌文件到達該大小時，將會自動滾動，即將原來的內容移到mylog.log.1文件。
MaxBackupIndex=2:指定可以產生的滾動文件的最大數。
log4j.appender.A1=org.apache.log4j.ConsoleAppender //這裏指定了日誌輸出的第一個位置A1是控制檯ConsoleAppender
3、配置日誌信息的格式，其語法爲：
A. log4j.appender.appenderName.layout = fully.qualified.name.of.layout.class
"fully.qualified.name.of.layout.class" 可以指定下面4個格式中的一個：
1.org.apache.log4j.HTMLLayout（以HTML表格形式佈局），
2.org.apache.log4j.PatternLayout（可以靈活地指定佈局模式），
3.org.apache.log4j.SimpleLayout（包含日誌信息的級別和信息字符串），
4.org.apache.log4j.TTCCLayout（包含日誌產生的時間、線程、類別等等信息）
1.HTMLLayout 選項
LocationInfo=true:默認值是false,輸出java文件名稱和行號
Title=my app file: 默認值是 Log4J Log Messages.
2.PatternLayout 選項
ConversionPattern=%m%n :指定怎樣格式化指定的消息。
3.XMLLayout 選項
LocationInfo=true:默認值是false,輸出java文件和行號
實際應用：
log4j.appender.A1.layout=org.apache.log4j.PatternLayout
這裏需要說明的就是日誌信息格式中幾個符號所代表的含義：
－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"輸出日誌信息換行
可以在%與模式字符之間加上修飾符來控制其最小寬度、最大寬度、和文本的對齊方式。如：
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.rootLogger=INFO,A1，B2
log4j.appender.A1=org.apache.log4j.ConsoleAppender
log4j.appender.A1.layout=org.apache.log4j.PatternLayout
log4j.appender.A1.layout.ConversionPattern=%-4r %-5p %d{yyyy-MM-dd HH:mm:ssS} %c %m%n
0 INFO 2003-06-13 13:23:46968 ClientWithLog4j Client socket: Socket[addr=localhost/127.0.0.1,port=8002,localport=2014]
16 DEBUG 2003-06-13 13:23:46984 ClientWithLog4j Server says: 'Java server with log4j, Fri Jun 13 13:23:46 CST 2003'
16 DEBUG 2003-06-13 13:23:46984 ClientWithLog4j GOOD
16 DEBUG 2003-06-13 13:23:46984 ClientWithLog4j Server responds: 'Command 'HELLO' not understood.'
16 DEBUG 2003-06-13 13:23:46984 ClientWithLog4j HELP
16 DEBUG 2003-06-13 13:23:46984 ClientWithLog4j Server responds: 'Vocabulary: HELP QUIT'
16 DEBUG 2003-06-13 13:23:46984 ClientWithLog4j QUIT