Log4j有三個主要的組件:Loggers,Appenders和Layouts,這裡可簡單理解為日志類別,日志要輸出的地方和日志以何種形式輸出。綜合使用這三個組件可以輕松的記錄信息的類型和級別,並可以在運行時控制日志輸出的樣式和位置。下面對三個組件分別進行說明:
1、 Loggers
Loggers組件在此系統中被分為五個級別:DEBUG、INFO、WARN、ERROR和FATAL。這五個級別是有順序的,DEBUG < INFO < WARN < ERROR < FATAL,明白這一點很重要,這裡Log4j有一個規則:假設Loggers級別為P,如果在Loggers中發生了一個級別Q比P高,則可以啟動,否則屏蔽掉。
Java程序舉例來說:
//建立Logger的一個實例,命名為“com.foo”
Logger logger = Logger.getLogger("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)、根據天數或者文件大小產生新的文件、以流的形式發送到其它地方等等。
其語法表示為:
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.option = 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.option = valueN
以上是從原理方面說明Log4j的使用方法,在具體Java編程使用Log4j可以參照以下示例:
1、 建立Logger實例:
語法表示:public static Logger getLogger( String name)
實際使用:static Logger logger = Logger.getLogger (ServerWithLog4j.class.getName ()) ;
2、 讀取配置文件:
獲得了Logger的實例之後,接下來將配置Log4j使用環境:
語法表示:
BasicConfigurator.configure():自動快速地使用缺省Log4j環境。
PropertyConfigurator.configure(String configFilename):讀取使用Java的特性文件編寫的配置文件。
DOMConfigurator.configure(String filename):讀取XML形式的配置文件。
實際使用:PropertyConfigurator.configure("ServerWithLog4j.propertIEs");
3、 插入日志信息
完成了以上連個步驟以後,下面就可以按日志的不同級別插入到你要記錄日志的任何地方了。
語法表示:
Logger.debug(Object message);
Logger.info(Object message);
Logger.warn(Object message);
Logger.error(Object message);
實際使用:logger.info("ServerSocket before accept: " + server);
在實際編程時,要使Log4j真正在系統中運行事先還要對配置文件進行定義。定義步驟就是對Logger、Appender及Layout的分別使用,具體如下:
1、 配置根Logger,其語法為:
log4j.rootLogger = [ level ] , appenderName, appenderName, …
這裡level指Logger的優先級,appenderName是日志信息的輸出地,可以同時指定多個輸出地。如:log4j.rootLogger= INFO,A1,A2
2、 配置日志信息輸出目的地,其語法為:
log4j.appender.appenderName = fully.qualifIEd.name.of.appender.class
可以指定上面所述五個目的地中的一個。
3、 配置日志信息的格式,其語法為:
log4j.appender.appenderName.layout = fully.qualifIEd.name.of.layout.class
這裡上面三個步驟是對前面Log4j組件說明的一個簡化;下面給出一個具體配置例子,在程序中可以參照執行:
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
這裡需要說明的就是日志信息格式中幾個符號所代表的含義:
-X號: X信息輸出時左對齊;
%p: 日志信息級別
%d{}: 日志信息產生時間
%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