logback.xml 常用配置詳解

最近一個項目中用到logback來配置日志,網上找來找去都太零碎,而且重復太多,沒有一個全面的介紹怎么配置的,這里我就整理一下。

根節點<configuration>包含的屬性

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

例如:

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

根節點<configuration>的子節點

結構目錄如下:

image

設置上下文名稱:<contextName>

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

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

設置變量: <property>

用來定義變量值的標簽,<property> 有兩個屬性name和value:

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

通過<property>定義的值會被插入到logger上下文中。定義變量后,可以使“${}”來使用變量;例如使用<property>定義上下文名稱,然后在<contentName>設置logger上下文時使用,如下:

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

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

  • key: 標識此<timestamp> 的名字;
  • datePattern: 設置將當前時間(解析配置文件的時間)轉換為字符串的模式,遵循java.txt.SimpleDateFormat的格式。

例如將解析配置文件的時間作為上下文名稱,如下:

<!-- lang: xml-->
<configuration scan="true" scanPeriod="60 seconds" debug="false">  
      <timestamp key="bySecond" datePattern="yyyyMMdd'T'HHmmss"/>   
      <contextName>${bySecond}</contextName>  
      <!-- 其他配置省略-->  
</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類

<!-- lang: java-->
package logback;  

import org.slf4j.Logger;  
import org.slf4j.LoggerFactory;  

public class LogbackDemo {  
    private static Logger log = LoggerFactory.getLogger(LogbackDemo.class);  
    public static void main(String[] args) {  
        log.trace("======trace");  
        log.debug("======debug");  
        log.info("======info");  
        log.warn("======warn");  
        log.error("======error");  
    }  
}

logback.xml配置文

第1種:只配置root

<configuration>   
  <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">   
    <!-- encoder 默認配置為PatternLayoutEncoder -->   
    <encoder>   
      <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>   
    </encoder>   
  </appender>   
  <root level="INFO">             
    <appender-ref ref="STDOUT" />   
  </root>     
</configuration>

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

當執行logback.LogbackDemo類的main方法時,root將級別為“INFO”及大于“INFO”的日志信息交給已經配置好的名為“STDOUT”的appender處理,“STDOUT”appender將信息打印到控制臺;

打印結果如下:

13:30:38.484 [main] INFO  logback.LogbackDemo - ======info  
13:30:38.500 [main] WARN  logback.LogbackDemo - ======warn  
13:30:38.500 [main] ERROR logback.LogbackDemo - ======error 

第2種:帶有loger的配置,不指定級別,不指定appender:

<!-- lang: xml-->
<configuration>   
  <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">   
    <!-- encoder 默認配置為PatternLayoutEncoder -->   
    <encoder>   
      <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>   
    </encoder>   
  </appender>   
  <!-- logback為java中的包 -->   
  <logger name="logback"/>   
  <root level="DEBUG">             
    <appender-ref ref="STDOUT" />   
  </root>     
</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將信息打印到控制臺;

打印結果如下:

13:19:15.406 [main] DEBUG logback.LogbackDemo - ======debug  
13:19:15.406 [main] INFO  logback.LogbackDemo - ======info  
13:19:15.406 [main] WARN  logback.LogbackDemo - ======warn  
13:19:15.406 [main] ERROR logback.LogbackDemo - ======error

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

<!-- lang: xml-->
<configuration>   
   <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">   
    <!-- encoder 默認配置為PatternLayoutEncoder -->   
    <encoder>   
      <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>   
    </encoder>   
  </appender>   
  <!-- logback為java中的包 -->   
  <logger name="logback"/>   
  <!--logback.LogbackDemo:類的全路徑 -->   
  <logger name="logback.LogbackDemo" level="INFO" additivity="false">  
    <appender-ref ref="STDOUT"/>  
  </logger>   
  <root level="ERROR">             
    <appender-ref ref="STDOUT" />   
  </root>     
</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="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傳遞任何打印信息;

打印結果如下:

4:09:01.531 [main] INFO  logback.LogbackDemo - ======info  
14:09:01.531 [main] INFO  logback.LogbackDemo - ======info  
14:09:01.531 [main] WARN  logback.LogbackDemo - ======warn  
14:09:01.531 [main] WARN  logback.LogbackDemo - ======warn  
14:09:01.531 [main] ERROR logback.LogbackDemo - ======error  
14:09:01.531 [main] ERROR logback.LogbackDemo - ======error
最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。

推薦閱讀更多精彩內容

  • 在應用程序中添加日志記錄總的來說基于三個目的:監視代碼中變量的變化情況,周期性的記錄到文件中供其他應用進行統計分析...
    時待吾閱讀 5,077評論 1 13
  • logback詳解 說明:下面內容從網上搜集整理而來 與log4j對比 更快的執行速度: 基于我們先前在log4j...
    億萬年星空閱讀 3,078評論 1 1
  • 在應用程序中添加日志記錄總的來說基于三個目的:監視代碼中變量的變化情況,周期性的記錄到文件中供其他應用進行統計分析...
    時待吾閱讀 5,014評論 0 6
  • 一:根節點包含的屬性: scan: 當此屬性設置為true時,配置文件如果發生改變,將會被重新加載,默認值為tru...
    把愛放下會走更遠閱讀 648評論 0 0
  • 大妹開了一家名叫浩康源的養生館:專業美容養生,周末沒事,她讓我去幫忙。 呵呵!我等懶惰之人,幫忙是假,湊個人數、熱...
    枯藤殘鴉閱讀 489評論 1 3