學(xué)習(xí)Springboot組件Logback如何使用 附詳細(xì)內(nèi)容解析

一、導(dǎo)入依賴

普通項(xiàng)目

<dependency>
    <groupId>ch.qos.logback</groupId>
    <artifactId>logback-core</artifactId>
    <version>1.1.11</version>
</dependency>
<dependency>
    <groupId>ch.qos.logback</groupId>
    <artifactId>logback-classic</artifactId>
    <version>1.1.11</version>
</dependency>

springboot項(xiàng)目

<!--該依賴已經(jīng)集成了logback-->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>

二、配置文件解析

Logback默認(rèn)會(huì)到類路徑下找logback-test.xml and logback.xml

Spring Boot 會(huì)在 classpath 下查找是否有 logback-test.groovy、logback-test.xml、logback.groovy 或者 logback.xml，如果都找不到的話，才會(huì)加載項(xiàng)目路徑下的 logback-spring.xml

三、配置文件結(jié)構(gòu)

四、各個(gè)組件的作用

logger: 日志記錄器，root是特殊的logger-頂層logger,因?yàn)閘ogger具有繼承關(guān)系，稍后介紹

appender: 配置日志文件輸出目的地

encoder: 控制日志輸出格式，它是借助于layout實(shí)現(xiàn)的

rollingPolicy: RollingFileAppender具有該子元素，指定發(fā)生滾動(dòng)時(shí)的行為

triggeringPolicy： RollingFileAppender具有該子元素，指定何時(shí)發(fā)生滾動(dòng)過(guò)程，一般不用配置該元素，因?yàn)樽钍軞g迎的TimeBasedRollingPolicy ，它實(shí)現(xiàn)了rolling policy同時(shí)也實(shí)現(xiàn)了triggering policy。

filter: 對(duì)appender收到的日志進(jìn)行過(guò)濾，只有滿足Filter條件的日志才輸出到日志文件

五、Logger組件

logger組件具有父子層級(jí)關(guān)系，root是最頂層的logger。logger記錄器是命名實(shí)體。它們的名稱區(qū)分大小寫，并且遵循分層命名規(guī)則.

如果一個(gè)記錄器的名稱后跟一個(gè)點(diǎn)，則該記錄器是另一個(gè)記錄器的祖先，該后跟點(diǎn)的名稱是其后代記錄器名稱的前綴。如果記錄器與子記錄器之間沒(méi)有祖先，則稱該記錄器為子記錄器的父項(xiàng)。
例如，名為"com.foo"的記錄器是名為"com.foo.Bar"的記錄器的父項(xiàng)。同樣， "java"是"java.util"和"java.util.Vector"的祖先記錄器。大多數(shù)開發(fā)人員都應(yīng)該熟悉這種命名方案。

logger日志級(jí)別繼承

如果未為給定的記錄器分配一個(gè)級(jí)別，則它將從其最接近的祖先那里繼承一個(gè)已分配的級(jí)別。例如：
給定記錄器L的有效級(jí)別等于其層次結(jié)構(gòu)中的第一個(gè)非空級(jí)別，從L本身開始， 然后在層次結(jié)構(gòu)中向上尋找直到root logger。為了確保所有記錄器最終都可以繼承級(jí)別，root logger始終具有分配的級(jí)別，root logger默認(rèn)級(jí)別是DEBUG。

注意：如果日志記錄請(qǐng)求的級(jí)別高于或等于記錄器的有效級(jí)別，則該日志請(qǐng)求是有效的。日志級(jí)別按以下順序排序： TRACE < DEBUG < INFO < WARN < ERROR。

logger關(guān)聯(lián)的appender繼承

一個(gè)logger可以配置多個(gè)appender，logger輸出的日志會(huì)輸出到當(dāng)前記錄器綁定的appender和父級(jí)們logger(直到root logger)綁定的appender，可以設(shè)置additivity 屬性為false,則logger輸出的日志僅會(huì)輸出到當(dāng)前記錄器綁定的appender

六、logger屬性

• name：指定全限定包名
• level：日志輸出級(jí)別，如果沒(méi)有配置，則參考上面的級(jí)別繼承
• additivity：默認(rèn)為true,參考上面的appender繼承。

如果additivity為true，會(huì)存在重復(fù)輸出日志情況，如下所示

<configuration>
  <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
    <encoder>
      <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
    </encoder>
  </appender>
  <logger name="chapters.configuration">
    <appender-ref ref="STDOUT" />
  </logger>
  <root level="debug">
    <appender-ref ref="STDOUT" />
  </root>
</configuration>

那么chapters.configuration包下的日志會(huì)輸出兩遍到console控制臺(tái),如下所示

14:25:36.343 [main] INFO  chapters.configuration.MyApp3 - Entering application.
14:25:36.343 [main] INFO  chapters.configuration.MyApp3 - Entering application.
14:25:36.359 [main] DEBUG chapters.configuration.Foo - Did it again!
14:25:36.359 [main] DEBUG chapters.configuration.Foo - Did it again!
14:25:36.359 [main] INFO  chapters.configuration.MyApp3 - Exiting application.
14:25:36.359 [main] INFO  chapters.configuration.MyApp3 - Exiting application.

七、Appender組件

配置日志輸出的目的地，常用的有ConsoleAppender、FileAppender 、RollingFileAppender

ConsoleAppender

 <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
    <!--默認(rèn)System.out,也可以指定System.error -->
    <target>System.out</target>
    <!-- encoders 默認(rèn)類型ch.qos.logback.classic.encoder.PatternLayoutEncoder -->
    <encoder>
      <pattern>%-4relative [%thread] %-5level %logger{35} - %msg %n</pattern>
    </encoder>
  </appender>

寫日志到標(biāo)準(zhǔn)輸出流，可以配置target屬性為system.out,也可以指定System.error,默認(rèn)System.out

FileAppender

包含的子元素有

• append：如果為true，則追加到已存在的日志文件，否則截?cái)喱F(xiàn)有文件，默認(rèn)為true
• file: 指定日志寫入文件的名字。如果文件不存在，則創(chuàng)建包括父級(jí)目錄。windows系統(tǒng)要避開“”,正確例子可以指定為c:/temp/test.log或c:\temp\test.log
• encoder: 輸出的格式 RollingFileAppender

RollingFileAppender

擴(kuò)展了FileAppender，具有滾動(dòng)更新日志文件的功能；例如，RollingFileAppender可以登錄到一個(gè)名為log.txt的文件，一旦滿足某個(gè)條件，就可以保存當(dāng)前日志文件，并滾動(dòng)輸出到新的日志文件。

包含的子元素有

• append：如果為true，則追加到已存在的日志文件，否則截?cái)喱F(xiàn)有文件，默認(rèn)為true
• file: 指定日志寫入文件的名字。如果文件不存在，則創(chuàng)建包括父級(jí)目錄。windows系統(tǒng)要避開“”,正確例子可以指定為c:/temp/test.log或c:\temp\test.log
• encoder:輸出的格式
• rollingPolicy: 指定RollingFileAppender發(fā)生滾動(dòng)時(shí)的行為
• triggeringPolicy：指定RollingFileAppender何時(shí)發(fā)生滾動(dòng)過(guò)程

 rollingPolicy

rollingPolicy常用的有TimeBasedRollingPolicy、SizeAndTimeBasedRollingPolicy

TimeBasedRollingPolicy

TimeBasedRollingPolicy是最受歡迎的滾動(dòng)策略。它基于時(shí)間進(jìn)行滾動(dòng)，可以是按月或按天等。TimeBasedRollingPolicy承擔(dān)滾動(dòng)以及觸發(fā)所述滾動(dòng)的責(zé)任。它實(shí)現(xiàn)了rolling policy同時(shí)也實(shí)現(xiàn)了triggering policy。
包含的子元素有

• fileNamePattern：必選；它的值應(yīng)包括文件名以及適當(dāng)放置的％d轉(zhuǎn)換說(shuō)明符。所述 ％d由指定的轉(zhuǎn)換說(shuō)明可包含日期和時(shí)間模式 java.text.SimpleDateFormat類。如果省略了日期和時(shí)間模式，則采用默認(rèn)模式 yyyy-MM-dd；可以指定多個(gè)%d，但是只有一個(gè)主要的，其他的都要使用‘a(chǎn)ux'標(biāo)記，多個(gè)%d允許你組織對(duì)日志文件歸類，例如按照年月分文件夾/var/log/%d{yyyy/MM, aux}/myapplication.%d{yyyy-MM-dd}.log
• maxHistory：設(shè)置存檔文件保存時(shí)間，日志文件至少保存 15 天，因?yàn)橛行┊惓＞邆湟浴爸堋睘轭l次發(fā)生的特點(diǎn)。
• totalSizeCap：控制歸檔文件的大小

SizeAndTimeBasedRollingPolicy

支持按照時(shí)間拆分后，再按文件大小拆分

<appender name="ROLLING" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <file>mylog.txt</file>
    <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
      <!-- rollover daily -->
      <fileNamePattern>mylog-%d{yyyy-MM-dd}.%i.txt</fileNamePattern>
       <!-- each file should be at most 100MB, keep 60 days worth of history, but at most 			20GB -->
       <maxFileSize>100MB</maxFileSize>    
       <maxHistory>60</maxHistory>
       <totalSizeCap>20GB</totalSizeCap>
    </rollingPolicy>
    <encoder>
      <pattern>%msg%n</pattern>
    </encoder>
</appender>

"%i"表示當(dāng)日志文件達(dá)到“maxFileSize”它將按照遞增序列（以0開始）歸檔日志。

triggering policy

SizeBasedTriggeringPolicy

該triggering policy通過(guò)配置一個(gè)maxFileSize參數(shù)，當(dāng)日志文件超過(guò)該閾值，會(huì)通知RollingFileAppender 觸發(fā)日志翻滾。但一般triggering policy可以不用配置，TimeBasedRollingPolicy 已經(jīng)完美集成了。

補(bǔ)充：以上Appender都是本地記錄日志，logback也支持網(wǎng)絡(luò)輸出日志、本地?cái)?shù)據(jù)、郵件等；后續(xù)如果有需要再來(lái)研究。logback還可以使用AsyncAppender異步記錄日志。

Encoder

encoder負(fù)責(zé)轉(zhuǎn)換事件為字節(jié)數(shù)組并將字節(jié)數(shù)組寫入輸出流中。PatternLayoutEncoder 是最常用的encoder，該類通過(guò)使用PatternLayout來(lái)格式化日志事件。我們可以直接配置PatternLayoutEncoder ，而不用配置PatternLayout，它默認(rèn)使用PatternLayout進(jìn)行格式輸出。

layout

負(fù)責(zé)轉(zhuǎn)換事件成字符串，我們可以自定義layout，然后通過(guò)encoder引用

 <encoder class="ch.qos.logback.core.encoder.LayoutWrappingEncoder">
      <layout class="chapters.layouts.MySampleLayout" />
    </encoder>

PatternLayout

它將日志事件轉(zhuǎn)換成字符串，但是可以自定義字符串通過(guò)調(diào)整PatternLayout的轉(zhuǎn)換模式。

PatternLayout的轉(zhuǎn)換模式跟C語(yǔ)言的printf()函數(shù)緊密相關(guān)。
常用的模式有：

% d{pattern}: 日期

% level 日志級(jí)別

%thread 線程名稱

%class 全限定類名，日志請(qǐng)求記錄所在的類

%method 日志請(qǐng)求記錄所在的方法

%line 日志請(qǐng)求記錄的行號(hào)

%n 換行

%logger{length} 輸出日志logger記錄器的名字，length指定輸出名字長(zhǎng)度，logback會(huì)智能縮寫而不丟失語(yǔ)義。

%msg 輸出日志記錄器記錄的消息

<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
    <!--格式化輸出：%d表示日期，%thread表示線程名，%-5level：級(jí)別從左顯示5個(gè)字符寬度%msg：日志消息，%n是換行符-->
    <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS,CTT} %-5level [%thread] [%class:%line] %logger{50} - %msg%n</pattern>
</encoder>

多個(gè)模式之間分隔符，在大多數(shù)情況下，文字需包含空格或其他分隔字符（'[',']','-'），這樣就不會(huì)與轉(zhuǎn)換詞混淆

Filter

對(duì)appender收到的日志調(diào)用decide方法進(jìn)行過(guò)濾，只有滿足Filter條件的日志才輸出到日志文件，decide方法有三個(gè)返回值，DENY、ACCEPT、NEUTRAL

• 如果返回的值為DENY，則立即刪除日志事件，而不咨詢其余的篩選器;
• 如果返回的值是NEUTRAL中性的，則查詢列表中的下一個(gè)篩選器,如果沒(méi)有其他篩選器可供查詢，則日志事件將正常處理;
• 如果返回值為ACCEPT，則會(huì)立即處理日志事件，跳過(guò)其余篩選器的調(diào)用。

 LevelFilter

該過(guò)濾器對(duì)日志的級(jí)別過(guò)濾，如果事件日志級(jí)別等于配置的級(jí)別，過(guò)濾器接受或者拒絕該事件日志，依賴于onMatch 和 onMismatch屬性

<appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
    <filter class="ch.qos.logback.classic.filter.LevelFilter">
      <level>INFO</level>
      <onMatch>ACCEPT</onMatch>
      <onMismatch>DENY</onMismatch>
    </filter>
    <encoder>
      <pattern>
        %-4relative [%thread] %-5level %logger{30} - %msg%n
      </pattern>
    </encoder>
</appender>

ThresholdFilter

過(guò)濾低于指定閾值的事件。對(duì)于等于或高于閾值的事件，將在調(diào)用其（）方法時(shí)響應(yīng)NEUTRAL 。但是，級(jí)別低于閾值的事件將被拒絕。

 <!-- deny all events with a level below INFO, that is TRACE and DEBUG -->
    <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
      <level>INFO</level>
    </filter>

EvaluatorFilter

EvaluatorFilter 是封裝了的通用過(guò)濾器 EventEvaluator。顧名思義， 評(píng)估對(duì)象是否滿足給定事件的給定條件。在匹配和不匹配時(shí)，托管將分別返回由onMatch 或onMismatch屬性指定的值。
GEventEvaluator 實(shí)現(xiàn)了EventEvaluator，通過(guò)子元素采用任意Groovy語(yǔ)言布爾表達(dá)式作為評(píng)估標(biāo)準(zhǔn)的具體實(shí)現(xiàn)
JaninoEventEvaluator實(shí)現(xiàn)了EventEvaluator，通過(guò)子元素采用任意Java語(yǔ)言塊返回布爾值作為評(píng)估標(biāo)準(zhǔn)。

uatorFilter

EvaluatorFilter 是封裝了的通用過(guò)濾器 EventEvaluator。顧名思義， 評(píng)估對(duì)象是否滿足給定事件的給定條件。在匹配和不匹配時(shí)，托管將分別返回由onMatch 或onMismatch屬性指定的值。
GEventEvaluator 實(shí)現(xiàn)了EventEvaluator，通過(guò)子元素采用任意Groovy語(yǔ)言布爾表達(dá)式作為評(píng)估標(biāo)準(zhǔn)的具體實(shí)現(xiàn)
JaninoEventEvaluator實(shí)現(xiàn)了EventEvaluator，通過(guò)子元素采用任意Java語(yǔ)言塊返回布爾值作為評(píng)估標(biāo)準(zhǔn)。

EvaluatorFilter 也可通過(guò)子元素支持正則匹配。

到此這篇關(guān)于詳解Springboot之Logback的使用學(xué)習(xí)的文章就介紹到這了,更多相關(guān)Logback詳解內(nèi)容，請(qǐng)搜索W3Cschool以前的文章或繼續(xù)瀏覽下面的相關(guān)文章，也希望大家以后多多支持！