玩转LogBack
玩轉LogBack
零、 目錄
一、 概述
二、 配置詳解
根節點<configuration>包含的屬性
scan：當此屬性設置為true時，配置文件如果發生改變，將會被重新加載，默認值為true.
scanPeriod：設置監測配置文件是否有修改的時間間隔，如果沒有給出時間單位，默認單位是毫秒。當scan為true時，此屬性生效。默認的時間間隔為1分鐘.
debug：當此屬性設置為true時，將打印出logback內部日志信息，實時查看logback運行狀態。默認值為false。
<configuration scan="true" scanPeriod="60 second" debug="false"> <!-- 其他配置省略--> </configuration>根節點<configuration>的子節點
LogBack的配置大概包括3部分：appender, logger和root。
設置上下文名稱<contextName>:每個logger都關聯到logger上下文，默認上下文名稱為“default”。但可以使用<contextName>設置成其他名字，用于區分不同應用程序的記錄。一旦設置，不能修改。
<configuration scan="true" scanPeriod="60 second" debug="false"> <contextName>myAppName</contextName> <!-- 其他配置省略--> </configuration>設置變量 <property> :用來定義變量值的標簽，<property> 有兩個屬性，name和value；其中name的值是變量的名稱，value的值時變量定義的值。通過<property>定義的值會被插入到logger上下文中。定義變量后，可以使“${}”來使用變量。
<configuration scan="true" scanPeriod="60 second" debug="false"> <property name="APP_Name" value="myAppName" /> <contextName>${APP_Name}</contextName> <!-- 其他配置省略--> </configuration>獲取時間戳字符串 <timestamp> : 兩個屬性 key:標識此<timestamp> 的名字；datePattern：設置將當前時間（解析配置文件的時間）轉換為字符串的模式，遵循Java.txt.SimpleDateFormat的格式。
<configuration scan="true" scanPeriod="60 second" debug="false"> <timestamp key="bySecond" datePattern="yyyyMMdd'T'HHmmss"/> <contextName>${bySecond}</contextName> <!-- 其他配置省略--> </configuration>設置logger和root:
案例介紹
案例1 ：最簡案例
首先，Java類如下：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配置文件只配置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 ：帶有logger的配置，不指定級別，不指定appender
帶有logger的配置，不指定級別，不指定appender<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的配置表示打印到控制臺。輸出結果：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<logger name=”logback” />將控制logback包下的所有類的日志的打印，但是并沒有設置打印級別，所以繼承他的上級<root>的日志級別“DEBUG”。沒有設置additivity，默認為true，將此logger的打印信息向上級傳遞。沒有設置appender，此logger本身不打印任何信息。<root level=”DEBUG”>將root的打印級別設置為“DEBUG”，指定了名字為“STDOUT”的appender。當執行logback.LogbackDemo類的main方法時，因為LogbackDemo 在包logback中，所以首先執行<logger name=”logback” />，將級別為“DEBUG”及大于“DEBUG”的日志信息傳遞給root，本身并不打印。root接到下級傳遞的信息，交給已經配置好的名為“STDOUT”的appender處理，“STDOUT”appender將信息打印到控制臺。案例3：帶有多個logger的配置，指定級別，指定appender
帶有多個logger的配置，指定級別，指定appender<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>輸出結果：14:05:35.937 [main] INFO logback.LogbackDemo - ======info 14:05:35.937 [main] WARN logback.LogbackDemo - ======warn 14:05:35.937 [main] ERROR logback.LogbackDemo - ======error<logger name=”logback” />將控制logback包下的所有類的日志的打印，但是并沒用設置打印級別，所以繼承他的上級<root>的日志級別“DEBUG”。沒有設置additivity，默認為true，將此logger的打印信息向上級傳遞。沒有設置appender，此logger本身不打印任何信息。<logger name=”logback.LogbackDemo” level=”INFO” additivity=”false”>控制logback.LogbackDemo類的日志打印，打印級別為“INFO”。additivity屬性為false，表示此logger的打印信息不再向上級傳遞，指定了名字為“STDOUT”的appender。<root level=”ERROR”>將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接到后又打印一次：14: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<appender>詳解
是的子節點，是負責寫日志的組件。有兩個必要屬性name和class。name指定appender名稱，class指定appender的全限定名。
ConsoleAppender：把日志添加到控制臺，有以下子節點
<encoder>：對日志進行格式化。（具體參數稍后講解 ）
<target>：字符串 System.out 或者 System.err ，默認 System.out .
<configuration> <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender"> <encoder> <pattern>%-4relative [%thread] %-5level %logger{35} - %msg %n</pattern> </encoder> </appender> <root level="DEBUG"> <appender-ref ref="STDOUT" /> </root> </configuration>FileAppender :把日志添加到文件，有以下子節點
：被寫入的文件名，可以是相對目錄，也可以是絕對目錄，如果上級目錄不存在會自動創建，沒有默認值。
：如果是 true，日志被追加到文件結尾，如果是 false，清空現存文件，默認是true。
：對記錄事件進行格式化。（具體參數稍后講解 ）
：如果是 true，日志會被安全的寫入文件，即使其他的FileAppender也在向此文件做寫入操作，效率低，默認是 false。
<configuration> <appender name="FILE" class="ch.qos.logback.core.FileAppender"> <file>testFile.log</file> <append>true</append> <encoder> <pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern> </encoder> </appender> <root level="DEBUG"> <appender-ref ref="FILE" /> </root> </configuration>RollingFIleAppender：滾動記錄文件，先將日志記錄到指定文件，當符合某個條件時，將日志記錄到其他文件。有以下子節點：
<maxFileSize>:這是活動文件的大小，默認值是10MB。
例如：每天生產一個日志文件，保存30天的日志文件<configuration> <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender"> <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"> <fileNamePattern>logFile.%d{yyyy-MM-dd}.log</fileNamePattern> <maxHistory>30</maxHistory> </rollingPolicy> <encoder> <pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern> </encoder> </appender> <root level="DEBUG"> <appender-ref ref="FILE" /> </root> </configuration>又例如：按照固定窗口模式生成日志文件，當文件大于20MB時，生成新的日志文件。窗口大小是1到3，當保存了3個歸檔文件后，將覆蓋最早的日志。<configuration> <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender"> <file>test.log</file> <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy"> <fileNamePattern>tests.%i.log.zip</fileNamePattern> <minIndex>1</minIndex> <maxIndex>3</maxIndex> </rollingPolicy> <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy"> <maxFileSize>5MB</maxFileSize> </triggeringPolicy> <encoder> <pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern> </encoder> </appender> <root level="DEBUG"> <appender-ref ref="FILE" /> </root> </configuration>另外還有SocketAppender、SMTPAppender、DBAppender、SyslogAppender、SiftingAppender，并不常用，這些就不在這里講解了，大家可以參考官方文檔。當然大家可以編寫自己的Appender。<encoder>： 負責兩件事，一是把日志信息轉換成字節數組，二是把字節數組寫入到輸出流。
目前PatternLayoutEncoder 是唯一有用的且默認的encoder ，有一個節點，用來設置日志的輸入格式。使用“%”加“轉換符”方式，如果要輸出“%”，則必須用“\”對“%”進行轉義。
可選的格式修飾符位于“%”和轉換符之間。第一個可選修飾符是左對齊 標志，符號是減號“-”；接著是可選的最小寬度 修飾符，用十進制數表示。如果字符小于最小寬度，則左填充或右填充，默認是左填充（即右對齊），填充符為空格。如果字符大于最小寬度，字符永遠不會被截斷。最大寬度 修飾符，符號是點號”.”后面加十進制數。如果字符大于最大寬度，則從前面截斷。點符號“.”后面加減號“-”在加數字，表示從尾部截斷。 例如：%-4relative 表示，將輸出從程序啟動到創建日志記錄的時間 進行左對齊 且最小寬度為4。
三、 完整配置案例
最后附上相對比較完整的，涵蓋大部分配置的案例，案例中有解析。
<?xml version="1.0" encoding="UTF-8"?> <!-- -scan:當此屬性設置為true時，配置文件如果發生改變，將會被重新加載，默認值為true -scanPeriod:設置監測配置文件是否有修改的時間間隔，如果沒有給出時間單位，默認單位是毫秒。 - 當scan為true時，此屬性生效。默認的時間間隔為1分鐘 -debug:當此屬性設置為true時，將打印出logback內部日志信息，實時查看logback運行狀態。默認值為false。 - - configuration 子節點為 appender、logger、root --> <configuration scan="true" scanPeriod="60 second" debug="false"><!-- 負責寫日志,控制臺日志 --><appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender"><!-- 一是把日志信息轉換成字節數組,二是把字節數組寫入到輸出流 --><encoder><Pattern>[%d{yyyy-MM-dd HH:mm:ss.SSS}] [%5level] [%thread] %logger{0} %msg%n</Pattern><charset>UTF-8</charset></encoder></appender><!-- 文件日志 --><appender name="DEBUG" class="ch.qos.logback.core.FileAppender"><file>debug.log</file><!-- append: true,日志被追加到文件結尾; false,清空現存文件;默認是true --><append>true</append><filter class="ch.qos.logback.classic.filter.LevelFilter"><!-- LevelFilter: 級別過濾器，根據日志級別進行過濾 --><level>DEBUG</level><onMatch>ACCEPT</onMatch><onMismatch>DENY</onMismatch></filter><encoder><Pattern>[%d{yyyy-MM-dd HH:mm:ss.SSS}] [%5level] [%thread] %logger{0} %msg%n</Pattern><charset>UTF-8</charset></encoder></appender><!-- 滾動記錄文件，先將日志記錄到指定文件，當符合某個條件時，將日志記錄到其他文件 --><appender name="INFO" class="ch.qos.logback.core.rolling.RollingFileAppender"><File>info.log</File><!-- ThresholdFilter:臨界值過濾器，過濾掉 TRACE 和 DEBUG 級別的日志 --><filter class="ch.qos.logback.classic.filter.ThresholdFilter"><level>INFO</level></filter><encoder><Pattern>[%d{yyyy-MM-dd HH:mm:ss.SSS}] [%5level] [%thread] %logger{0} %msg%n</Pattern><charset>UTF-8</charset></encoder><rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"><!-- 每天生成一個日志文件，保存30天的日志文件- 如果隔一段時間沒有輸出日志，前面過期的日志不會被刪除，只有再重新打印日志的時候，會觸發刪除過期日志的操作。--><fileNamePattern>info.%d{yyyy-MM-dd}.log</fileNamePattern><maxHistory>30</maxHistory><TimeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP"><maxFileSize>100MB</maxFileSize></TimeBasedFileNamingAndTriggeringPolicy></rollingPolicy></appender ><!--<!– 異常日志輸出 –>--><!--<appender name="EXCEPTION" class="ch.qos.logback.core.rolling.RollingFileAppender">--><!--<file>exception.log</file>--><!--<!– 求值過濾器，評估、鑒別日志是否符合指定條件. 需要額外的兩個JAR包，commons-compiler.jar和janino.jar –>--><!--<filter class="ch.qos.logback.core.filter.EvaluatorFilter">--><!--<!– 默認為 ch.qos.logback.classic.boolex.JaninoEventEvaluator –>--><!--<evaluator>--><!--<!– 過濾掉所有日志消息中不包含"Exception"字符串的日志 –>--><!--<expression>return message.contains("Exception");</expression>--><!--</evaluator>--><!--<OnMatch>ACCEPT</OnMatch>--><!--<OnMismatch>DENY</OnMismatch>--><!--</filter>--><!--<triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">--><!--<!– 觸發節點，按固定文件大小生成，超過5M，生成新的日志文件 –>--><!--<maxFileSize>5MB</maxFileSize>--><!--</triggeringPolicy>--><!--</appender>--><appender name="ERROR" class="ch.qos.logback.core.rolling.RollingFileAppender"><file>error.log</file><encoder><Pattern>[%d{yyyy-MM-dd HH:mm:ss.SSS}] [%5level] [%thread] %logger{0} %msg%n</Pattern><charset>UTF-8</charset></encoder><!-- 按照固定窗口模式生成日志文件，當文件大于20MB時，生成新的日志文件。- 窗口大小是1到3，當保存了3個歸檔文件后，將覆蓋最早的日志。- 可以指定文件壓縮選項--><rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy"><fileNamePattern>error.%d{yyyy-MM}(%i).log.zip</fileNamePattern><minIndex>1</minIndex><maxIndex>3</maxIndex><timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP"><maxFileSize>100MB</maxFileSize></timeBasedFileNamingAndTriggeringPolicy><maxHistory>30</maxHistory></rollingPolicy></appender><!-- 異步輸出 --><appender name ="ASYNC" class= "ch.qos.logback.classic.AsyncAppender"><!-- 不丟失日志.默認的,如果隊列的80%已滿,則會丟棄TRACT、DEBUG、INFO級別的日志 --><discardingThreshold >0</discardingThreshold><!-- 更改默認的隊列的深度,該值會影響性能.默認值為256 --><queueSize>512</queueSize><!-- 添加附加的appender,最多只能添加一個 --><appender-ref ref ="ERROR"/></appender><!--- 1.name：包名或類名，用來指定受此logger約束的某一個包或者具體的某一個類- 2.未設置打印級別，所以繼承他的上級<root>的日志級別“DEBUG”- 3.未設置additivity，默認為true，將此logger的打印信息向上級傳遞；- 4.未設置appender，此logger本身不打印任何信息，級別為“DEBUG”及大于“DEBUG”的日志信息傳遞給root，- root接到下級傳遞的信息，交給已經配置好的名為“STDOUT”的appender處理，“STDOUT”appender將信息打印到控制臺；--><logger name="ch.qos.logback" /><!--- 1.將級別為“INFO”及大于“INFO”的日志信息交給此logger指定的名為“STDOUT”的appender處理，在控制臺中打出日志，- 不再向次logger的上級 <logger name="logback"/> 傳遞打印信息- 2.level：設置打印級別（TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF），還有一個特殊值INHERITED或者同義詞NULL，代表強制執行上級的級別。- 如果未設置此屬性，那么當前logger將會繼承上級的級別。- 3.additivity：為false，表示此logger的打印信息不再向上級傳遞,如果設置為true，會打印兩次- 4.appender-ref：指定了名字為"STDOUT"的appender。--><logger name="com.weizhi.common.LogMain" level="INFO" additivity="false"><appender-ref ref="STDOUT"/><!--<appender-ref ref="DEBUG"/>--><!--<appender-ref ref="EXCEPTION"/>--><!--<appender-ref ref="INFO"/>--><!--<appender-ref ref="ERROR"/>--><appender-ref ref="ASYNC"/></logger><!--- 根logger- level:設置打印級別，大小寫無關：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，不能設置為INHERITED或者同義詞NULL。- 默認是DEBUG。-appender-ref:可以包含零個或多個<appender-ref>元素，標識這個appender將會添加到這個logger--><root level="DEBUG"><appender-ref ref="STDOUT"/><!--<appender-ref ref="DEBUG"/>--><!--<appender-ref ref="EXCEPTION"/>--><!--<appender-ref ref="INFO"/>--><appender-ref ref="ASYNC"/></root> </configuration>總結
- 上一篇： Netty实战 IM即时通讯系统（九）实
- 下一篇： Git《一》简介及安装使用