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

細整理了logback常用配置，

不是官網手冊的翻譯版，而是使用總結，旨在更快更透徹的了解其配置

​​logback 簡介​​

​​logback 常用配置詳解（一）<configuration> and <logger>​​

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

​​logback 常用配置詳解（三）<filter>​​

​​logback 中文手冊 ​​（官網手冊的翻譯版，在這裡向中文版譯者-陳華，說聲辛苦啦）

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

<appender>：

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

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

1.ConsoleAppender:

把日志添加到控制台，有以下子節點：

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

<target>：字元串 System.out 或者 System.err ，預設 System.out ；

例如：

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

2.FileAppender:

把日志添加到檔案，有以下子節點：

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

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

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

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

例如：

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

3.RollingFileAppender:

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

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

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

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

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

<triggeringPolicy >:告知 RollingFileAppender 合适激活滾動。

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

rollingPolicy：

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

<fileNamePattern>:

必要節點，包含檔案名及“%d”轉換符， “%d”可以包含一個​

​java.text.SimpleDateFormat指定的時間格式，如：%d{yyyy-MM}。如果直接使用 %d，預設格式是 yyyy-MM-dd。​

​RollingFileAppender 的file位元組點可有可無，通過設定file，可以為活動檔案和歸檔檔案指定不同位置，目前日志總是記錄到file指定的檔案（活動檔案），活動檔案的名字不會改變；如果沒設定file，活動檔案的名字會根據fileNamePattern的值，每隔一段時間改變一次。“/”或者“\”會被當做目錄分隔符。

<maxHistory>:

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

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

<minIndex>:視窗索引最小值

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

<fileNamePattern

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

triggeringPolicy:

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

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

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

1. <configuration>   
2. "FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">   
3. class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">   
4.       <fileNamePattern>logFile.%d{yyyy-MM-dd}.log</fileNamePattern>   
5. 30</maxHistory>    
6.     </rollingPolicy>   
7.     <encoder>   
8. 35} - %msg%n</pattern>   
9.     </encoder>   
10.   </appender>    
11. "DEBUG">   
12. "FILE"
13.   </root>   
14. </configuration>  

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

1. <configuration>
2. <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
3. <file>test.log</file>
4. <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
5. <fileNamePattern>tests.%i.log.zip</fileNamePattern>
6. <minIndex>1</minIndex>
7. <maxIndex>3</maxIndex>
8. </rollingPolicy>
9. <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
10. <maxFileSize>5MB</maxFileSize>
11. </triggeringPolicy>
12. <encoder>
13. <pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern>
14. </encoder>
15. </appender>
16. <root level="DEBUG">
17. <appender-ref ref="FILE" />
18. </root>
19. </configuration>

4.另外還有SocketAppender、SMTPAppender、DBAppender、SyslogAppender、SiftingAppender，并不常用，這些就不在這裡講解了，大家可以參考官方文檔。當然大家可以編寫自己的Appender。

<encoder>：

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

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

例如：

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

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

轉換符 作用

c {length }  lo {length }  logger {length }	輸出日志的logger名，可有一個整形參數，功能是縮短logger名，設定為0表示隻輸入logger最右邊點符号之後的字元串。 Conversion specifier Logger name Result
C {length }  class {length }	輸出執行記錄請求的調用者的全限定名。參數與上面的一樣。盡量避免使用，除非執行速度不造成任何問題。
contextName  cn	輸出上下文名稱。
d {pattern }  date {pattern }	輸出日志的列印日志，模式文法與​ ​java.text.SimpleDateFormat​ ​ 相容。 Conversion Pattern Result
F / file	輸出執行記錄請求的java源檔案名。盡量避免使用，除非執行速度不造成任何問題。
caller{depth}caller{depth, evaluator-1, ... evaluator-n}	輸出生成日志的調用者的位置資訊，整數選項表示輸出資訊深度。 例如， %caller{2}   輸出為： 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) 例如， %caller{3}   輸出為： 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)
L / line	輸出執行日志請求的行号。盡量避免使用，除非執行速度不造成任何問題。
m / msg / message	輸出應用程式提供的資訊。
M / method	輸出執行日志請求的方法名。盡量避免使用，除非執行速度不造成任何問題。
n	輸出平台先關的分行符“\n”或者“\r\n”。
p / le / level	輸出日志級别。
r / relative	輸出從程式啟動到建立日志記錄的時間，機關是毫秒
t / thread	輸出産生日志的線程名。
replace(p ){r, t}	p 為日志内容，r 是正規表達式，将p 中符合r 的内容替換為t 。 例如， "%replace(%msg){'\s', ''}"

%logger	mainPackage.sub.sample.Bar	mainPackage.sub.sample.Bar
%logger{0}	mainPackage.sub.sample.Bar	Bar
%logger{5}	mainPackage.sub.sample.Bar	m.s.s.Bar
%logger{10}	mainPackage.sub.sample.Bar	m.s.s.Bar
%logger{15}	mainPackage.sub.sample.Bar	m.s.sample.Bar
%logger{16}	mainPackage.sub.sample.Bar	m.sub.sample.Bar
%logger{26}	mainPackage.sub.sample.Bar	mainPackage.sub.sample.Bar

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

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

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