logback 常用配置詳解（二） <appender>

<appender>：

<appender>是<configuration>的子節點，是負責寫日誌的元件。

<appender>有兩個必要屬性name和class。name指定appender名稱，class指定appender的全限定名。

1.ConsoleAppender:

把日誌新增到控制檯，有以下子節點：

<encoder>：對日誌進行格式化。（具體引數稍後講解 ）

<target>：字串 System.out 或者 System.err

例如：

     <configuration>  
      
      <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">  
        <encoder>  
          <pattern>%-4relative [%thread] %-5level %logger{35} - %msg %n</pattern>  
        </encoder>  
      </appender>  
      
      <root level="DEBUG">  
        <appender-ref ref="STDOUT" />  
      </root>  
    </configuration>  
 

2.FileAppender:

把日誌新增到檔案，有以下子節點：

<file>：被寫入的檔名，可以是相對目錄，也可以是絕對目錄，如果上級目錄不存在會自動建立，沒有預設值。

<append>：如果是 true，日誌被追加到檔案結尾，如果是 false，清空現存檔案，預設是true。

<encoder>：對記錄事件進行格式化。（具體引數稍後講解 ）

<prudent>：如果是 true，日誌會被安全的寫入檔案，即使其他的FileAppender也在向此檔案做寫入操作，效率低，預設是 false。

例如：

     <configuration>  
      
      <appender name="FILE" class="ch.qos.logback.core.FileAppender">  
        <file>testFile.log</file>  
        <append>true</append>  
        <encoder>  
          <pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern>  
        </encoder>  
      </appender>  
              
      <root level="DEBUG">  
        <appender-ref ref="FILE" />  
      </root>  
    </configuration>
 

3.RollingFileAppender:

滾動記錄檔案，先將日誌記錄到指定檔案，當符合某個條件時，將日誌記錄到其他檔案。有以下子節點：

<file>：被寫入的檔名，可以是相對目錄，也可以是絕對目錄，如果上級目錄不存在會自動建立，沒有預設值。

<append>：如果是 true，日誌被追加到檔案結尾，如果是 false，清空現存檔案，預設是true。

<encoder>：對記錄事件進行格式化。（具體引數稍後講解 ）

<rollingPolicy>:當發生滾動時，決定 RollingFileAppender 的行為，涉及檔案移動和重新命名。

<triggeringPolicy >: 告知 RollingFileAppender 何時啟用滾動。

<prudent>：當為true時，不支援FixedWindowRollingPolicy。支援TimeBasedRollingPolicy，但是有兩個限制，1不支援也不允許檔案壓縮，2不能設定file屬性，必須留空。

3.1 rollingPolicy：最常用的滾動策略，它根據時間來制定滾動策略，既負責滾動也負責出發滾動。有以下子節點：

<fileNamePattern>:

必要節點，包含檔名及“%d”轉換符， “%d”可以包含一個java.text.SimpleDateFormat指定的時間格式，如：%d{yyyy-MM}。如果直接使用 %d，預設格式是 yyyy-MM-dd。RollingFileAppender 的file位元組點可有可無，通過設定file，可以為活動檔案和歸檔檔案指定不同位置，當前日誌總是記錄到file指定的檔案（活動檔案），活動檔案的名字不會改變；如果沒設定file，活動檔案的名字會根據fileNamePattern 的值，每隔一段時間改變一次。“/”或者“\”會被當做目錄分隔符。

<maxHistory>:

可選節點，控制保留的歸檔檔案的最大數量，超出數量就刪除舊檔案。假設設定每個月滾動，且<maxHistory>是6，則只儲存最近6個月的檔案，刪除之前的舊檔案。注意，刪除舊檔案是，那些為了歸檔而建立的目錄也會被刪除。

3.2 FixedWindowRollingPolicy： 根據固定視窗演算法重新命名檔案的滾動策略。有以下子節點：

<minIndex>:視窗索引最小值

<maxIndex>:視窗索引最大值，當用戶指定的視窗過大時，會自動將視窗設定為12。

<fileNamePattern >:

必須包含“%i”例如，假設最小值和最大值分別為1和2，命名模式為 mylog%i.log,會產生歸檔檔案mylog1.log和mylog2.log。還可以指定檔案壓縮選項，例如，mylog%i.log.gz 或者 mylog%i.log.zip

3.3 triggeringPolicy:

SizeBasedTriggeringPolicy： 檢視當前活動檔案的大小，如果超過指定大小會告知RollingFileAppender 觸發當前活動檔案滾動。只有一個節點:

<maxFileSize>:這是活動檔案的大小，預設值是10MB。

4 .另外還有

SocketAppender、SMTPAppender、DBAppender、SyslogAppender、SiftingAppender，並不常用，這些就不在這裡講解了，大家可以參考官方文件。當然大家可以編寫自己的Appender。

5，程式碼示例

5.1 例如：每天生成一個日誌檔案，儲存30天的日誌檔案。

     <configuration>   
      <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">   
          
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">   
          <fileNamePattern>logFile.%d{yyyy-MM-dd}.log</fileNamePattern>   
          <maxHistory>30</maxHistory>    
        </rollingPolicy>   
       
        <encoder>   
          <pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern>   
        </encoder>   
      </appender>    
       
      <root level="DEBUG">   
        <appender-ref ref="FILE" />   
      </root>   
    </configuration>  

5.2 例如：按照固定視窗模式生成日誌檔案，當檔案大於20MB時，生成新的日誌檔案。視窗大小是1到3，當儲存了3個歸檔檔案後，將覆蓋最早的日誌。

     <configuration>   
      <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">   
        <file>test.log</file>   
       
        <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">   
          <fileNamePattern>tests.%i.log.zip</fileNamePattern>   
          <minIndex>1</minIndex>   
          <maxIndex>3</maxIndex>   
        </rollingPolicy>   
       
        <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">   
          <maxFileSize>5MB</maxFileSize>   
        </triggeringPolicy>   
        <encoder>   
          <pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern>   
        </encoder>   
      </appender>   
               
      <root level="DEBUG">   
        <appender-ref ref="FILE" />   
      </root>   
    </configuration>  

6，<encoder>：

負責兩件事，一是把日誌資訊轉換成位元組陣列，二是把位元組陣列寫入到輸出流。

目前PatternLayoutEncoder 是唯一有用的且預設的encoder ，有一個<pattern>節點，用來設定日誌的輸入格式。使用“%”加“轉換符”方式，如果要輸出“%”，則必須用“\”對“\%”進行轉義。

例如：

     <encoder>   
       <pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern>   
    </encoder  

<pattern>裡面的轉換符說明： 

0    [main] DEBUG - logging statement 
Caller+0   at mainPackage.sub.sample.Bar.sampleMethodName(Bar.java:22)
Caller+1   at mainPackage.sub.sample.Bar.createLoggingRequest(Bar.java:17)

16   [main] DEBUG - logging statement 
Caller+0   at mainPackage.sub.sample.Bar.sampleMethodName(Bar.java:22)
Caller+1   at mainPackage.sub.sample.Bar.createLoggingRequest(Bar.java:17)
Caller+2   at mainPackage.ConfigTester.main(ConfigTester.java:38)

格式修飾符，與轉換符共同使用：

可選的格式修飾符位於“%”和轉換符之間。

第一個可選修飾符是左對齊 標誌，符號是減號“-”；接著是可選的最小寬度 修飾符，用十進位制數表示。如果字元小於最小寬度，則左填充或右填充，預設是左填充（即右對齊），填充符為空格。如果字元大於最小寬度，字元永遠不會被截斷。最大寬度 修飾符，符號是點號"."後面加十進位制數。如果字元大於最大寬度，則從前面截斷。點符號“.”後面加減號“-”在加數字，表示從尾部截斷。

例如：%-4relative 表示，將輸出從程式啟動到建立日誌記錄的時間 進行左對齊 且最小寬度為4。