1. 程式人生 > >Log4j使用詳解(log4j.XML格式)——整理

Log4j使用詳解(log4j.XML格式)——整理

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

xml格式的log4j配置檔案概述

xml格式的log4j配置檔案需要使用org.apache.log4j.xml.DOMConfigurator.configure()方法來讀入。對xml檔案的語法定義可以在log4j的釋出包中找到:org/apache/log4j/xml/log4j.dtd。

log4j的xml配置檔案的樹狀結構如下所示,注意下圖只顯示了常用的部分。

Java程式碼 

複製程式碼
xml declaration and DTD   
 |   
log4j:configuration   
 |   
 +-- appender (name, class)   
 |     |   
 |     +-- param (name, value)   
 |     +-- layout (class)   
 |           |   
 |           +-- param (name, value)   
 +-- logger (name, additivity)   
 |     |   
 |     +-- level (class, value)   
 |     |     |   
 |     |     +-- param (name, value)   
 |     +-- appender-ref (ref)   
 +-- root   
 |   
 +-- param (name, class)   
 +-- level   
 |     |   
 |     +-- param (name, value)   
 +-- appender-ref (ref)    
複製程式碼

Xml程式碼

複製程式碼
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">
<log4j:configuration xmlns:log4j='http://jakarta.apache.org/log4j/' >

    <appender name="myConsole" class="org.apache.log4j.ConsoleAppender">
        <layout class="org.apache.log4j.PatternLayout"
> <param name="ConversionPattern" value="[%d{dd HH:mm:ss,SSS\} %-5p] [%t] %c{2\} - %m%n" /> </layout> <!--過濾器設定輸出的級別--> <filter class="org.apache.log4j.varia.LevelRangeFilter"> <param name="levelMin" value="debug" /> <
param name="levelMax" value="warn" /> <param name="AcceptOnMatch" value="true" /> </filter> </appender> <appender name="myFile" class="org.apache.log4j.RollingFileAppender"> <param name="File" value="D:/output.log" /><!-- 設定日誌輸出檔名 --> <!-- 設定是否在重新啟動服務時,在原有日誌的基礎新增新日誌 --> <param name="Append" value="true" /> <param name="MaxBackupIndex" value="10" /> <layout class="org.apache.log4j.PatternLayout"> <param name="ConversionPattern" value="%p (%c:%L)- %m%n" /> </layout> </appender> <appender name="activexAppender" class="org.apache.log4j.DailyRollingFileAppender"> <param name="File" value="E:/activex.log" /> <param name="DatePattern" value="'.'yyyy-MM-dd'.log'" /> <layout class="org.apache.log4j.PatternLayout"> <param name="ConversionPattern" value="[%d{MMdd HH:mm:ss SSS\} %-5p] [%t] %c{3\} - %m%n" /> </layout> </appender> <!-- 指定logger的設定,additivity指示是否遵循預設的繼承機制--> <logger name="com.runway.bssp.activeXdemo" additivity="false"> <priority value ="info"/> <appender-ref ref="activexAppender" /> </logger> <!-- 根logger的設定--> <root> <priority value ="debug"/> <appender-ref ref="myConsole"/> <appender-ref ref="myFile"/> </root> </log4j:configuration>
複製程式碼

(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">

og4j: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>

... ... ... ...

使用log4j.xml的配置來讓Hibernate中的引數化sql中的引數值和返回值輸出:

複製程式碼
<!-- 為打出sql中的引數而新增20121113start -->
   <!-- 輸出到控制檯中 -->     
    <appender name="console" class="org.apache.log4j.ConsoleAppender">     
        <layout class="org.apache.log4j.PatternLayout">     
            <param name="ConversionPattern"     
                value="%d{yyyy-MM-dd HH:mm:ss} %-5p: %m%n" />     
            <!-- "%-5p: [%t] [%c{3}.%M(%L)] | %m%n" -->     
        </layout>
        <filter class="org.apache.log4j.varia.LevelRangeFilter">
                        <param name="LevelMin" value="trace" />
                        <param name="LevelMax" value="DEBUG" />
        </filter>     
    </appender>     
    
   <logger name="org.hibernate.type.descriptor.sql.BasicBinder"> 
    <level value="trace" /> 
   </logger>
   <logger name="org.hibernate.type.descriptor.sql.BasicExtractor"> 
    <level value="trace" /> 
   </logger>
   <logger name="org.hibernate.sql">     
    <level value="trace" /> 
   </logger>   
   <logger name="org.hibernate.type">     
    <level value="trace" /> 
   </logger>   
   <!-- 為打出sql中的引數而新增20121113end -->

記得還要在<root>處加入這個appender,即<appender-ref ref="console"/ >
複製程式碼