fun

圖文介紹log4j

log4j是一個非常強大的log記錄軟件，下面我們就來看看在項目中如何使log4j。

首先當然是得到log4j的jar檔，推薦使用1.2.X版，下載地址：

http://logging.apache.org/log4j/1.2/download.html

我們先看一個最簡單的示例：

【示例1】

項目結構：

【注：由于這里的多個項目公用一個jar檔，我們可以創建一個專門放置jar檔的Java工程，然后將jar檔放到lib目錄下。在要使用的工程中按圖所示進行引用 】

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級別的信息   
        logger.debug("This is debug message.");   
        // 記錄info級別的信息   
        logger.info("This is info message.");   
        // 記錄error級別的信息   
        logger.error("This is error message.");   
    }   
}  

配置文件log4j.properties:

Properties代碼

1. #可以設置級別：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. #輸出到控制臺   
10. log4j.appender.appender1=org.apache.log4j.ConsoleAppender   
11. #樣式為TTCCLayout   
12. log4j.appender.appender1.layout=org.apache.log4j.TTCCLayout  

#可以設置級別：debug>info>error
#debug：顯示debug、info、error
#info：顯示info、error
#error：只error
log4j.rootLogger=debug,appender1
#log4j.rootLogger=info,appender1
#log4j.rootLogger=error,appender1
#輸出到控制臺
log4j.appender.appender1=org.apache.log4j.ConsoleAppender
#樣式為TTCCLayout
log4j.appender.appender1.layout=org.apache.log4j.TTCCLayout

輸出結果：

Console代碼

1. [main] DEBUG com.coderdream.log4j.HelloLog4j - This is debug message.   
2. [main] INFO com.coderdream.log4j.HelloLog4j - This is info message.   
3. [main] ERROR com.coderdream.log4j.HelloLog4j - This is error message.  

[main] DEBUG com.coderdream.log4j.HelloLog4j - This is debug message.
[main] INFO com.coderdream.log4j.HelloLog4j - This is info message.
[main] ERROR com.coderdream.log4j.HelloLog4j - This is error message.

  通過配置文件可知，我們需要配置3個方面的內容：

1、根目錄（級別和目的地）；

2、目的地（控制臺、文件等等）；

3、輸出樣式。

下面我們來看看Log4J的類圖：

Logger - 日志寫出器，供程序員輸出日志信息
Appender - 日志目的地，把格式化好的日志信息輸出到指定的地方去
ConsoleAppender - 目的地為控制臺的Appender
FileAppender - 目的地為文件的Appender
RollingFileAppender - 目的地為大小受限的文件的Appender
Layout - 日志格式化器，用來把程序員的logging request格式化成字符串
PatternLayout - 用指定的pattern格式化logging request的Layout

Log4j基本使用方法

　　Log4j由三個重要的組件構成：日志信息的優先級，日志信息的輸出目的地，日志信息的輸出格式。日志信息的優先級從高到低有ERROR、WARN、 INFO、DEBUG，分別用來指定這條日志信息的重要程度；日志信息的輸出目的地指定了日志將打印到控制臺還是文件中；而輸出格式則控制了日志信息的顯示內容。

　　一、定義配置文件

　　其實您也可以完全不使用配置文件，而是在代碼中配置Log4j環境。但是，使用配置文件將使您的應用程序更加靈活。Log4j支持兩種配置文件格式，一種是XML格式的文件，一種是Java特性文件（鍵=值）。下面我們介紹使用Java特性文件做為配置文件的方法：

　　1.配置根Logger，其語法為：

　　log4j.rootLogger = [ level ] , appenderName, appenderName, …

　　其中，level 是日志記錄的優先級，分為OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者您定義的級別。Log4j建議只使用四個級別，優先級從高到低分別是ERROR、WARN、INFO、DEBUG。通過在這里定義的級別，您可以控制到應用程序中相應級別的日志信息的開關。比如在這里定義了INFO級別，則應用程序中所有DEBUG級別的日志信息將不被打印出來。 appenderName就是指B日志信息輸出到哪個地方。您可以同時指定多個輸出目的地。

　　2.配置日志信息輸出目的地Appender，其語法為：

　　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（控制臺），
　　org.apache.log4j.FileAppender（文件），
　　org.apache.log4j.DailyRollingFileAppender（每天產生一個日志文件），
　　org.apache.log4j.RollingFileAppender（文件大小到達指定尺寸的時候產生一個新的文件），
　　org.apache.log4j.WriterAppender（將日志信息以流格式發送到任意指定的地方）

　　3.配置日志信息的格式（布局），其語法為：

　　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（包含日志信息的級別和信息字符串），
　　org.apache.log4j.TTCCLayout（包含日志產生的時間、線程、類別等等信息）

　　Log4J采用類似C語言中的printf函數的打印格式格式化日志信息，打印參數如下： %m 輸出代碼中指定的消息

　　%p 輸出優先級，即DEBUG，INFO，WARN，ERROR，FATAL
　　%r 輸出自應用啟動到輸出該log信息耗費的毫秒數
　　%c 輸出所屬的類目，通常就是所在類的全名
　　%t 輸出產生該日志事件的線程名
　　%n 輸出一個回車換行符，Windows平臺為“rn”，Unix平臺為“n”
　　%d 輸出日志時間點的日期或時間，默認格式為ISO8601，也可以在其后指定格式，比如：%d{yyy MMM dd HH:mm:ss,SSS}，輸出類似：2002年10月18日 22：10：28，921
　　%l 輸出日志事件的發生位置，包括類目名、發生的線程，以及在代碼中的行數。舉例：Testlog4.main(TestLog4.java:10)

　　二、在代碼中使用Log4j

　　1.得到記錄器

　　使用Log4j，第一步就是獲取日志記錄器，這個記錄器將負責控制日志信息。其語法為：

　　public static Logger getLogger( String name)

　　通過指定的名字獲得記錄器，如果必要的話，則為這個名字創建一個新的記錄器。Name一般取本類的名字，比如：

　　static Logger logger = Logger.getLogger ( ServerWithLog4j.class.getName () )

　　2.讀取配置文件

　　當獲得了日志記錄器之后，第二步將配置Log4j環境，其語法為：

　　BasicConfigurator.configure ()： 自動快速地使用缺省Log4j環境。
　　PropertyConfigurator.configure ( String configFilename) ：讀取使用Java的特性文件編寫的配置文件。
　　DOMConfigurator.configure ( String filename ) ：讀取XML形式的配置文件。

　　3.插入記錄信息（格式化日志信息）

　　當上兩個必要步驟執行完畢，您就可以輕松地使用不同優先級別的日志記錄語句插入到您想記錄日志的任何地方，其語法如下：

　　Logger.debug ( Object message ) ;
　　Logger.info ( Object message ) ;
　　Logger.warn ( Object message ) ;
　　Logger.error ( Object message ) ;

示例2～示例8

【示例2】 輸出為文本文件或HTML文件

Porperties代碼

1. #設置級別：   
2. log4j.rootLogger=debug,appender1   
3.   
4. #輸出到文件(這里默認為追加方式)   
5. log4j.appender.appender1=org.apache.log4j.FileAppender   
6. #設置文件輸出路徑   
7. #【1】文本文件   
8. #log4j.appender.appender1.File=c:/Log4JDemo02.log   
9. #【2】HTML文件   
10. log4j.appender.appender1.File=c:/Log4JDemo02.html   
11. #設置文件輸出樣式   
12. #log4j.appender.appender1.layout=org.apache.log4j.TTCCLayout   
13. log4j.appender.appender1.layout=org.apache.log4j.HTMLLayout  

#設置級別：
log4j.rootLogger=debug,appender1
#輸出到文件(這里默認為追加方式)
log4j.appender.appender1=org.apache.log4j.FileAppender
#設置文件輸出路徑
#【1】文本文件
#log4j.appender.appender1.File=http://www.bt285.cn/content.php?id=274912 :/Log4JDemo02.log
#【2】HTML文件
log4j.appender.appender1.File=http://www.bt285.cn/content.php?id=1196863 :/Log4JDemo02.html
#設置文件輸出樣式
#log4j.appender.appender1.layout=org.apache.log4j.TTCCLayout
log4j.appender.appender1.layout=org.apache.log4j.HTMLLayout

【 示例3】 輸出為文本文件或HTML文件

Properties代碼

1. #設置級別和多個目的地   
2. log4j.rootLogger=debug,appender1,appender2   
3.   
4. #輸出到控制臺   
5. log4j.appender.appender1=org.apache.log4j.ConsoleAppender   
6. #設置輸出樣式   
7. log4j.appender.appender1.layout=org.apache.log4j.TTCCLayout   
8.   
9. #輸出到文件(這里默認為追加方式)   
10. log4j.appender.appender2=org.apache.log4j.FileAppender   
11. #設置文件輸出路徑   
12. #【1】文本文件   
13. #log4j.appender.appender2.File=c:/Log4JDemo02.log   
14. #【2】HTML文件   
15. log4j.appender.appender2.File=c:/Log4JDemo02.html   
16. #設置文件輸出樣式   
17. #log4j.appender.appender2.layout=org.apache.log4j.TTCCLayout   
18. log4j.appender.appender2.layout=org.apache.log4j.HTMLLayout  

#設置級別和多個目的地
log4j.rootLogger=debug,appender1,appender2
#輸出到控制臺
log4j.appender.appender1=org.apache.log4j.ConsoleAppender
#設置輸出樣式
log4j.appender.appender1.layout=org.apache.log4j.TTCCLayout
#輸出到文件(這里默認為追加方式)
log4j.appender.appender2=org.apache.log4j.FileAppender
#設置文件輸出路徑
#【1】文本文件
#log4j.appender.appender2.File=c:/Log4JDemo02.log
#【2】HTML文件
log4j.appender.appender2.File=c:/Log4JDemo02.html
#設置文件輸出樣式
#log4j.appender.appender2.layout=org.apache.log4j.TTCCLayout
log4j.appender.appender2.layout=org.apache.log4j.HTMLLayout

【示例4】 SimpleLayout樣式

Properties代碼

1. #設置級別和目的地   
2. log4j.rootLogger=debug,appender1   
3.   
4. #輸出到控制臺   
5. log4j.appender.appender1=org.apache.log4j.ConsoleAppender   
6. #設置輸出樣式   
7. log4j.appender.appender1.layout=org.apache.log4j.SimpleLayout  

#設置級別和目的地
log4j.rootLogger=debug,appender1
#輸出到控制臺
log4j.appender.appender1=org.apache.log4j.ConsoleAppender
#設置輸出樣式
log4j.appender.appender1.layout=org.apache.log4j.SimpleLayout

  輸出結果：

控制臺代碼

1. DEBUG - This is debug message.   
2. INFO - This is info message.   
3. ERROR - This is error message.  

DEBUG - This is debug message.
INFO - This is info message.
ERROR - This is error message.

【示例5】 自定義樣式

Java代碼

1. #設置級別和目的地   
2. log4j.rootLogger=debug,appender1   
3.   
4. #輸出到控制臺   
5. log4j.appender.appender1=org.apache.log4j.ConsoleAppender   
6. #設置輸出樣式   
7. log4j.appender.appender1.layout=org.apache.log4j.PatternLayout   
8. #自定義樣式   
9. # %r 時間 0  
10. # %t 方法名 main   
11. # %p 優先級 DEBUG/INFO/ERROR   
12. # %c 所屬類的全名(包括包名)   
13. # %l 發生的位置，在某個類的某行   
14. # %m 輸出代碼中指定的訊息，如log(message)中的message   
15. # %n 輸出一個換行   
16.   
17. log4j.appender.appender1.layout.ConversionPattern=%r [%t] [%p] - %c -%l -%m%n  

#設置級別和目的地
log4j.rootLogger=debug,appender1
#輸出到控制臺
log4j.appender.appender1=org.apache.log4j.ConsoleAppender
#設置輸出樣式
log4j.appender.appender1.layout=org.apache.log4j.PatternLayout
#自定義樣式
# %r 時間 0
# %t 方法名 main
# %p 優先級 DEBUG/INFO/ERROR
# %c 所屬類的全名(包括包名)
# %l 發生的位置，在某個類的某行
# %m 輸出代碼中指定的訊息，如log(message)中的message
# %n 輸出一個換行
log4j.appender.appender1.layout.ConversionPattern=%r [%t] [%p] - %c -%l -%m%n

輸出結果：

控制臺代碼

1. 0 [main] [DEBUG] - com.coderdream.log4j.HelloLog4j    
2. -com.coderdream.log4j.HelloLog4j.main(HelloLog4j.java:16) -This is debug message.   
3. 31 [main] [INFO] - com.coderdream.log4j.HelloLog4j    
4. -com.coderdream.log4j.HelloLog4j.main(HelloLog4j.java:18) -This is info message.   
5. 31 [main] [ERROR] - com.coderdream.log4j.HelloLog4j    
6. -com.coderdream.log4j.HelloLog4j.main(HelloLog4j.java:20) -This is error message.  

0 [main] [DEBUG] - com.coderdream.log4j.HelloLog4j
-com.coderdream.log4j.HelloLog4j.main(HelloLog4j.java:16) -This is debug message.
31 [main] [INFO] - com.coderdream.log4j.HelloLog4j
-com.coderdream.log4j.HelloLog4j.main(HelloLog4j.java:18) -This is info message.
31 [main] [ERROR] - com.coderdream.log4j.HelloLog4j
-com.coderdream.log4j.HelloLog4j.main(HelloLog4j.java:20) -This is error message.

【示例6】 多目的地、自定義樣式

Properties代碼

1. #設置級別和目的地   
2. log4j.rootLogger=debug,appender1,appender2   
3.   
4. #輸出到控制臺   
5. log4j.appender.appender1=org.apache.log4j.ConsoleAppender   
6. #設置輸出樣式   
7. log4j.appender.appender1.layout=org.apache.log4j.PatternLayout   
8. #自定義樣式   
9. # %r 時間 0  
10. # %t 方法名 main   
11. # %p 優先級 DEBUG/INFO/ERROR   
12. # %c 所屬類的全名(包括包名)   
13. # %l 發生的位置，在某個類的某行   
14. # %m 輸出代碼中指定的訊息，如log(message)中的message   
15. # %n 輸出一個換行符號   
16. log4j.appender.appender1.layout.ConversionPattern=[%d{yy/MM/dd HH:mm:ss:SSS}][%C-%M] %m%n   
17.   
18. #輸出到文件(這里默認為追加方式)   
19. log4j.appender.appender2=org.apache.log4j.FileAppender   
20. #設置文件輸出路徑   
21. #【1】文本文件   
22. log4j.appender.appender2.File=c:/Log4JDemo06.log   
23. #設置文件輸出樣式   
24. log4j.appender.appender2.layout=org.apache.log4j.PatternLayout   
25. log4j.appender.appender2.layout.ConversionPattern=[%d{HH:mm:ss:SSS}][%C-%M] -%m%n  

#設置級別和目的地
log4j.rootLogger=debug,appender1,appender2
#輸出到控制臺
log4j.appender.appender1=org.apache.log4j.ConsoleAppender
#設置輸出樣式
log4j.appender.appender1.layout=org.apache.log4j.PatternLayout
#自定義樣式
# %r 時間 0
# %t 方法名 main
# %p 優先級 DEBUG/INFO/ERROR
# %c 所屬類的全名(包括包名)
# %l 發生的位置，在某個類的某行
# %m 輸出代碼中指定的訊息，如log(message)中的message
# %n 輸出一個換行符號
log4j.appender.appender1.layout.ConversionPattern=[%d{yy/MM/dd HH:mm:ss:SSS}][%C-%M] %m%n
#輸出到文件(這里默認為追加方式)
log4j.appender.appender2=org.apache.log4j.FileAppender
#設置文件輸出路徑
#【1】文本文件
log4j.appender.appender2.File=c:/Log4JDemo06.log
#設置文件輸出樣式
log4j.appender.appender2.layout=org.apache.log4j.PatternLayout
log4j.appender.appender2.layout.ConversionPattern=[%d{HH:mm:ss:SSS}][%C-%M] -%m%n

【示例7】 【企業應用】設置 特定包的級別和目的地

先增加一個包，新建一個類：

Java代碼

1. package com.coderdream.log4jDao;   
2.   
3. import org.apache.log4j.Logger;   
4.   
5. public class HelloDao {   
6.     private static Logger logger = Logger.getLogger(HelloDao.class);   
7.   
8.     /**  
9.      * @param args  
10.      */  
11.     public static void main(String[] args) {   
12.         // 記錄debug級別的信息   
13.         logger.debug("This is debug message from Dao.");   
14.         // 記錄info級別的信息   
15.         logger.info("This is info message from Dao.");   
16.         // 記錄error級別的信息   
17.         logger.error("This is error message from Dao.");   
18.     }   
19. }  

package com.coderdream.log4jDao;
import org.apache.log4j.Logger;
public class HelloDao {
private static Logger logger = Logger.getLogger(HelloDao.class);
/**
* @param args
*/
public static void main(String[] args) {
// 記錄debug級別的信息
logger.debug("This is debug message from Dao.");
// 記錄info級別的信息
logger.info("This is info message from Dao.");
// 記錄error級別的信息
logger.error("This is error message from Dao.");
}
}

      如果這個類作為基類，如J2EE中的BaseDao、BaseAction、BaseService等等，則我們可以將各層的日志信息分類輸出到各個文件。

Properties代碼

1. #省略根，只設置特定包的級別和目的地   
2. log4j.logger.com.coderdream.log4j=debug,appender1   
3. log4j.logger.com.coderdream.log4jDao=info,appender1,appender2   
4.   
5. #輸出到控制臺   
6. log4j.appender.appender1=org.apache.log4j.ConsoleAppender   
7. #設置輸出樣式   
8. log4j.appender.appender1.layout=org.apache.log4j.PatternLayout   
9. #自定義樣式   
10. # %r 時間 0  
11. # %t 方法名 main   
12. # %p 優先級 DEBUG/INFO/ERROR   
13. # %c 所屬類的全名(包括包名)   
14. # %l 發生的位置，在某個類的某行   
15. # %m 輸出代碼中指定的訊息，如log(message)中的message   
16. # %n 輸出一個換行符號   
17. log4j.appender.appender1.layout.ConversionPattern=[%d{yy/MM/dd HH:mm:ss:SSS}][%C-%M] %m%n   
18.   
19. #輸出到文件(這里默認為追加方式)   
20. log4j.appender.appender2=org.apache.log4j.FileAppender   
21. #設置文件輸出路徑   
22. #【1】文本文件   
23. log4j.appender.appender2.File=c:/Log4JDemo07_Dao.log   
24. #設置文件輸出樣式   
25. log4j.appender.appender2.layout=org.apache.log4j.PatternLayout   
26. log4j.appender.appender2.layout.ConversionPattern=[%d{HH:mm:ss:SSS}][%C-%M] -%m%n  

#省略根，只設置特定包的級別和目的地
log4j.logger.com.coderdream.log4j=debug,appender1
log4j.logger.com.coderdream.log4jDao=info,appender1,appender2
#輸出到控制臺
log4j.appender.appender1=org.apache.log4j.ConsoleAppender
#設置輸出樣式
log4j.appender.appender1.layout=org.apache.log4j.PatternLayout
#自定義樣式
# %r 時間 0
# %t 方法名 main
# %p 優先級 DEBUG/INFO/ERROR
# %c 所屬類的全名(包括包名)
# %l 發生的位置，在某個類的某行
# %m 輸出代碼中指定的訊息，如log(message)中的message
# %n 輸出一個換行符號
log4j.appender.appender1.layout.ConversionPattern=[%d{yy/MM/dd HH:mm:ss:SSS}][%C-%M] %m%n
#輸出到文件(這里默認為追加方式)
log4j.appender.appender2=org.apache.log4j.FileAppender
#設置文件輸出路徑
#【1】文本文件
log4j.appender.appender2.File=c:/Log4JDemo07_Dao.log
#設置文件輸出樣式
log4j.appender.appender2.layout=org.apache.log4j.PatternLayout
log4j.appender.appender2.layout.ConversionPattern=[%d{HH:mm:ss:SSS}][%C-%M] -%m%n

【示例8】 log4j.xml的配置方式

Xml代碼

1. <?xml version="1.0" encoding="UTF-8"?>  
2. <!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">  
3.   
4. <log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/">  
5.   
6.     <appender name="appender1"  
7.         class="org.apache.log4j.RollingFileAppender">  
8.         <param name="File" value="logfile08.html" />  
9.         <param name="MaxFileSize" value="1MB" />  
10.         <param name="MaxBackupIndex" value="5" />  
11.         <layout class="org.apache.log4j.HTMLLayout">  
12.         </layout>  
13.     </appender>  
14.   
15.     <root>  
16.         <level value="debug" />  
17.         <appender-ref ref="appender1" />  
18.     </root>  
19. </log4j:configuration>  

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">
<log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/">
<appender name="appender1"
class="org.apache.log4j.RollingFileAppender">
<param name="File" value="logfile08.html" />
<param name="MaxFileSize" value="1MB" />
<param name="MaxBackupIndex" value="5" />
<layout class="org.apache.log4j.HTMLLayout">
</layout>
</appender>
<root>
<level value="debug" />
<appender-ref ref="appender1" />
</root>
</log4j:configuration>

為了提高效率，我們可以在寫日志前增加判斷：

Java代碼

1. // 記錄debug級別的信息   
2. if (logger.isDebugEnabled()) {   
3.     logger.debug("This is debug message from Dao.");   
4. }   
5.   
6. // 記錄info級別的信息   
7. if (logger.isInfoEnabled()) {   
8.     logger.info("This is info message from Dao.");   
9. }   
10.   
11. // 記錄error級別的信息   
12. logger.error("This is error message from Dao.");  

posted on 2009-05-06 12:42 fun 閱讀(1965) 評論(0)  編輯  收藏