logback logback.xml常用配置詳解（一）

（一）logback  java使用

一、 logback介紹

 

Logback是由log4j創始人設計的又一個開源日誌組件。logback當前分成三個模塊：logback-core,logback- classic和logback-access。logback-core是其它兩個模塊的基礎模塊。logback-classic是log4j的一個 改良版本。此外logback-classic完整實現SLF4J API使你可以很方便地更換成其它日誌系統如log4j或JDK14 Logging。logback-access訪問模塊與Servlet容器集成提供通過Http來訪問日誌的功能（來源於百度百科）。

 

二、maven依賴

 

[html] view plain copy

1. <!-- logback+slf4j -->    
2. <dependency>    
3.     <groupId>org.slf4j</groupId>    
4.     <artifactId>slf4j-api</artifactId>    
5.     <version>1.6.0</version>    
6.     <type>jar</type>    
7.     <scope>compile</scope>    
8. </dependency>    
9. <dependency>    
10.     <groupId>ch.qos.logback</groupId>    
11.     <artifactId>logback-core</artifactId>    
12.     <version>0.9.28</version>    
13.     <type>jar</type>    
14. </dependency>    
15. <dependency>    
16.     <groupId>ch.qos.logback</groupId>    
17.     <artifactId>logback-classic</artifactId>    
18.     <version>0.9.28</version>    
19.     <type>jar</type>    
20. </dependency>    

如果你沒有使用maven，那麼你自己去下載jar包吧...

 

 

三.日誌 使用

 

我們使用org.slf4j.LoggerFactory，就可以直接使用日誌了。

 

 

[java] view plain copy

1. public class TestController extends BaseController {    
2.   
3.   
4.     protected final Logger    logger = LoggerFactory.getLogger(TestController.class);    
5.     
6.     public void hello(){    
7.         logger.debug("DEBUG TEST 這個地方輸出DEBUG級別的日誌");    
8.         logger.info("INFO test 這個地方輸出INFO級別的日誌");    
9.         logger.error("ERROR test 這個地方輸出ERROR級別的日誌");    
10.     }    
11.     
12. }  

 

 

 

（二）logback  配置詳解

 

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

• scan: 當此屬性設置爲true時，配置文件如果發生改變，將會被重新加載，默認值爲true。
• scanPeriod: 設置監測配置文件是否有修改的時間間隔，如果沒有給出時間單位，默認單位是毫秒。當scan爲true時，此屬性生效。默認的時間間隔爲1分鐘。
• debug: 當此屬性設置爲true時，將打印出logback內部日誌信息，實時查看logback運行狀態。默認值爲false。

例如：

 

 

[html] view plain copy

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

 

 

 

 

 

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

設置上下文名稱：<contextName>

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

 

 

[html] view plain copy

1. <!-- lang: xml-->  
2. <configuration scan="true" scanPeriod="60 seconds" debug="false">    
3.       <contextName>myAppName</contextName>    
4.       <!-- 其他配置省略-->    
5. </configuration>  

 

 

 

 

 

 

設置變量： <property>

用來定義變量值的標籤，<property> 有兩個屬性name和value；

• name: 變量的名稱
• value: 的值時變量定義的值。

通過<property>定義的值會被插入到logger上下文中。定義變量後，可以使“${}”來使用變量。

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

 

 

[html] view plain copy

1. <!-- lang: xml-->  
2. <configuration scan="true" scanPeriod="60 seconds" debug="false">    
3.       <property name="APP_Name" value="myAppName" />     
4.       <contextName>${APP_Name}</contextName>    
5.       <!-- 其他配置省略-->    
6. </configuration>  

 

 

 

 

 

 

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

兩個屬性:

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

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

 

 

[html] view plain copy

1. <!-- lang: xml-->  
2. <configuration scan="true" scanPeriod="60 seconds" debug="false">    
3.       <timestamp key="bySecond" datePattern="yyyyMMdd'T'HHmmss"/>     
4.       <contextName>${bySecond}</contextName>    
5.       <!-- 其他配置省略-->    
6. </configuration>  

 

 

設置loger：

 

 

<loger>

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

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

• level: 用來設置打印級別，大小寫無關：TRACE, DEBUG, INFO,WARN,ERROR,ALL和OFF，還有一個特俗值INHERITED或者同義詞NULL`，代表強制執行上級的級別。 如果未設置此屬性，那麼當前loger將會繼承上級的級別。

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

<root>

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

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

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

例如： LogbackDemo.java類

 

 

[java] view plain copy

1. <!-- lang: java-->  
2. package logback;    
3.   
4. import org.slf4j.Logger;    
5. import org.slf4j.LoggerFactory;    
6.   
7. public class LogbackDemo {    
8.     private static Logger log = LoggerFactory.getLogger(LogbackDemo.class);    
9.     public static void main(String[] args) {    
10.         log.trace("======trace");    
11.         log.debug("======debug");    
12.         log.info("======info");    
13.         log.warn("======warn");    
14.         log.error("======error");    
15.     }    
16. }  

[java] view plain copy

1. <span style="font-family: Arial, Helvetica, sans-serif; background-color: rgb(255, 255, 255);">  
2. </span>  

[java] view plain copy

1. <span style="font-family: Arial, Helvetica, sans-serif; background-color: rgb(255, 255, 255);">  
2. </span>  

三、logback.xml配置文件

第1種：只配置root

 

 

[html] view plain copy

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

 

 

 

 

 

其中appender的配置表示打印到控制檯(稍後詳細講解appender )； <root level="INFO">將root的打印級別設置爲“INFO”，指定了名字爲“STDOUT”的appender。

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

打印結果如下：

 

 

[java] view plain copy

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：

 

 

[html] view plain copy

1. <!-- lang: xml-->  
2. <configuration>     
3.   
4.   <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">     
5.     <!-- encoder 默認配置爲PatternLayoutEncoder -->     
6.     <encoder>     
7.       <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>     
8.     </encoder>     
9.   </appender>     
10.   
11.   <!-- logback爲java中的包 -->     
12.   <logger name="logback"/>     
13.   
14.   <root level="DEBUG">               
15.     <appender-ref ref="STDOUT" />     
16.   </root>       
17.   
18. </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將信息打印到控制檯；

打印結果如下：

 

 

[java] view plain copy

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:

 

 

[html] view plain copy

1. <!-- lang: xml-->  
2. <configuration>     
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.   <!--logback.LogbackDemo：類的全路徑 -->     
13.   <logger name="logback.LogbackDemo" level="INFO" additivity="false">    
14.     <appender-ref ref="STDOUT"/>    
15.   </logger>     
16.   
17.   <root level="ERROR">               
18.     <appender-ref ref="STDOUT" />     
19.   </root>       
20. </configuration>  

 

 

 

 

輸出結果：

[java] view plain copy

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  

 

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

沒有設置appender，此logger本身不打印任何信息。

<logger name=”logback.LogbackDemo” level=”INFO” additivity=”false”>控制logback.LogbackDemo類的日誌打印，打印級別爲“INFO”。
additivity屬性爲false，表示此logger的打印信息不再向上級傳遞，指定了名字爲“STDOUT”的appender。

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

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

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

如果將<logger name=”logback.LogbackDemo” level=”INFO” additivity=”false”>修改爲 <logger name=”logback.LogbackDemo” level=”INFO” additivity=”true”>那打印結果將是什麼呢？
沒錯，日誌打印了兩次，想必大家都知道原因了，因爲打印信息向上級傳遞，logger本身打印一次，root接到後又打印一次：

 

[java] view plain copy

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