淺談Log4j的使用方法-Log4j的使用心得。

                              org.apache.log4j.Logger 詳解

1. 概述

1.1. 背景    
  在應用程序中添加日誌記錄總的來說基於三個目的 :監視代碼中變量的變化情況,週期性的記錄到文件中供其他應用進行統計分析工作;跟蹤代碼運行時軌跡,作爲日後審計的依據;擔當集成開發環境中的調試器的作用,向文件或控制檯打印代碼的調試信息。   
  最普通的做法就是在代碼中嵌入許多的打印語句,這些打印語句可以輸出到控制檯或文件中,比較好的做法就是構造一個日誌操作類 來封裝此類操作,而不是讓一系列的打印語句充斥了代碼的主體。

http://logging.apache.org/log4j/ 官網地址

1.2. Log4j 簡介

        在強調可重用組件開發的今天,除了自己從頭到尾開發一個可重用的日誌操作類外, Apache 爲我們提供了一個強有力的日誌操作包 -Log4j 。   
   Log4j 是 Apache 的一個開放源代碼項目,通過使用 Log4j ,我們可以控制日誌信息輸送的目的地是控制檯、文件、 GUI 組件、甚至是套接口服 務器、 NT 的事件記錄器、 UNIX Syslog 守護進程等;我們也可以控制每一條日誌的輸出格式;通過定義每一條日誌信息的級別,我們能夠更加細緻地控制日誌的生成過程。最令人感興趣的就是,這些可以通過一個配置文件來靈活地進行配置,而不需要修改應用的代碼。   
  此外,通過 Log4j 其他語言接口,您可以在 C 、 C+ + 、 .Net 、 PL/SQL 程序中使用 Log4j ,其語法和用法與在 Java 程序中一樣,使得多語言分佈式系統得到一個統一一致的日誌組件模塊。而且,通 過使用各種第三方擴展,您可以很方便地將 Log4j 集成到 J2EE 、 JINI 甚至是 SNMP 應用中。

2. 一個簡單的實例

  項目結構:

 


Java 代碼:

  1. package com.coderdream.log4j;  
  2. import org.apache.log4j.Logger;  
  3.   public class HelloLog4j {  
  4.         private static Logger logger = Logger.getLogger(HelloLog4j.class);  
  5.       public static void main(String[] args) {  
  6.        //  記錄 debug 級別的信息   
  7.         logger.debug("This is debug message.");  
  8.         //  記錄 info 級別的信息   
  9.         logger.info("This is info message.");  
  10.         //  記錄 error 級別的信息   
  11.         logger.error("This is error message.");  
  12.     }  
  13. }  

配置文件 log4j.properties:

Properties 代碼

# 可以設置級別: 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 代碼

[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 - 日誌目的地 ,把格式化好的日誌信息輸出到指定的地方去 
Layout - 日誌格式化器 ,用來把程序員的 logging request 格式化成字符串


2 . Log4j 基本使用方法 

   Log4j 由三個重要的組件構成:日誌信息的優先級,日誌信息的輸出目的地,日誌信息的輸出格式 。日誌信息的優先級從高到低有 ERROR 、 WARN 、 INFO 、 DEBUG ,分別用來指定這條日誌信息的重要程度;日誌信息的輸出目的地指定了日誌將打印到控制檯還是文件中;而輸出格式則控制了日誌信息的顯示內容。 
    1 、定義配置文件 
      其實您也可以完全不使用配置文件,而是在代碼中配置 Log4j 環境。但是,使用配置文件將使您的應用程序更加靈活。 Log4j 支持兩種配置文件格式,一種是 XML 格式的文件,一種是 Java 特性文件(鍵 = 值 properties 文件)。下面我們介紹使用 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 有以下幾種: 
          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 (將日誌信息以流格式發送到任意指定的地方)


  3) . 配置日誌信息的格式(佈局),其語法爲: 
   log4j.appender.appenderName.layout = fully.qualified.name.of.layout.class
  其中, Log4j 提供的 layout 有以 e 幾種: 
          1.org.apache.log4j.HTMLLayout (以 HTML 表格形式佈局), 
          2.org.apache.log4j.PatternLayout (可以靈活地指定佈局模式), 
          3.org.apache.log4j.SimpleLayout (包含日誌信息的級別和信息字符串), 
          4.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)


2. 在代碼中使用 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 ) ; 
 

3. 示例 2 ~示例 8

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

Porperties 代碼

  1. # 設置級別:   
  2. log4j.rootLogger=debug,appender1    
  3. log4j.appender.appender1=org.apache.log4j.FileAppender  
  4. # 設置文件輸出路徑   
  5. log4j.appender.appender1.File=c:/Log4JDemo02.html  
  6. # 設置文件輸出樣式   
  7. log4j.appender.appender1.layout=org.apac he.log4j.HTMLLayout  

 

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

Properties 代碼

  1. 設置級別和多個目的地   
  2. log4j.rootLogger=debug,appender1,appender2    
  3. # 輸出到控制檯   
  4. log4j.appender.appender1=org.apache.log4j.ConsoleAppender  
  5. log4j.appender.appender1.layout=org.apache.log4j.TTCCLayout    
  6. # 輸出到文件 ( 這裏默認爲追加方式 )  
  7. log4j.appender.appender2=org.apache.log4j.FileAppender  
  8. log4j.appender.appender2.File=c:/Log4JDemo02.html  
  9. log4j.appender.appender2.layout=org.apache.log4j.HTMLLayout  

 

 

【 示例 4 】 SimpleLayout 樣式

Properties 代碼

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

控制檯代碼

               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. log4j.appender.appender1=org.apache.log4j.ConsoleAppender  
  5. # 設置輸出樣式   
  6. log4j.appender.appender1.layout=org.apache.log4j.PatternLayout  
  7. # 自定義樣式   
  8. log4j.appender.appender1.layout.ConversionPattern =%r [%t] [%p] - %c -%l -%m%n  

# 自定義樣式

# %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 輸出結果:

控制檯代碼

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. log4j.appender.appender1=org.apache.log4j.ConsoleAppender  
  5. # 設置輸出樣式   
  6. log4j.appender.appender1.layout=org.apache.log4j.PatternLayout  
  7. log4j.appender.appender1.layout.ConversionPattern=[%d{yy/MM/dd HH:mm:ss:SSS}][%C-%M] %m%n  
  8. # 輸出到文件 ( 這裏默認爲追加方式 )  
  9. log4j.appender.appender2=org.apache.log4j.FileAppender  
  10. # 設置文件輸出路徑   
  11. log4j.appender.appender2.File=c:/Log4JDemo06.log  
  12. # 設置文件輸出樣式   
  13. log4j.appender.appender2.layout=org.apache.log4j.PatternLayout  
  14. log4j.appender.appender2.layout.ConversionPattern=[%d{HH:mm:ss:SSS}][%C-%M] -%m%n  

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

先增加一個包,新建一個類:

Java 代碼

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

      如果這個類作爲基類,如 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. log4j.appender.appender1=org.apache.log4j.ConsoleAppender  
  6. log4j.appender.appender1.layout=org.apache.log4j.PatternLayout  
  7. log4j.appender.appender1.layout.ConversionPattern =[%d{yy/MM/dd HH:mm:ss:SSS}][%C-%M] %m%n  
  8. # 輸出到文件 ( 這裏默認爲追加方式 )  
  9. log4j.appender.appender2=org.apache.log4j.FileAppender  
  10. log4j.appender.appender2.File=c:/Log4JDemo07_Dao.log  
  11.  log4j.appender.appender2.layout=org.apache.log4j.PatternLayout  
  12. 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. <log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/">    
  4.     <appender name="appender1"  
  5.         class="org.apache.log4j.RollingFileAppender">  
  6.         <param name="File" value="logfile08.html" />  
  7.         <param name="MaxFileSize" value="1MB" />  
  8.         <param name="MaxBackupIndex" value="5" />  
  9.         <layout class="org.apache.log4j.HTMLLayout">  
  10.         </layout>  
  11.     </appender>    
  12.     <root>  
  13.         <level value="debug" />  
  14.         <appender-ref ref="appender1" />  
  15.     </root>  
  16. </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. //  記錄 info 級別的信息   
  6. if (logger.isInfoEnabled ()) {  
  7.     logger.info("This is info message from Dao.");  
  8. }    
  9. //  記錄 error 級別的信息   
  10. logger.error("This is error message from Dao.");  

 

 

另附一些詳細東西:

1.java 中的應用

             Logger.debug(Object message);// 調試信息 
        Logger.info(Object message);// 一般信息 
        Logger.warn(Object message);// 警告信息 
        Logger.error(Object message);// 錯誤信息 
        Logger.fatal(Object message);// 致命錯誤信息

2 、配置根 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    
  3 、配置日誌信息輸出目的地,其語法爲: 
     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

         log4j.appender.A1.layout.ConversionPattern=%-4r %-5p %d{yyyy-MM-dd HH:mm:ssS} %c %m%n
           這裏需要說明的就是日誌信息格式中幾個符號所代表的含義: 
            - 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 組件說明的一個簡化;下面給出一個具體配置例子,在程序中可以參照執行: 
   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
      
      4. # 當輸出信息於回滾文件時

          log4j.appender.ROLLING_FILE=org.apache.log4j.RollingFileAppender   // 指定以文件的方式輸出日誌 
           log4j.appender.ROLLING_FILE.Threshold=ERROR 
           log4j.appender.ROLLING_FILE.File=rolling.log  // 文件位置 , 也可以用變量 ${java.home} 、 rolling.log
           log4j.appender.ROLLING_FILE.Append=true 
           log4j.appender.ROLLING_FILE.MaxFileSize=10KB  // 文件最大尺寸 
           log4j.appender.ROLLING_FILE.MaxBackupIndex=1  // 備份數 
           log4j.appender.ROLLING_FILE.layout=org.apache.log4j.PatternLayout 
           log4j.appender.ROLLING_FILE.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n    

 

  5. Log4j 比較全面的配置

 LOG4J 的配置之簡單使它遍及於越來越多的應用中了: Log4J 配置文件實現了輸出到控制檯、文件、回滾文件、發送日誌郵件、輸出到數據庫日誌表、自定義標籤等全套功能。擇其一二使用就夠用了,

 log4j.rootLogger=DEBUG,CONSOLE,A1,im 
 log4j.addivity.org.apache=true

 # 應用於控制檯

 log4j.appender.CONSOLE=org.apache.log4j.ConsoleAppender 
 log4j.appender.Threshold=DEBUG 
 log4j.appender.CONSOLE.Target=System.out 
 log4j.appender.CONSOLE.layout=org.apache.log4j.PatternLayout 
 log4j.appender.CONSOLE.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n 
 #log4j.appender.CONSOLE.layout.ConversionPattern=[start]%d{DATE}[DATE]%n%p[PRIORITY]%n%x[NDC]%n%t[THREAD] n%c[CATEGORY]%n%m[MESSAGE]%n%n

 # 應用於文件

 log4j.appender.FILE=org.apache.log4j.FileAppender 
 log4j.appender.FILE.File=file.log 
 log4j.appender.FILE.Append=false 
 log4j.appender.FILE.layout=org.apache.log4j.PatternLayout 
 log4j.appender.FILE.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n 
 # Use this layout for LogFactor 5 analysis

 # 應用於文件回滾

 log4j.appender.ROLLING_FILE=org.apache.log4j.RollingFileAppender 
 log4j.appender.ROLLING_FILE.Threshold=ERROR 
 log4j.appender.ROLLING_FILE.File=rolling.log  // 文件位置 , 也可以用變量 ${java.home} 、 rolling.log
 log4j.appender.ROLLING_FILE.Append=true       //true: 添加   false: 覆蓋 
 log4j.appender.ROLLING_FILE.MaxFileSize=10KB   // 文件最大尺寸 
 log4j.appender.ROLLING_FILE.MaxBackupIndex=1  // 備份數 
 log4j.appender.ROLLING_FILE.layout=org.apache.log4j.PatternLayout 
 log4j.appender.ROLLING_FILE.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n
 # 應用於 socket 
 log4j.appender.SOCKET=org.apache.log4j.RollingFileAppender 
 log4j.appender.SOCKET.RemoteHost=localhost 
 log4j.appender.SOCKET.Port=5001 
 log4j.appender.SOCKET.LocationInfo=true 
 # Set up for Log Facter 5 
 log4j.appender.SOCKET.layout=org.apache.log4j.PatternLayout 
 log4j.appender.SOCET.layout.ConversionPattern=[start]%d{DATE}[DATE]%n%p[PRIORITY]%n%x[NDC]%n%t[THREAD]%n%c[CATEGORY]%n%m[MESSAGE]%n%n 
 # Log Factor 5 Appender 
 log4j.appender.LF5_APPENDER=org.apache.log4j.lf5.LF5Appender 
 log4j.appender.LF5_APPENDER.MaxNumberOfRecords=2000

 # 發送日誌給郵件

 log4j.appender.MAIL=org.apache.log4j.net.SMTPAppender 
 log4j.appender.MAIL.Threshold=FATAL 
 log4j.appender.MAIL.BufferSize=10 
 www.wuset.com ">log4j.appender.MAIL.From=web@www.wuset.com 
 log4j.appender.MAIL.SMTPHost=www.wusetu.com 
 log4j.appender.MAIL.Subject=Log4J Message 
 www.wusetu.com ">log4j.appender.MAIL.To=web@www.wusetu.com 
 log4j.appender.MAIL.layout=org.apache.log4j.PatternLayout 
 log4j.appender.MAIL.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n

 # 用於數據庫 
 log4j.appender.DATABASE=org.apache.log4j.jdbc.JDBCAppender 
 log4j.appender.DATABASE.URL=jdbc:mysql://localhost:3306/test 
 log4j.appender.DATABASE.driver=com.mysql.jdbc.Driver 
 log4j.appender.DATABASE.user=root 
 log4j.appender.DATABASE.password= 
 log4j.appender.DATABASE.sql=INSERT INTO LOG4J (Message) VALUES ('[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n') 
 log4j.appender.DATABASE.layout=org.apache.log4j.PatternLayout 
 log4j.appender.DATABASE.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n


 log4j.appender.A1=org.apache.log4j.DailyRollingFileAppender 
 log4j.appender.A1.File=SampleMessages.log4j 
 log4j.appender.A1.DatePattern=yyyyMMdd-HH'.log4j' 
 log4j.appender.A1.layout=org.apache.log4j.xml.XMLLayout

 # 自定義 Appender

 log4j.appender.im = net.cybercorlin.util.logger.appender.IMAppender

 log4j.appender.im.host = mail.cybercorlin.net 
 log4j.appender.im.username = username 
 log4j.appender.im.password = password 
 log4j.appender.im.recipient = [email protected]

 log4j.appender.im.layout=org.apache.log4j.PatternLayout 
 log4j.appender.im.layout.ConversionPattern =[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n


 轉:關於 log4j.additivity的說明 

log4j.additivity是 子Logger 是否繼承 父Logger 的 輸出源(appender) 的標誌位。具體說,默認情況下 子Logger 會繼承 父Logger 的appender,也就是說 子Logger 會在 父Logger 的appender裏輸出。若是additivity設爲false,則 子Logger 只會在自己的appender裏輸出,而不會在 父Logger 的appender裏輸出。 

如: 
log4j.rootLogger=INFO, stdout,logfile 
log4j.logger.com.ambow.upgrade=INFO, dataSync 


則com.ambow.upgrade包及其子包下的Logger不光在Appender dataSync裏輸出,也會在rootLogger的Appender stuout和logfile中輸出; 
若想讓com.ambow.upgrade包及其子包下的Logger只在Appender dataSync中輸出,則在log4j.properties中添加下行即可: 
log4j.additivity.com.ambow.upgrade=false 


 
與此對應的在logback中的配置爲:
<logger name="com.apabi.ptvs.web.DataController"
additivity="false">
<level value="INFO" />
<appender-ref ref="logfile" />
</logger>

 





Log4J是Apache的一個開放源代碼的項目。通過使用Log4J,程序員可以控制日誌信息輸送的目的地,包括控制檯,文件,GUI組件和NT事件記錄器,也可以控制每一條日誌的輸出格式,或通過定義每一條日誌信息的級別,更加細緻地控制日誌的生成過程。

Log4j的組成:
Log4j由三個重要的組成構成:日誌記錄器(Loggers),輸出端(Appenders)和日誌格式化器(Layout)。
Logger:控制要啓用或禁用哪些日誌記錄語句,並對日誌信息進行級別限制:Appenders指定了日誌將打印到控制檯還是文件中;而Layout則控制日誌信息的顯示格式。

日誌級別:

每個Logger都被了一個日誌級別(log level),用來控制日誌信息的輸出。日誌級別從高到低分爲:
A:off         最高等級,用於關閉所有日誌記錄。
B:fatal       指出每個嚴重的錯誤事件將會導致應用程序的退出。
C:error      指出雖然發生錯誤事件,但仍然不影響系統的繼續運行。
D:warm     表明會出現潛在的錯誤情形。
E:info         一般和在粗粒度級別上,強調應用程序的運行全程。
F:debug     一般用於細粒度級別上,對調試應用程序非常有幫助。
G:all           最低等級,用於打開所有日誌記錄。

上面這些級別是定義在org.apache.log4j.Level類中。Log4j只建議使用4個級別,優先級從高到低分別是error,warn,info和debug。通過使用日誌級別,可以控制應用程序中相應級別日誌信息的輸


        Logger logger = Logger.getLogger(Log4jTest.class);

//獲取Logger對象,也可以是:Logger logger= Logger.gerLogger(Log4jTest.class.getName());
        
        //使用默認的配置信息,不需要寫log4j.properties
        BasicConfigurator.configure();
        //設置日誌輸出級別爲info,這將覆蓋配置文件中設置的級別
        logger.setLevel(Level.INFO);
        //下面的消息將被輸出
        logger.info("this is an info");
        logger.warn("this is a warn");
        logger.error("this is an error");
        logger.fatal("this is a fatal");

Appender:

Appender用來指定日誌信息輸出到哪個地方,可以同時指定多個輸出目的地。Log4j允許將信息輸出到許多不同的輸出設備中,一個log信息輸出目的地就叫做一個Appender。
每個Logger都可以擁有一個或多個Appender,每個Appender表示一個日誌的輸出目的地。可以使用Logger.addAppender(Appender app)爲Logger增加一個Appender,也可以使用Logger.removeAppender(Appender app)爲Logger刪除一個Appender。
以下爲Log4j幾種常用的輸出目的地。
a:org.apache.log4j.ConsoleAppender:將日誌信息輸出到控制檯。
b:org.apache.log4j.FileAppender:將日誌信息輸出到一個文件。
c:org.apache.log4j.DailyRollingFileAppender:將日誌信息輸出到一個日誌文件,並且每天輸出到一個新的日誌文件。
d:org.apache.log4j.RollingFileAppender:將日誌信息輸出到一個日誌文件,並且指定文件的尺寸,當文件大小達到指定尺寸時,會自動把文件改名,同時產生一個新的文件。
e:org.apache.log4j.WriteAppender:將日誌信息以流格式發送到任意指定地方。
f::org.apache.log4j.jdbc.JDBCAppender:通過JDBC把日誌信息輸出到數據庫中。



日誌格式化器Layout
有三種:
HTMLLayout:格式化日誌輸出爲HTML表格形式:如下
SimpleLayout:以一種非常簡單的方式格式化日誌輸出,它打印三項內容:級別-信息
例:INFO - info
PatternLayout::根據指定的轉換模式格式化日誌輸出,或者如果沒有指定任何轉換模式,就使用默認的轉化模式格式。

        Logger logger = Logger.getLogger(Log4jTest.class);        
        SimpleLayout layout = new SimpleLayout();
        //HTMLLayout  layout = new HTMLLayout();
        FileAppender appender = null;
        try
        {
            //把輸出端配置到out.txt
            appender = new FileAppender(layout,"out.txt",false);
        }
catch(Exception e)
        {            
        }

        logger.addAppender(appender);//添加輸出端
        logger.setLevel((Level)Level.DEBUG);//覆蓋配置文件中的級別
        logger.debug("debug");
        logger.info("info");
        logger.warn("warn");
        logger.error("error");
        logger.fatal("fatal");
//Log4j的配置:

配Log4j環境就是指配置root Logger,包括把Logger爲哪個級別,爲它增加哪些Appender,以及爲這些Appender設置Layout,等等。因爲所有其他的Logger都是root Logger的後代,所以它們都繼承了root Logger的性質。這些可以通過設置系統屬性的方法來隱式地完成,也可以在程序中調用XXXConfigurator.configure()方法來顯式地完成。有以下幾種方式來配置Log4j。

A:配置放在文件裏,通過環境變量傳遞文件名等信息,利用Log4j默認的初始化過程解析並配置。
B:配置放在文件裏,通過應用服務器配置傳遞文件甸等信息,利用一個特定的Servlet來完成配置。
C:在程序中調用BasicConfigor.configure()方法。
D:配置放在文件裏,通過命令行PropertyConfigurator.configure(args[])解析log4j.properties文件並配置Log4j。
下面對BasicConfigurator.configure()方法和PropertyConfigurator.config()方法分別進行介紹。
BasicConfigurator.configure()方法
它使用簡單的方法配置Log4j環境。這個方法完成的任務是:
1:用默認的方式創建PatternLayout對象p:
  PatternLayout p = new PatternLayout("%-4r[%t]%-5p%c%x-%m%n");
2:用p創建ConsoleAppender對象a,目標是System.out,標準輸出設備:
 ConsoleAppender a = new CpnsoleAppender(p,ConsoleAppender.SYSTEM_OUT);
3:爲root Logger增加一個ConsoleAppender p;
 rootLogger.addAppender(p);
4:把rootLogger的log level設置爲DUBUG級別;
 rootLogger.setLevel(Level.DEBUG);

PropertyConfigurator.configure()方法
當使用以下語句生成Logger對象時:

 static Logger logger = Logger.getLogger(mycalss.class);

如果沒有調用BasicConfigurator.configure(),PropertyConfigurator.configure()或DOMConfigurator.configure()方法,Log4j會自動加載CLASSPATH下名爲log4j.properties的配置文件。如果把此配置文件改爲其他名字,例如my.properties,程序雖然仍能運行,但會報出不能正確初始化Log4j系統的提示。這時可以在程序中加上:

PropertyConfigurator.configure("classes/my.properties");

自己的代碼簡介:

log4j.properties 文件中的配置:

log4j.appender.A=org.apache.log4j.ConsoleAppender
log4j.appender.A.Target=System.out
log4j.appender.stdout=org.apache.log4j.FileAppender
log4j.appender.stdout.File=D:\\t.log 
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
log4j.appender.A.layout=org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern=%d{ABSOLUTE} %5p %c{1}:%L - %m%n
log4j.appender.A.layout.ConversionPattern=%d{ABSOLUTE} %5p %c{1}:%L - %m%n
log4j.rootLogger=warn, stdout,A

然後在java代碼中調用Logger使用:代碼如下:


Logger  logger = Logger.getLogger(TeseLog4j.class.getName());
//BasicConfigurator.configure();//使用默認的配置信息,不需要寫log4j.properties
//PropertyConfigurator.configure("./src/log4j.properties");
// PropertyConfigurator.configure("src/log4j.properties");這兩種方式都是可以找到文件的。

logger.debug("hhhh");
logger.error("error");
logger.warn("warn");
logger.warn("warn");













發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章