log4j.xml配置文件詳解

一 log4j.xml 配置

<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE log4j:configuration SYSTEM "log4j.dtd"> <log4j:configuration> <!-- 將日志信息輸出到控制台 --> <appender name="ConsoleAppender" class="org.apache.log4j.ConsoleAppender"> <!-- 設置日志輸出的樣式 --> <layout class="org.apache.log4j.PatternLayout"> <!-- 設置日志輸出的格式 --> <param name="ConversionPattern" value="[%d{yyyy-MM-dd HH:mm:ss:SSS}] [%-5p] [method:%l]%n%m%n%n" /> </layout> <!--過濾器設置輸出的級別--> <filter class="org.apache.log4j.varia.LevelRangeFilter"> <!-- 設置日志輸出的最小級別 --> <param name="levelMin" value="WARN" /> <!-- 設置日志輸出的最大級別 --> <param name="levelMax" value="ERROR" /> <!-- 設置日志輸出的xxx，默認是false --> <param name="AcceptOnMatch" value="true" /> </filter> </appender> <!-- 將日志信息輸出到文件，但是當文件的大小達到某個閾值的時候，日志文件會自動回滾 --> <appender name="RollingFileAppender" class="org.apache.log4j.RollingFileAppender"> <!-- 設置日志信息輸出文件全路徑名 --> <param name="File" value="D:/log4j/RollingFileAppender.log" /> <!-- 設置是否在重新啟動服務時，在原有日志的基礎添加新日志 --> <param name="Append" value="true" /> <!-- 設置保存備份回滾日志的最大個數 --> <param name="MaxBackupIndex" value="10" /> <!-- 設置當日志文件達到此閾值的時候自動回滾，單位可以是KB，MB，GB，默認單位是KB --> <param name="MaxFileSize" value="10KB" /> <!-- 設置日志輸出的樣式 --> <layout class="org.apache.log4j.PatternLayout"> <!-- 設置日志輸出的格式 --> <param name="ConversionPattern" value="[%d{yyyy-MM-dd HH:mm:ss:SSS}] [%-5p] [method:%l]%n%m%n%n" /> </layout> </appender> <!-- 將日志信息輸出到文件，可以配置多久產生一個新的日志信息文件 --> <appender name="DailyRollingFileAppender" class="org.apache.log4j.DailyRollingFileAppender"> <!-- 設置日志信息輸出文件全路徑名 --> <param name="File" value="D:/log4j/DailyRollingFileAppender.log" /> <!-- 設置日志每分鍾回滾一次，即產生一個新的日志文件 --> <param name="DatePattern" value="'.'yyyy-MM-dd-HH-mm'.log'" /> <!-- 設置日志輸出的樣式 --> <layout class="org.apache.log4j.PatternLayout"> <!-- 設置日志輸出的格式 --> <param name="ConversionPattern" value="[%d{yyyy-MM-dd HH:mm:ss:SSS}] [%-5p] [method:%l]%n%m%n%n" /> </layout> </appender>

二 配置的其他說明

(1). 輸出方式appender一般有5種： 

             org.apache.log4j.RollingFileAppender(滾動文件，自動記錄最新日志) 
             org.apache.log4j.ConsoleAppender (控制台)  
             org.apache.log4j.FileAppender (文件) 
             org.apache.log4j.DailyRollingFileAppender (每天產生一個日志文件) 
             org.apache.log4j.WriterAppender (將日志信息以流格式發送到任意指定的地方) 



(2). 日記記錄的優先級priority，優先級由高到低分為 
            OFF ,FATAL ,ERROR ,WARN ,INFO ,DEBUG ,ALL。 
            Log4j建議只使用FATAL ,ERROR ,WARN ,INFO ,DEBUG這五個級別。 



(3). 格式說明layout中的參數都以%開始，后面不同的參數代表不同的格式化信息（參數按字母表順序列出）： 
                %c        輸出所屬類的全名，可在修改為 %d{Num} ,Num類名輸出的維（如："org.apache.elathen.ClassName",%C{2}將輸出elathen.ClassName） 
                %d       輸出日志時間其格式為 %d{yyyy-MM-dd HH:mm:ss,SSS}，可指定格式 如 %d{HH:mm:ss} 
                %l        輸出日志事件發生位置，包括類目名、發生線程，在代碼中的行數 
                %n       換行符 
                %m      輸出代碼指定信息，如info(“message”),輸出message 
                %p       輸出優先級，即 FATAL ,ERROR 等 
                %r        輸出從啟動到顯示該log信息所耗費的毫秒數 
                %t        輸出產生該日志事件的線程名

 

 

 

 

 

 

 

 

 

 

 

 

 

 

三 配置全解

xml declaration and DTD

xml配置文件的頭部包括兩個部分：xml聲明和DTD聲明。頭部的格式如下：

 

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">
          

 

log4j:configuration (root element)

 

• xmlns:log4j [#FIXED attribute] : 定義log4j的名字空間，取定值"http://jakarta.apache.org/log4j/"
• appender [* child] : 一個appender子元素定義一個日志輸出目的地
• logger [* child] : 一個logger子元素定義一個日志寫出器
• root [? child] : root子元素定義了root logger

 

appender

appender元素定義一個日志輸出目的地。

 

• name [#REQUIRED attribute] : 定義appender的名字，以便被后文引用
• class [#REQUIRED attribute] : 定義appender對象所屬的類的全名
• param [* child] : 創建appender對象時傳遞給類構造方法的參數
• layout [? child] : 該appender使用的layout對象

 

layout

layout元素定義與某一個appender相聯系的日志格式化器。

 

• class [#REQUIRED attribute] : 定義layout對象所屬的類的全名
• param [* child] : 創建layout對象時傳遞給類構造方法的參數

 

logger

logger元素定義一個日志輸出器。

 

• name [#REQUIRED attribute] : 定義logger的名字，以便被后文引用
• additivity [#ENUM attribute] : 取值為"true"（默認）或者"false"，是否繼承父logger的屬性
• level [? child] : 定義該logger的日志級別
• appender-ref [* child] : 定義該logger的輸出目的地

 

root

root元素定義根日志輸出器root logger。

 

• param [* child] : 創建root logger對象時傳遞給類構造方法的參數
• level [? child] : 定義root logger的日志級別
• appender-ref [* child] : 定義root logger的輸出目的地

 

level

level元素定義logger對象的日志級別。

 

• class [#IMPLIED attribute] : 定義level對象所屬的類，默認情況下是"org.apache.log4j.Level類
• value [#REQUIRED attribute] : 為level對象賦值。可能的取值從小到大依次為"all"、"debug"、"info"、"warn"、"error"、"fatal"和"off"。當值為"off"時表示沒有任何日志信息被輸出
• param [* child] : 創建level對象時傳遞給類構造方法的參數

 

appender-ref

appender-ref元素引用一個appender元素的名字，為logger對象增加一個appender。

 

• ref [#REQUIRED attribute] : 一個appender元素的名字的引用
• appender-ref元素沒有子元素

 

Param

param元素在創建對象時為類的構造方法提供參數。它可以成為appender、layout、filter、errorHandler、level、categoryFactory和root等元素的子元素。

 

• name and value [#REQUIRED attributes] : 提供參數的一組名值對
• param元素沒有子元素

在xml文件中配置appender和layout

創建不同的Appender對象或者不同的Layout對象要調用不同的構造方法。可以使用param子元素來設定不同的參數值。

創建ConsoleAppender對象

ConsoleAppender的構造方法不接受其它的參數。

 

... ... ... ...
<appender name="console.log" class="org.apache.log4j.ConsoleAppender">
  <layout ... >
    ... ...
  </layout>
</appender>
... ... ... ...
          

建FileAppender對象

可以為FileAppender類的構造方法傳遞兩個參數：File表示日志文件名；Append表示如文件已存在，是否把日志追加到文件尾部，可能取值為"true"和"false"（默認）。

 

... ... ... ...
<appender name="file.log" class="org.apache.log4j.FileAppender">
  <param name="File" value="/tmp/log.txt" />
  <param name="Append" value="false" />
  <layout ... >
    ... ...
  </layout>
</appender>
... ... ... ...
          

建RollingFileAppender對象

除了File和Append以外，還可以為RollingFileAppender類的構造方法傳遞兩個參數：MaxBackupIndex備份日志文件的個數（默認是1個）；MaxFileSize表示日志文件允許的最大字節數（默認是10M）。

 

... ... ... ...
<appender name="rollingFile.log" class="org.apache.log4j.RollingFileAppender">
  <param name="File" value="/tmp/rollingLog.txt" />
  <param name="Append" value="false" />
  <param name="MaxBackupIndex" value="2" />
  <param name="MaxFileSize" value="1024" />
  <layout ... >
    ... ...
  </layout>
</appender>
... ... ... ...
         

創建PatternLayout對象

可以為PatternLayout類的構造方法傳遞參數ConversionPattern。

<layout class="org.apache.log4j.PatternLayout>  <param name="Conversion" value="%d [%t] %p - %m%n" />
</layout>