log4j是一個(gè)非常強(qiáng)大的log記錄軟件，下面我們就來(lái)看看在項(xiàng)目中如何使log4j。首先當(dāng)然是得到log4j的jar檔，推薦使用1.2.X版，下載地址：http://logging.apache.org/log4j/1.2/download.html我們先看一個(gè)最簡(jiǎn)單的示例：
【示例1】項(xiàng)目結(jié)構(gòu)：
【注：由于這里的多個(gè)項(xiàng)目公用一個(gè)jar檔，我們可以創(chuàng)建一個(gè)專(zhuān)門(mén)放置jar檔的Java工程，然后將jar檔放到lib目錄下。在要使用的工程中按圖所示進(jìn)行引用 】
package com.coderdream.log4j;
import org.apache.log4j.Logger;
/**
* author by http://www.bt285.cn
* http://www.5a520.cn
*/
public class HelloLog4j {
private static Logger logger = Logger.getLogger(HelloLog4j.class);
public static void main(String[] args) {
// System.out.println("This is println message.");
// 記錄debug級(jí)別的信息
logger.debug("This is debug message.");
// 記錄info級(jí)別的信息
logger.info("This is info message.");
// 記錄error級(jí)別的信息
logger.error("This is error message.");
}
}
配置文件log4j.properties:
Properties代碼
1 #可以設(shè)置級(jí)別：debug>info>error
2 #debug：顯示debug、info、error
3 #info：顯示info、error
4 #error：只error
5 log4j.rootLogger=debug,appender1
6 #log4j.rootLogger=info,appender1
7 #log4j.rootLogger=error,appender1
8
9 #輸出到控制臺(tái)
10 log4j.appender.appender1=org.apache.log4j.ConsoleAppender
11 #樣式為T(mén)TCCLayout
12 log4j.appender.appender1.layout=org.apache.log4j.TTCCLayout
輸出結(jié)果：
Console代碼
13 [main] DEBUG com.coderdream.log4j.HelloLog4j - This is debug message.
14 [main] INFO com.coderdream.log4j.HelloLog4j - This is info message.
15 [main] ERROR com.coderdream.log4j.HelloLog4j - This is error message.
通過(guò)配置文件可知，我們需要配置3個(gè)方面的內(nèi)容：
1、根目錄（級(jí)別和目的地）；
2、目的地（控制臺(tái)、文件等等）；
3、輸出樣式。
下面我們來(lái)看看Log4J的類(lèi)圖：
Logger - 日志寫(xiě)出器，供程序員輸出日志信息
Appender - 日志目的地，把格式化好的日志信息輸出到指定的地方去
ConsoleAppender - 目的地為控制臺(tái)的Appender
FileAppender - 目的地為文件的Appender
RollingFileAppender - 目的地為大小受限的文件的Appender
Layout - 日志格式化器，用來(lái)把程序員的logging request格式化成字符串
PatternLayout - 用指定的pattern格式化logging request的Layout
Log4j基本使用方法
Log4j由三個(gè)重要的組件構(gòu)成：日志信息的優(yōu)先級(jí)，日志信息的輸出目的地，日志信息的輸出格式。日志信息的優(yōu)先級(jí)從高到低有ERROR、WARN、 INFO、DEBUG，分別用來(lái)指定這條日志信息的重要程度；日志信息的輸出目的地指定了日志將打印到控制臺(tái)還是文件中；而輸出格式則控制了日志信息的顯 示內(nèi)容。
一、定義配置文件
其實(shí)您也可以完全不使用配置文件，而是在代碼中配置Log4j環(huán)境。但是，使用配置文件將使您的應(yīng)用程序更加靈活。Log4j支持兩種配置文件格式，一種是XML格式的文件，一種是Java特性文件（鍵=值）。下面我們介紹使用Java特性文件做為配置文件的方法：
1.配置根Logger，其語(yǔ)法為：
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就是指B日志信息輸出到哪個(gè)地方。您可以同時(shí)指定多個(gè)輸出目的地。
2.配置日志信息輸出目的地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ā)送到任意指定的地方）
3.配置日志信息的格式（布局），其語(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有以e幾種：
org.apache.log4j.HTMLLayout（以HTML表格形式布局），
org.apache.log4j.PatternLayout（可以靈活地指定布局模式），
org.apache.log4j.SimpleLayout（包含日志信息的級(jí)別和信息字符串），
org.apache.log4j.TTCCLayout（包含日志產(chǎn)生的時(shí)間、線(xiàn)程、類(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)生該日志事件的線(xiàn)程名
%n 輸出一個(gè)回車(chē)換行符，Windows平臺(tái)為“rn”，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ā)生的線(xiàn)程，以及在代碼中的行數(shù)。舉例：Testlog4.main(TestLog4.java:10)
二、在代碼中使用Log4j
1.得到記錄器
使用Log4j，第一步就是獲取日志記錄器，這個(gè)記錄器將負(fù)責(zé)控制日志信息。其語(yǔ)法為：
public static Logger getLogger( String name)
通過(guò)指定的名字獲得記錄器，如果必要的話(huà)，則為這個(gè)名字創(chuàng)建一個(gè)新的記錄器。Name一般取本類(lèi)的名字，比如：
static Logger logger = Logger.getLogger ( ServerWithLog4j.class.getName () )
2.讀取配置文件
當(dāng)獲得了日志記錄器之后，第二步將配置Log4j環(huán)境，其語(yǔ)法為：
BasicConfigurator.configure ()： 自動(dòng)快速地使用缺省Log4j環(huán)境。
PropertyConfigurator.configure ( String configFilename) ：讀取使用Java的特性文件編寫(xiě)的配置文件。
DOMConfigurator.configure ( String filename ) ：讀取XML形式的配置文件。
3.插入記錄信息（格式化日志信息）
當(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 ) ;
示例2～示例8
【示例2】 輸出為文本文件或HTML文件
Porperties代碼
16 #設(shè)置級(jí)別：
17 log4j.rootLogger=debug,appender1
18
19 #輸出到文件(這里默認(rèn)為追加方式)
20 log4j.appender.appender1=org.apache.log4j.FileAppender
21 #設(shè)置文件輸出路徑
22 #【1】文本文件
23 #log4j.appender.appender1.File=c:/Log4JDemo02.log
24 #【2】HTML文件
25 log4j.appender.appender1.File=c:/Log4JDemo02.html
26 #設(shè)置文件輸出樣式
27 #log4j.appender.appender1.layout=org.apache.log4j.TTCCLayout
28 log4j.appender.appender1.layout=org.apache.log4j.HTMLLayout
【 示例3】 輸出為文本文件或HTML文件
Properties代碼
29 #設(shè)置級(jí)別和多個(gè)目的地
30 log4j.rootLogger=debug,appender1,appender2
31
32 #輸出到控制臺(tái)
33 log4j.appender.appender1=org.apache.log4j.ConsoleAppender
34 #設(shè)置輸出樣式
35 log4j.appender.appender1.layout=org.apache.log4j.TTCCLayout
36
37 #輸出到文件(這里默認(rèn)為追加方式)
38 log4j.appender.appender2=org.apache.log4j.FileAppender
39 #設(shè)置文件輸出路徑
40 #【1】文本文件
41 #log4j.appender.appender2.File=c:/Log4JDemo02.log
42 #【2】HTML文件
43 log4j.appender.appender2.File=c:/Log4JDemo02.html
44 #設(shè)置文件輸出樣式
45 #log4j.appender.appender2.layout=org.apache.log4j.TTCCLayout
46 log4j.appender.appender2.layout=org.apache.log4j.HTMLLayout
【示例4】 SimpleLayout樣式
Properties代碼
47 #設(shè)置級(jí)別和目的地
48 log4j.rootLogger=debug,appender1
49
50 #輸出到控制臺(tái)
51 log4j.appender.appender1=org.apache.log4j.ConsoleAppender
52 #設(shè)置輸出樣式
53 log4j.appender.appender1.layout=org.apache.log4j.SimpleLayout
輸出結(jié)果：
控制臺(tái)代碼
54 DEBUG - This is debug message.
55 INFO - This is info message.
56 ERROR - This is error message.
【示例5】 自定義樣式
Java代碼
57 #設(shè)置級(jí)別和目的地
58 log4j.rootLogger=debug,appender1
59
60 #輸出到控制臺(tái)
61 log4j.appender.appender1=org.apache.log4j.ConsoleAppender
62 #設(shè)置輸出樣式
63 log4j.appender.appender1.layout=org.apache.log4j.PatternLayout
64 #自定義樣式
65 # %r 時(shí)間 0
66 # %t 方法名 main
67 # %p 優(yōu)先級(jí) DEBUG/INFO/ERROR
68 # %c 所屬類(lèi)的全名(包括包名)
69 # %l 發(fā)生的位置，在某個(gè)類(lèi)的某行
70 # %m 輸出代碼中指定的訊息，如log(message)中的message
71 # %n 輸出一個(gè)換行
72
73 log4j.appender.appender1.layout.ConversionPattern=%r [%t] [%p] - %c -%l -%m%n
輸出結(jié)果：
控制臺(tái)代碼
74 0 [main] [DEBUG] - com.coderdream.log4j.HelloLog4j
75 -com.coderdream.log4j.HelloLog4j.main(HelloLog4j.java:16) -This is debug message.
76 31 [main] [INFO] - com.coderdream.log4j.HelloLog4j
77 -com.coderdream.log4j.HelloLog4j.main(HelloLog4j.java:18) -This is info message.
78 31 [main] [ERROR] - com.coderdream.log4j.HelloLog4j
79 -com.coderdream.log4j.HelloLog4j.main(HelloLog4j.java:20) -This is error message.
【示例6】 多目的地、自定義樣式
Properties代碼
80 #設(shè)置級(jí)別和目的地
81 log4j.rootLogger=debug,appender1,appender2
82
83 #輸出到控制臺(tái)
84 log4j.appender.appender1=org.apache.log4j.ConsoleAppender
85 #設(shè)置輸出樣式
86 log4j.appender.appender1.layout=org.apache.log4j.PatternLayout
87 #自定義樣式
88 # %r 時(shí)間 0
89 # %t 方法名 main
90 # %p 優(yōu)先級(jí) DEBUG/INFO/ERROR
91 # %c 所屬類(lèi)的全名(包括包名)
92 # %l 發(fā)生的位置，在某個(gè)類(lèi)的某行
93 # %m 輸出代碼中指定的訊息，如log(message)中的message
94 # %n 輸出一個(gè)換行符號(hào)
95 log4j.appender.appender1.layout.ConversionPattern=[%d{yy/MM/dd HH:mm:ss:SSS}][%C-%M] %m%n
96
97 #輸出到文件(這里默認(rèn)為追加方式)
98 log4j.appender.appender2=org.apache.log4j.FileAppender
99 #設(shè)置文件輸出路徑
100 #【1】文本文件
101 log4j.appender.appender2.File=c:/Log4JDemo06.log
102 #設(shè)置文件輸出樣式
103 log4j.appender.appender2.layout=org.apache.log4j.PatternLayout
104 log4j.appender.appender2.layout.ConversionPattern=[%d{HH:mm:ss:SSS}][%C-%M] -%m%n
【示例7】 【企業(yè)應(yīng)用】設(shè)置 特定包的級(jí)別和目的地
先增加一個(gè)包，新建一個(gè)類(lèi)：
Java代碼
105 package com.coderdream.log4jDao;
106
107 import org.apache.log4j.Logger;
108
109 public class HelloDao {
110 private static Logger logger = Logger.getLogger(HelloDao.class);
111
112 /**
113 * @param args
114 */
115 public static void main(String[] args) {
116 // 記錄debug級(jí)別的信息
117 logger.debug("This is debug message from Dao.");
118 // 記錄info級(jí)別的信息
119 logger.info("This is info message from Dao.");
120 // 記錄error級(jí)別的信息
121 logger.error("This is error message from Dao.");
122 }
123 }
如果這個(gè)類(lèi)作為基類(lèi)，如J2EE中的BaseDao、BaseAction、BaseService等等，則我們可以將各層的日志信息分類(lèi)輸出到各個(gè)文件。
Properties代碼
124 #省略根，只設(shè)置特定包的級(jí)別和目的地
125 log4j.logger.com.coderdream.log4j=debug,appender1
126 log4j.logger.com.coderdream.log4jDao=info,appender1,appender2
127
128 #輸出到控制臺(tái)
129 log4j.appender.appender1=org.apache.log4j.ConsoleAppender
130 #設(shè)置輸出樣式
131 log4j.appender.appender1.layout=org.apache.log4j.PatternLayout
132 #自定義樣式
133 # %r 時(shí)間 0
134 # %t 方法名 main
135 # %p 優(yōu)先級(jí) DEBUG/INFO/ERROR
136 # %c 所屬類(lèi)的全名(包括包名)
137 # %l 發(fā)生的位置，在某個(gè)類(lèi)的某行
138 # %m 輸出代碼中指定的訊息，如log(message)中的message
139 # %n 輸出一個(gè)換行符號(hào)
140 log4j.appender.appender1.layout.ConversionPattern=[%d{yy/MM/dd HH:mm:ss:SSS}][%C-%M] %m%n
141
142 #輸出到文件(這里默認(rèn)為追加方式)
143 log4j.appender.appender2=org.apache.log4j.FileAppender
144 #設(shè)置文件輸出路徑
145 #【1】文本文件
146 log4j.appender.appender2.File=c:/Log4JDemo07_Dao.log
147 #設(shè)置文件輸出樣式
148 log4j.appender.appender2.layout=org.apache.log4j.PatternLayout
149 log4j.appender.appender2.layout.ConversionPattern=[%d{HH:mm:ss:SSS}][%C-%M] -%m%n
【示例8】 log4j.xml的配置方式
Xml代碼
150 <?xml version="1.0" encoding="UTF-8"?>
151 <!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">
152
153 <log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/">
154
155 <appender name="appender1"
156 class="org.apache.log4j.RollingFileAppender">
157 <param name="File" value="logfile08.html" />
158 <param name="MaxFileSize" value="1MB" />
159 <param name="MaxBackupIndex" value="5" />
160 <layout class="org.apache.log4j.HTMLLayout">
161 </layout>
162 </appender>
163
164 <root>
165 <level value="debug" />
166 <appender-ref ref="appender1" />
167 </root>
168 </log4j:configuration>
為了提高效率，我們可以在寫(xiě)日志前增加判斷：
Java代碼
169 // 記錄debug級(jí)別的信息
170 if (logger.isDebugEnabled()) {
171 logger.debug("This is debug message from Dao.");
172 }
173
174 // 記錄info級(jí)別的信息
175 if (logger.isInfoEnabled()) {
176 logger.info("This is info message from Dao.");
177 }
178
179 // 記錄error級(jí)別的信息
180 logger.error("This is error message from Dao.");