隨筆檔案

Log4j有三個(gè)主要的組件：Loggers，Appenders和Layouts，這里可簡(jiǎn)單理解為日志類別，日志要輸出的地方和日志以何種形式輸出。綜合使用這三個(gè)組件可以輕松的記錄信息的類型和級(jí)別，并可以在運(yùn)行時(shí)控制日志輸出的樣式和位置。下面對(duì)三個(gè)組件分別進(jìn)行說(shuō)明：

1、 Loggers

??? Loggers組件在此系統(tǒng)中被分為五個(gè)級(jí)別：DEBUG、INFO、WARN、ERROR和FATAL。這五個(gè)級(jí)別是有順序的，DEBUG < INFO < WARN < ERROR < FATAL，明白這一點(diǎn)很重要，這里L(fēng)og4j有一個(gè)規(guī)則：假設(shè)Loggers級(jí)別為P，如果在Loggers中發(fā)生了一個(gè)級(jí)別Q比P高，則可以啟動(dòng)，否則屏蔽掉。

Java程序舉例來(lái)說(shuō)：

//建立Logger的一個(gè)實(shí)例，命名為“com.foo”

Logger? logger = Logger.getLogger("com.foo");

//設(shè)置logger的級(jí)別。通常不在程序中設(shè)置logger的級(jí)別。一般在配置文件中設(shè)置。

logger.setLevel(Level.INFO);

Logger barlogger = Logger.getLogger("com.foo.Bar");

//下面這個(gè)請(qǐng)求可用，因?yàn)閃ARN >= INFO

logger.warn("Low fuel level.");

//下面這個(gè)請(qǐng)求不可用，因?yàn)镈EBUG < INFO

logger.debug("Starting search for nearest gas station.");

//命名為“com.foo.bar”的實(shí)例barlogger會(huì)繼承實(shí)例“com.foo”的級(jí)別。因此，下面這個(gè)請(qǐng)求可用，因?yàn)镮NFO >= INFO

barlogger.info("Located nearest gas station.");

//下面這個(gè)請(qǐng)求不可用，因?yàn)镈EBUG < INFO

barlogger.debug("Exiting gas station search");?

這里“是否可用”的意思是能否輸出Logger信息。?

??? 在對(duì)Logger實(shí)例進(jìn)行命名時(shí)，沒(méi)有限制，可以取任意自己感興趣的名字。一般情況下建議以類的所在位置來(lái)命名Logger實(shí)例，這是目前來(lái)講比較有效的Logger命名方式。這樣可以使得每個(gè)類建立自己的日志信息，便于管理。比如：

static Logger logger = Logger.getLogger(ClientWithLog4j.class.getName());

2、 Appenders

??? 禁用與使用日志請(qǐng)求只是Log4j其中的一個(gè)小小的地方，Log4j日志系統(tǒng)允許把日志輸出到不同的地方，如控制臺(tái)（Console）、文件（Files）、根據(jù)天數(shù)或者文件大小產(chǎn)生新的文件、以流的形式發(fā)送到其它地方等等。

其語(yǔ)法表示為：

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ā)送到任意指定的地方）

配置時(shí)使用方式為：

log4j.appender.appenderName = fully.qualified.name.of.appender.class

log4j.appender.appenderName.option1 = value1

…

log4j.appender.appenderName.option = valueN

這樣就為日志的輸出提供了相當(dāng)大的便利。

3、 Layouts

??? 有時(shí)用戶希望根據(jù)自己的喜好格式化自己的日志輸出。Log4j可以在Appenders的后面附加Layouts來(lái)完成這個(gè)功能。Layouts提供了四種日志輸出樣式，如根據(jù)HTML樣式、自由指定樣式、包含日志級(jí)別與信息的樣式和包含日志時(shí)間、線程、類別等信息的樣式等等。

其語(yǔ)法表示為：

org.apache.log4j.HTMLLayout（以HTML表格形式布局），
org.apache.log4j.PatternLayout（可以靈活地指定布局模式），
org.apache.log4j.SimpleLayout（包含日志信息的級(jí)別和信息字符串），
org.apache.log4j.TTCCLayout（包含日志產(chǎn)生的時(shí)間、線程、類別等等信息）

配置時(shí)使用方式為：

???? log4j.appender.appenderName.layout =?????? fully.qualified.name.of.layout.class
?????log4j.appender.appenderName.layout.option1 = value1
???? …
???? log4j.appender.appenderName.layout.option = valueN
?
??? 以上是從原理方面說(shuō)明Log4j的使用方法，在具體Java編程使用Log4j可以參照以下示例：
1、 建立Logger實(shí)例：
??? 語(yǔ)法表示：public static Logger getLogger( String name)
??? 實(shí)際使用：static Logger logger = Logger.getLogger?? (ServerWithLog4j.class.getName ()) ;
2、 讀取配置文件：
??? 獲得了Logger的實(shí)例之后，接下來(lái)將配置Log4j使用環(huán)境：
??? 語(yǔ)法表示：
??? BasicConfigurator.configure()：自動(dòng)快速地使用缺省Log4j環(huán)境。
??? PropertyConfigurator.configure(String configFilename)：讀取使用Java的特性文件編寫的配置文件。
??? DOMConfigurator.configure(String filename)：讀取XML形式的配置文件。
??? 實(shí)際使用：PropertyConfigurator.configure("ServerWithLog4j.properties");
3、 插入日志信息
??? 完成了以上連個(gè)步驟以后，下面就可以按日志的不同級(jí)別插入到你要記錄日志的任何地方了。
??? 語(yǔ)法表示：
??? Logger.debug(Object message);
??? Logger.info(Object message);
??? Logger.warn(Object message);
??? Logger.error(Object message);
??? 實(shí)際使用：logger.info("ServerSocket before accept: " + server);
?
??? 在實(shí)際編程時(shí)，要使Log4j真正在系統(tǒng)中運(yùn)行事先還要對(duì)配置文件進(jìn)行定義。定義步驟就是對(duì)Logger、Appender及Layout的分別使用，具體如下：
1、 配置根Logger，其語(yǔ)法為：
??? log4j.rootLogger = [ level ] , appenderName, appenderName, …
這里level指Logger的優(yōu)先級(jí)，appenderName是日志信息的輸出地，可以同時(shí)指定多個(gè)輸出地。如：log4j.rootLogger= INFO,A1,A2
2、 配置日志信息輸出目的地，其語(yǔ)法為：
??? log4j.appender.appenderName = fully.qualified.name.of.appender.class
??? 可以指定上面所述五個(gè)目的地中的一個(gè)。
3、 配置日志信息的格式，其語(yǔ)法為：
??? log4j.appender.appenderName.layout = fully.qualified.name.of.layout.class
??? 這里上面三個(gè)步驟是對(duì)前面Log4j組件說(shuō)明的一個(gè)簡(jiǎn)化；下面給出一個(gè)具體配置例子，在程序中可以參照?qǐng)?zhí)行：
??? log4j.rootLogger=INFO,A1
??? 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
??? 這里需要說(shuō)明的就是日志信息格式中幾個(gè)符號(hào)所代表的含義：
??? －X號(hào): X信息輸出時(shí)左對(duì)齊；
??? %p: 日志信息級(jí)別
??? %d{}: 日志信息產(chǎn)生時(shí)間
??? %c: 日志信息所在地（類名）
??? %m: 產(chǎn)生的日志具體信息
??? %n: 輸出日志信息換行
?
根據(jù)上面的日志格式，某一個(gè)程序的輸出結(jié)果如下：
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