logback 配置詳解（一）

一：根節點<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>設定成其他名字，用于區分不同應用程式的記錄。一旦設定，不能修改。

2.       <contextName>myAppName</contextName>  

2.2設定變量： <property>

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

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

2.       <property name="APP_Name" value="myAppName" />   
3.       <contextName>${APP_Name}</contextName>  
5. </configuration>   

2.3擷取時間戳字元串：<timestamp>

兩個屬性 key:辨別此<timestamp> 的名字；datePattern：設定将目前時間（解析配置檔案的時間）轉換為字元串的模式，遵循java.txt.SimpleDateFormat的格式。

        例如将解析配置檔案的時間作為上下文名稱：

2.       <timestamp key="bySecond" datePattern="yyyyMMdd'T'HHmmss"/>   
3.       <contextName>${bySecond}</contextName>  

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".

用來設定列印級别，大小寫無關：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

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将資訊列印到控制台；

列印結果如下：

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，

8.   <!-- logback為java中的包 -->   
9.   <logger name="logback"/>   
10.   <root level="DEBUG">             

<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将資訊列印到控制台；

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  

2.    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">   
10.   <!--logback.LogbackDemo：類的全路徑 -->   
11.   <logger name="logback.LogbackDemo" level="INFO" additivity="false">  
12.     <appender-ref ref="STDOUT"/>  
13.   </logger>   
14.   <root level="ERROR">             

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

 <logger name="logback.LogbackDemo" level="INFO" additivity="false">控制logback.LogbackDemo類的日志列印，列印級别為“INFO”；

additivity屬性為false，表示此loger的列印資訊不再向上級傳遞，

指定了名字為“STDOUT”的appender。

<root level="DEBUG">将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傳遞任何列印資訊；

列印結果如下：  

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接到後又列印一次

1. 14:09:01.531 [main] INFO  logback.LogbackDemo - ======info  
3. 14:09:01.531 [main] WARN  logback.LogbackDemo - ======warn  
5. 14:09:01.531 [main] ERROR logback.LogbackDemo - ======error