詳細整理了logback常用配置

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

logback 簡介

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

logback 常用配置詳解(二)<appender>

logback 常用配置詳解(三)<filter>

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


logback 自定義參數。logback 配置詳解(一)<configuration> and <logger>

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

logback logger。scan:

當此屬性設置為true時,配置文件如果發生改變,將會被重新加載,默認值為true。

scanPeriod:

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

debug:

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

例如:

Xml代碼

  1. <configurationscan="true"scanPeriod="60 seconds"debug="false">

  2. <!-- 其他配置省略-->

  3. </configuration>

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

120621645.png

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

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

Xml代碼

  1. <configurationscan="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. <configurationscan="true"scanPeriod="60 seconds"debug="false">

  2. <propertyname="APP_Name"value="myAppName"/>

  3. <contextName>${APP_Name}</contextName>

  4. <!-- 其他配置省略-->

  5. </configuration>

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

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

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

Xml代碼

  1. <configurationscan="true"scanPeriod="60 seconds"debug="false">

  2. <timestampkey="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. publicclass LogbackDemo { ?

  5. privatestatic Logger log = LoggerFactory.getLogger(LogbackDemo.class); ?

  6. publicstaticvoid 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. <appendername="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. <rootlevel="INFO">

  9. <appender-refref="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. <appendername="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. <loggername="logback"/>

  10. <rootlevel="DEBUG">

  11. <appender-refref="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. <appendername="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. <loggername="logback"/>

  10. <!--logback.LogbackDemo:類的全路徑 -->

  11. <loggername="logback.LogbackDemo"level="INFO"additivity="false">

  12. <appender-refref="STDOUT"/>

  13. </logger>

  14. <rootlevel="ERROR">

  15. <appender-refref="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 ?