logback.xml解釋（轉載）

時間  2019-11-26
標籤 logback.xml logback xml 解釋 轉載 欄目 XML 简体版
原文   原文鏈接

logback 配置詳解（一）<configuration> and <logger>java

 

一：根節點<configuration>包含的屬性：正則表達式

 

scan:算法

當此屬性設置爲true時，配置文件若是發生改變，將會被從新加載，默認值爲true。數組

scanPeriod:安全

設置監測配置文件是否有修改的時間間隔，若是沒有給出時間單位，默認單位是毫秒。當scan爲true時，此屬性生效。默認的時間間隔爲1分鐘。app

debug:lua

當此屬性設置爲true時，將打印出logback內部日誌信息，實時查看logback運行狀態。默認值爲false。spa

例如：線程

 

Xml代碼   收藏代碼
  1. <configuration scan="true" scanPeriod="60 seconds" debug="false">  
  2.       <!-- 其餘配置省略-->  
  3. </configuration>  

 

二：根節點<configuration>的子節點：debug

 

2.1設置上下文名稱：<contextName>

每一個logger都關聯到logger上下文，默認上下文名稱爲「default」。但可使用<contextName>設置成其餘名字，用於區分不一樣應用程序的記錄。一旦設置，不能修改。

 

Xml代碼   收藏代碼
  1. <configuration scan="true" scanPeriod="60 seconds" debug="false">  
  2.       <contextName>myAppName</contextName>  
  3.       <!-- 其餘配置省略-->  
  4. </configuration>  

 

2.2設置變量： <property>

用來定義變量值的標籤，<property> 有兩個屬性，name和value；其中name的值是變量的名稱，value的值時變量定義的值。經過<property>定義的值會被插入到logger上下文中。定義變量後，可使「${}」來使用變量。

例如使用<property>定義上下文名稱，而後在<contentName>設置logger上下文時使用。

Xml代碼   收藏代碼
  1. <configuration scan="true" scanPeriod="60 seconds" debug="false">  
  2.       <property name="APP_Name" value="myAppName" />   
  3.       <contextName>${APP_Name}</contextName>  
  4.       <!-- 其餘配置省略-->  
  5. </configuration>   

 

 

2.3獲取時間戳字符串：<timestamp>

兩個屬性 key:標識此<timestamp> 的名字；datePattern：設置將當前時間（解析配置文件的時間）轉換爲字符串的模式，遵循java.txt.SimpleDateFormat的格式。

        例如將解析配置文件的時間做爲上下文名稱：

Xml代碼   收藏代碼
  1. <configuration scan="true" scanPeriod="60 seconds" debug="false">  
  2.       <timestamp key="bySecond" datePattern="yyyyMMdd'T'HHmmss"/>   
  3.       <contextName>${bySecond}</contextName>  
  4.       <!-- 其餘配置省略-->  
  5. </configuration>   

 

2.4設置loger：

<loger>

用來設置某一個包或者具體的某一個類的日誌打印級別、以及指定<appender>。<loger>僅有一個name屬性，一個可選的level和一個可選的addtivity屬性。

name:

用來指定受此loger約束的某一個包或者具體的某一個類。

level:

用來設置打印級別，大小寫無關：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，還有一個特俗值INHERITED或者同義詞NULL，表明強制執行上級的級別。

若是未設置此屬性，那麼當前loger將會繼承上級的級別。

addtivity:

是否向上級loger傳遞打印信息。默認是true。

<loger>能夠包含零個或多個<appender-ref>元素，標識這個appender將會添加到這個loger。

 

<root>

也是<loger>元素，可是它是根loger。只有一個level屬性，應爲已經被命名爲"root".

level:

用來設置打印級別，大小寫無關：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，不能設置爲INHERITED或者同義詞NULL。

默認是DEBUG。

<root>能夠包含零個或多個<appender-ref>元素，標識這個appender將會添加到這個loger。

 

例如：

LogbackDemo.java類

Java代碼   收藏代碼
  1. package logback;  
  2.   
  3. import org.slf4j.Logger;  
  4. import org.slf4j.LoggerFactory;  
  5.   
  6. public class LogbackDemo {  
  7.     private static Logger log = LoggerFactory.getLogger(LogbackDemo.class);  
  8.     public static void main(String[] args) {  
  9.         log.trace("======trace");  
  10.         log.debug("======debug");  
  11.         log.info("======info");  
  12.         log.warn("======warn");  
  13.         log.error("======error");  
  14.     }  
  15. }  

 

logback.xml配置文件

 

第1種：只配置root

Xml代碼   收藏代碼
  1. <configuration>   
  2.    
  3.   <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">   
  4.     <!-- encoder 默認配置爲PatternLayoutEncoder -->   
  5.     <encoder>   
  6.       <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>   
  7.     </encoder>   
  8.   </appender>   
  9.    
  10.   <root level="INFO">             
  11.     <appender-ref ref="STDOUT" />   
  12.   </root>     
  13.      
  14.  </configuration>  

 其中appender的配置表示打印到控制檯(稍後詳細講解appender )；

<root level="INFO">將root的打印級別設置爲「INFO」，指定了名字爲「STDOUT」的appender。

 

當執行logback.LogbackDemo類的main方法時，root將級別爲「INFO」及大於「INFO」的日誌信息交給已經配置好的名爲「STDOUT」的appender處理，「STDOUT」appender將信息打印到控制檯；

打印結果以下：

Xml代碼   收藏代碼
  1. 13:30:38.484 [main] INFO  logback.LogbackDemo - ======info  
  2. 13:30:38.500 [main] WARN  logback.LogbackDemo - ======warn  
  3. 13:30:38.500 [main] ERROR logback.LogbackDemo - ======error  

 

  第2種：帶有loger的配置，不指定級別，不指定appender，

Xml代碼   收藏代碼
  1. <configuration>   
  2.    
  3.   <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">   
  4.     <!-- encoder 默認配置爲PatternLayoutEncoder -->   
  5.     <encoder>   
  6.       <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>   
  7.     </encoder>   
  8.   </appender>   
  9.    
  10.   <!-- logback爲java中的包 -->   
  11.   <logger name="logback"/>   
  12.    
  13.   <root level="DEBUG">             
  14.     <appender-ref ref="STDOUT" />   
  15.   </root>     
  16.      
  17.  </configuration>  

 其中appender的配置表示打印到控制檯(稍後詳細講解appender )；

<logger name="logback" />將控制logback包下的全部類的日誌的打印，可是並沒用設置打印級別，因此繼承他的上級<root>的日誌級別「DEBUG」；

沒有設置addtivity，默認爲true，將此loger的打印信息向上級傳遞；

沒有設置appender，此loger自己不打印任何信息。

<root level="DEBUG">將root的打印級別設置爲「DEBUG」，指定了名字爲「STDOUT」的appender。

 

當執行logback.LogbackDemo類的main方法時，由於LogbackDemo 在包logback中，因此首先執行<logger name="logback" />，將級別爲「DEBUG」及大於「DEBUG」的日誌信息傳遞給root，自己並不打印；

root接到下級傳遞的信息，交給已經配置好的名爲「STDOUT」的appender處理，「STDOUT」appender將信息打印到控制檯；

打印結果以下：

Xml代碼   收藏代碼
  1. 13:19:15.406 [main] DEBUG logback.LogbackDemo - ======debug  
  2. 13:19:15.406 [main] INFO  logback.LogbackDemo - ======info  
  3. 13:19:15.406 [main] WARN  logback.LogbackDemo - ======warn  
  4. 13:19:15.406 [main] ERROR logback.LogbackDemo - ======error  

 

 第3種：帶有多個loger的配置，指定級別，指定appender  

Xml代碼   收藏代碼
  1. <configuration>   
  2.    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">   
  3.     <!-- encoder 默認配置爲PatternLayoutEncoder -->   
  4.     <encoder>   
  5.       <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>   
  6.     </encoder>   
  7.   </appender>   
  8.    
  9.   <!-- logback爲java中的包 -->   
  10.   <logger name="logback"/>   
  11.   <!--logback.LogbackDemo：類的全路徑 -->   
  12.   <logger name="logback.LogbackDemo" level="INFO" additivity="false">  
  13.     <appender-ref ref="STDOUT"/>  
  14.   </logger>   
  15.     
  16.   <root level="ERROR">             
  17.     <appender-ref ref="STDOUT" />   
  18.   </root>     
  19. </configuration>  

其中appender的配置表示打印到控制檯(稍後詳細講解appender )；

 

<logger name="logback" />將控制logback包下的全部類的日誌的打印，可是並沒用設置打印級別，因此繼承他的上級<root>的日誌級別「DEBUG」；

沒有設置addtivity，默認爲true，將此loger的打印信息向上級傳遞；

沒有設置appender，此loger自己不打印任何信息。

 

 <logger name="logback.LogbackDemo" level="INFO" additivity="false">控制logback.LogbackDemo類的日誌打印，打印級別爲「INFO」；

additivity屬性爲false，表示此loger的打印信息再也不向上級傳遞，

指定了名字爲「STDOUT」的appender。

 

<root level="ERROR">將root的打印級別設置爲「ERROR」，指定了名字爲「STDOUT」的appender。

 

 當執行logback.LogbackDemo類的main方法時，先執行<logger name="logback.LogbackDemo" level="INFO" additivity="false">，將級別爲「INFO」及大於「INFO」的日誌信息交給此loger指定的名爲「STDOUT」的appender處理，在控制檯中打出日誌，再也不向次loger的上級 <logger name="logback"/> 傳遞打印信息；

<logger name="logback"/>未接到任何打印信息，固然也不會給它的上級root傳遞任何打印信息；

打印結果以下：  

Xml代碼   收藏代碼
  1. 14:05:35.937 [main] INFO  logback.LogbackDemo - ======info  
  2. 14:05:35.937 [main] WARN  logback.LogbackDemo - ======warn  
  3. 14:05:35.937 [main] ERROR logback.LogbackDemo - ======error  

 若是將<logger name="logback.LogbackDemo" level="INFO" additivity="false">修改成 <logger name="logback.LogbackDemo" level="INFO" additivity="true">那打印結果將是什麼呢？

沒錯，日誌打印了兩次，想必你們都知道緣由了，由於打印信息向上級傳遞，logger自己打印一次，root接到後又打印一次

打印結果以下：  

Xml代碼   收藏代碼
  1. 14:09:01.531 [main] INFO  logback.LogbackDemo - ======info  
  2. 14:09:01.531 [main] INFO  logback.LogbackDemo - ======info  
  3. 14:09:01.531 [main] WARN  logback.LogbackDemo - ======warn  
  4. 14:09:01.531 [main] WARN  logback.LogbackDemo - ======warn  
  5. 14:09:01.531 [main] ERROR logback.LogbackDemo - ======error  
  6. 14:09:01.531 [main] ERROR logback.LogbackDemo - ======error  

 

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

 

<appender>：

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

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

 

1.ConsoleAppender:

把日誌添加到控制檯，有如下子節點：

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

<target>：字符串 System.out 或者 System.err ，默認 System.out ；

例如：

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

 

2.FileAppender:

把日誌添加到文件，有如下子節點：

<file>：被寫入的文件名，能夠是相對目錄，也能夠是絕對目錄，若是上級目錄不存在會自動建立，沒有默認值。

<append>：若是是 true，日誌被追加到文件結尾，若是是 false，清空現存文件，默認是true。

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

<prudent>：若是是 true，日誌會被安全的寫入文件，即便其餘的FileAppender也在向此文件作寫入操做，效率低，默認是 false。

例如：

Xml代碼   收藏代碼
  1. <configuration>  
  2.   
  3.   <appender name="FILE" class="ch.qos.logback.core.FileAppender">  
  4.     <file>testFile.log</file>  
  5.     <append>true</append>  
  6.     <encoder>  
  7.       <pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern>  
  8.     </encoder>  
  9.   </appender>  
  10.           
  11.   <root level="DEBUG">  
  12.     <appender-ref ref="FILE" />  
  13.   </root>  
  14. </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天的日誌文件。

 

Java代碼   收藏代碼
  1. <configuration>   
  2.   <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">   
  3.       
  4.     <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">   
  5.       <fileNamePattern>logFile.%d{yyyy-MM-dd}.log</fileNamePattern>   
  6.       <maxHistory>30</maxHistory>    
  7.     </rollingPolicy>   
  8.    
  9.     <encoder>   
  10.       <pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern>   
  11.     </encoder>   
  12.   </appender>    
  13.    
  14.   <root level="DEBUG">   
  15.     <appender-ref ref="FILE" />   
  16.   </root>   
  17. </configuration>  

 

  例如：按照固定窗口模式生成日誌文件，當文件大於20MB時，生成新的日誌文件。窗口大小是1到3，當保存了3個歸檔文件後，將覆蓋最先的日誌。

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

 

4.另外還有SocketAppender、SMTPAppender、DBAppender、SyslogAppender、SiftingAppender，並不經常使用，這些就不在這裏講解了，你們能夠參考官方文檔。固然你們能夠編寫本身的Appender。

 

 

<encoder>：

負責兩件事，一是把日誌信息轉換成字節數組，二是把字節數組寫入到輸出流。

目前PatternLayoutEncoder 是惟一有用的且默認的encoder ，有一個<pattern>節點，用來設置日誌的輸入格式。使用「%」加「轉換符」方式，若是要輸出「%」，則必須用「\」對「\%」進行轉義。

例如：

Xml代碼   收藏代碼
  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
%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

 
C {length } 
class {length }		 輸出執行記錄請求的調用者的全限定名。參數與上面的同樣。儘可能避免使用，除非執行速度不形成任何問題。
contextName 
cn		 輸出上下文名稱。
d {pattern } 
date {pattern }		 輸出日誌的打印日誌，模式語法與java.text.SimpleDateFormat 兼容。 Conversion Pattern Result
%d 2006-10-20 14:06:49,812
%date 2006-10-20 14:06:49,812
%date{ISO8601} 2006-10-20 14:06:49,812
%date{HH:mm:ss.SSS} 14:06:49.812
%date{dd MMM yyyy ;HH:mm:ss.SSS} 20 oct. 2006;14:06:49.812
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', ''}"

 

 

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

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

第一個可選修飾符是左對齊 標誌，符號是減號「-」；接着是可選的最小寬度 修飾符，用十進制數表示。若是字符小於最小寬度，則左填充或右填充，默認是左填充（即右對齊），填充符爲空格。若是字符大於最小寬度，字符永遠不會被截斷。最大寬度 修飾符，符號是點號"."後面加十進制數。若是字符大於最大寬度，則從前面截斷。點符號「.」後面加減號「-」在加數字，表示從尾部截斷。

 

 

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

 

 

 

轉載出處：http://aub.iteye.com/blog/1101260， 尊重他人即尊重本身

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程