log4j.xml 基本配置

1簡介

一般log4j的xml配置方式基本步驟有3個，第一步：配置appender；第二步：配置logger；第三步：配置root。下面配置一個ConsoleAppender和兩個DailyRollingFileAppender為例具體展開。

1.1 日誌級別

不考慮其他因素，日記級別FATAL>ERROR>WARN>INFO>DEBUG，這個是許多同學都清楚的，但是結合appender，logger，root的配置後，日誌列印的結果會發生一些微妙的變化。

首先，root的中的日誌級別在使用者沒有為某一個具體的logger配置日誌級別的時候才會對該logger生效。這裡就可以用來解釋有的同學問為什麼在root中配置了ERROR級別，但是日誌中依舊有INFO的日誌輸出。

其次，如果某一個appender配置了日誌過濾器，那使用該appender的logger配置日誌級別的時候，範圍不超出appender過濾的級別資訊才會被輸出。

2配置appender

圖2-1是一個標準的ConsoleAppender配置：

圖 2‑1

如註釋所描述，ConsoleAppender一般在我們除錯專案時候用處比較大，這裡不再多餘描述。

圖2-2是一個標準的FileAppender配置，這裡我配置了一個info.log檔案和一個eror.log，位於/opt/logs目錄下面，分別用來記錄一般訊息和錯誤訊息。

圖 2‑2

appender的配置相對比較簡單，除了過濾器，沒有特殊要注意的。

3配置logger

圖3-1是兩種looger配置。

圖 3‑1

logger的name屬性指代的是程式包路徑，不用贅述。additivity屬性，表示是否遵循預設的繼承機制。

需要注意：

1如果我們配置了true，那我們最好不要再給該logger配置appender-ref屬性，除非被配置的appender-ref我們沒有繼續新增在root的appender-ref中，否則我們會發現日誌重複。

2如果我們配置了false，那就必須為該logger配置appender-ref，否則日誌不會被列印。

4配置root

圖4-1是一個標準的root配置。

圖 4‑1

root的作用是是收集所有配置的logger（additivity=true）反饋上來的資訊流並且根據root中配置的appender-ref進行輸出，所以，如果我們logger配置了additivity=true，又配置了appender-ref，會導致日誌重複。

注意：這裡的level值對那些沒有配置日誌級別，而且additivity=true的logger才會有作用。

下面是具體的配置資訊：

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

   <!--對於ConsoleAppender來說，在開發階段還是比較有用的，能直接在ide中看到輸出的日誌內容，
   但是在實際的產品階段，我們更希望將日誌輸出到指定的檔案上檢視，這就需要用到FileAppender-->
<appender name="CONSOLE" class="org.apache.log4j.ConsoleAppender">
      <param name="encoding" value="UTF-8" />
      <layout class="org.apache.log4j.PatternLayout">
         <param name="ConversionPattern" value="%d %-5p %t %l %m%n" />
      </layout>
      <!--如果有過濾器，當前appender只會處理滿足過濾器條件的日誌資訊-->
      <!--<filter class="org.apache.log4j.varia.LevelRangeFilter">
         <param name="levelMin" value="DEBUG" />
         <param name="levelMax" value="FATAL" />
         <param name="AcceptOnMatch" value="true" />
      </filter>-->
</appender>

   <!-- 寫到遠端日誌 -->
<appender name="DEFAULT-APPENDER-REMOTE" class="org.apache.log4j.net.SyslogAppender">
      <param name="SyslogHost" value="${logServer}"/> 
       <param name="Facility" value="LOCAL1"/>
          <param name="FacilityPrinting" value="true"/>
       <layout class="org.apache.log4j.PatternLayout">
           <param name="ConversionPattern" value="%d %-5p %t %c %m%n" />
       </layout> 
   </appender>
   
   <appender name="FRAMEWORK-APPENDER-REMOTE" class="org.apache.log4j.net.SyslogAppender">
      <param name="SyslogHost" value="${logServer}"/> 
       <param name="Facility" value="LOCAL3"/>
          <param name="FacilityPrinting" value="true"/>
       <layout class="org.apache.log4j.PatternLayout">
           <param name="ConversionPattern" value="%d %-5p %t %c %m%n" />
       </layout> 
   </appender>
   <!-- 寫到本地日誌 -->
   <!--第一步：配置appender-->
<appender name="INFO-LOCAL" class="org.apache.log4j.DailyRollingFileAppender">
      <param name="file" value="/opt/logs/info.log" />
      <param name="append" value="true" /><!--一般必須配置true，否則會覆蓋而不是累加-->
<param name="encoding" value="UTF-8" />
      <layout class="org.apache.log4j.PatternLayout">
         <param name="ConversionPattern" value="%d %-5p %t %l %m%n" />
      </layout>
      <!--如果有過濾器，日誌檔案中就只會有符合過濾器的日誌資訊-->
<filter class="org.apache.log4j.varia.LevelRangeFilter">
         <param name="levelMin" value="DEBUG" />
         <param name="levelMax" value="INFO" />
         <param name="AcceptOnMatch" value="true" />
      </filter>
   </appender>
   <appender name="ERROR-LOCAL" class="org.apache.log4j.DailyRollingFileAppender">
      <param name="file" value="/opt/logs/error.log" />
      <param name="append" value="true" /><!--一般必須配置true，否則會覆蓋而不是累加-->
<param name="encoding" value="UTF-8" />
      <layout class="org.apache.log4j.PatternLayout">
         <param name="ConversionPattern" value="%d %-5p %t %l %m%n" />
      </layout>
      <!--如果有過濾器，日誌檔案中就只會有符合過濾器的日誌資訊-->
<filter class="org.apache.log4j.varia.LevelRangeFilter">
         <param name="levelMin" value="WARN" />
         <param name="levelMax" value="FATAL" />
         <param name="AcceptOnMatch" value="true" />
      </filter>
   </appender>

   <!--第二步：配置logger。
   如果不配置，系統會採用預設策略，即additivity="true"，level value="DEBUG"。
   注意：additivity=true，表示遵循預設的繼承機制，此時就不應該繼續配置appender-ref，否則日誌會出現重複
   相反，如果additivity=false，就必須要配置appender-ref，否則日誌不會被列印，配置也就沒有意義-->
<logger name="com.test.log4j" additivity="true">
      <!--給具體的logger配置日誌級別，比如com.test包下面日誌級別大於等於DEBUG的，
      才會交給appender進行處理。
      注意：對於com.test包而言，此處的級別會覆蓋root下面的日誌級別-->
<level value="INFO" />
      <!--如果此處配置了append-ref,而且additivity="true"，將會和root裡面的同一個
      append-ref形成累加，即重複日誌-->
      <!--<appender-ref ref="CONSOLE" />-->
      <!--<appender-ref ref="DEFAULT-LOCAL"/>-->
      <!--<appender-ref ref="ERROR-LOCAL"/>-->
</logger>
   <logger name="com.test2" additivity="false">
      <level value="INFO" />
      <appender-ref ref="INFO-LOCAL" />
   </logger>

   <!--第三步：配置root-->
   <!--root的作用是收集所有配置的logger反饋上來的資訊流並根據配置在root中appender進行輸出，
   只要你在looger中配置了additivity="false"，就不會反饋到root中。-->
<root>
      <!--優先順序小於具體的logger中配置的級別，只有當具體的logger沒有配置的時候，
      這裡才會對具體的looger起作用-->
<level value="DEBUG" />
      <appender-ref ref="CONSOLE" />
      <appender-ref ref="INFO-LOCAL" />
      <appender-ref ref="ERROR-LOCAL"/>
   </root>
</log4j:configuration>