1. 程式人生 > >logback logback.xml常用配置詳解(一) and

logback logback.xml常用配置詳解(一) and

  • 部落格分類: 
  • Log

詳細整理了logback常用配置,

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

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

logback 配置詳解(一)<configuration> and <logger>

一:根節點<configuration>包含的屬性:

scan:

當此屬性設定為true時,配置檔案如果發生改變,將會被重新載入,預設值為true。

scanPeriod:

設定監測配置檔案是否有修改的時間間隔,如果沒有給出時間單位,預設單位是毫秒。當scan為true時,此屬性生效。預設的時間間隔為1分鐘。

debug:

當此屬性設定為true時,將打印出logback內部日誌資訊,實時檢視logback執行狀態。預設值為false。

例如:

Xml程式碼 

 收藏程式碼

  1. <configuration scan="true" scanPeriod="60 seconds" debug="false">  
  2.       <!-- 其他配置省略-->  
  3. </configuration>  

二:根節點<configuration>的子節點:

 

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. import org.slf4j.Logger;  
  3. import org.slf4j.LoggerFactory;  
  4. public class LogbackDemo {  
  5.     private static Logger log = LoggerFactory.getLogger(LogbackDemo.class);  
  6.     public static void main(String[] args) {  
  7.         log.trace("======trace");  
  8.         log.debug("======debug");  
  9.         log.info("======info");  
  10.         log.warn("======warn");  
  11.         log.error("======error");  
  12.     }  
  13. }  

logback.xml配置檔案

第1種:只配置root

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.   <root level="INFO">             
  9.     <appender-ref ref="STDOUT" />   
  10.   </root>     
  11.  </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.   <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.   <!-- logback為java中的包 -->   
  9.   <logger name="logback"/>   
  10.   <root level="DEBUG">             
  11.     <appender-ref ref="STDOUT" />   
  12.   </root>     
  13.  </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.   <!-- logback為java中的包 -->   
  9.   <logger name="logback"/>   
  10.   <!--logback.LogbackDemo:類的全路徑 -->   
  11.   <logger name="logback.LogbackDemo" level="INFO" additivity="false">  
  12.     <appender-ref ref="STDOUT"/>  
  13.   </logger>   
  14.   <root level="ERROR">             
  15.     <appender-ref ref="STDOUT" />   
  16.   </root>     
  17. </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  

**下一篇將講Appender ** 

19 

3 

分享到: