詳解Springboot之Logback的使用學習
普通項目
<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項目
<!--該依賴已經集成了logback--><dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId></dependency>二、配置文件解析
Logback默認會到類路徑下找logback-test.xml and logback.xml
Spring Boot 會在 classpath 下查找是否有 logback-test.groovy、logback-test.xml、logback.groovy 或者 logback.xml，如果都找不到的話，才會加載項目路徑下的 logback-spring.xml
三、配置文件結構
logger: 日志記錄器，root是特殊的logger-頂層logger,因為logger具有繼承關系，稍后介紹
appender: 配置日志文件輸出目的地
encoder: 控制日志輸出格式，它是借助于layout實現的
rollingPolicy: RollingFileAppender具有該子元素，指定發生滾動時的行為
triggeringPolicy： RollingFileAppender具有該子元素，指定何時發生滾動過程，一般不用配置該元素，因為最受歡迎的TimeBasedRollingPolicy ，它實現了rolling policy同時也實現了triggering policy。
filter: 對appender收到的日志進行過濾，只有滿足Filter條件的日志才輸出到日志文件
五、Logger組件logger組件具有父子層級關系，root是最頂層的logger。logger記錄器是命名實體。它們的名稱區分大小寫，并且遵循分層命名規則.
如果一個記錄器的名稱后跟一個點，則該記錄器是另一個記錄器的祖先，該后跟點的名稱是其后代記錄器名稱的前綴。如果記錄器與子記錄器之間沒有祖先，則稱該記錄器為子記錄器的父項。例如，名為'com.foo'的記錄器是名為'com.foo.Bar'的記錄器的父項。同樣， 'java'是'java.util'和'java.util.Vector'的祖先記錄器。大多數開發人員都應該熟悉這種命名方案。
logger日志級別繼承
如果未為給定的記錄器分配一個級別，則它將從其最接近的祖先那里繼承一個已分配的級別。例如：給定記錄器L的有效級別等于其層次結構中的第一個非空級別，從L本身開始， 然后在層次結構中向上尋找直到root logger。為了確保所有記錄器最終都可以繼承級別，root logger始終具有分配的級別，root logger默認級別是DEBUG。
注意：如果日志記錄請求的級別高于或等于記錄器的有效級別，則該日志請求是有效的。日志級別按以下順序排序： TRACE < DEBUG < INFO < WARN < ERROR。
logger關聯的appender繼承
一個logger可以配置多個appender，logger輸出的日志會輸出到當前記錄器綁定的appender和父級們logger(直到root logger)綁定的appender，可以設置additivity 屬性為false,則logger輸出的日志僅會輸出到當前記錄器綁定的appender六、logger屬性 name：指定全限定包名 level：日志輸出級別，如果沒有配置，則參考上面的級別繼承 additivity：默認為true,參考上面的appender繼承。
如果additivity為true，會存在重復輸出日志情況，如下所示
<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包下的日志會輸出兩遍到console控制臺,如下所示
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'> <!--默認System.out,也可以指定System.error --> <target>System.out</target> <!-- encoders 默認類型ch.qos.logback.classic.encoder.PatternLayoutEncoder --> <encoder> <pattern>%-4relative [%thread] %-5level %logger{35} - %msg %n</pattern> </encoder> </appender>
寫日志到標準輸出流，可以配置target屬性為system.out,也可以指定System.error,默認System.out
FileAppender
包含的子元素有
append：如果為true，則追加到已存在的日志文件，否則截斷現有文件，默認為true file: 指定日志寫入文件的名字。如果文件不存在，則創建包括父級目錄。windows系統要避開“”,正確例子可以指定為c:/temp/test.log或c:temptest.log encoder: 輸出的格式 RollingFileAppenderRollingFileAppender
擴展了FileAppender，具有滾動更新日志文件的功能；例如，RollingFileAppender可以登錄到一個名為log.txt的文件，一旦滿足某個條件，就可以保存當前日志文件，并滾動輸出到新的日志文件。
包含的子元素有
append：如果為true，則追加到已存在的日志文件，否則截斷現有文件，默認為true file: 指定日志寫入文件的名字。如果文件不存在，則創建包括父級目錄。windows系統要避開“”,正確例子可以指定為c:/temp/test.log或c:temptest.log encoder:輸出的格式 rollingPolicy: 指定RollingFileAppender發生滾動時的行為 triggeringPolicy：指定RollingFileAppender何時發生滾動過程rollingPolicy
rollingPolicy常用的有TimeBasedRollingPolicy、SizeAndTimeBasedRollingPolicy
TimeBasedRollingPolicy
TimeBasedRollingPolicy是最受歡迎的滾動策略。它基于時間進行滾動，可以是按月或按天等。TimeBasedRollingPolicy承擔滾動以及觸發所述滾動的責任。它實現了rolling policy同時也實現了triggering policy。包含的子元素有
fileNamePattern：必選；它的值應包括文件名以及適當放置的％d轉換說明符。所述 ％d由指定的轉換說明可包含日期和時間模式 java.text.SimpleDateFormat類。如果省略了日期和時間模式，則采用默認模式 yyyy-MM-dd；可以指定多個%d，但是只有一個主要的，其他的都要使用‘aux’標記，多個%d允許你組織對日志文件歸類，例如按照年月分文件夾/var/log/%d{yyyy/MM, aux}/myapplication.%d{yyyy-MM-dd}.log maxHistory：設置存檔文件保存時間，日志文件至少保存 15 天，因為有些異常具備以“周”為頻次發生的特點。 totalSizeCap：控制歸檔文件的大小SizeAndTimeBasedRollingPolicy
支持按照時間拆分后，再按文件大小拆分
<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'表示當日志文件達到“maxFileSize”它將按照遞增序列（以0開始）歸檔日志。
triggering policy
SizeBasedTriggeringPolicy
該triggering policy通過配置一個maxFileSize參數，當日志文件超過該閾值，會通知RollingFileAppender 觸發日志翻滾。但一般triggering policy可以不用配置，TimeBasedRollingPolicy 已經完美集成了。
補充：以上Appender都是本地記錄日志，logback也支持網絡輸出日志、本地數據、郵件等；后續如果有需要再來研究。logback還可以使用AsyncAppender異步記錄日志。
Encoder
encoder負責轉換事件為字節數組并將字節數組寫入輸出流中。PatternLayoutEncoder 是最常用的encoder，該類通過使用PatternLayout來格式化日志事件。我們可以直接配置PatternLayoutEncoder ，而不用配置PatternLayout，它默認使用PatternLayout進行格式輸出。
layout
負責轉換事件成字符串，我們可以自定義layout，然后通過encoder引用
<encoder class='ch.qos.logback.core.encoder.LayoutWrappingEncoder'> <layout /> </encoder>
PatternLayout
它將日志事件轉換成字符串，但是可以自定義字符串通過調整PatternLayout的轉換模式。
PatternLayout的轉換模式跟C語言的printf()函數緊密相關。常用的模式有：
% d{pattern}: 日期
% level 日志級別
%thread 線程名稱
%class 全限定類名，日志請求記錄所在的類
%method 日志請求記錄所在的方法
%line 日志請求記錄的行號
%n 換行
%logger{length} 輸出日志logger記錄器的名字，length指定輸出名字長度，logback會智能縮寫而不丟失語義。
%msg 輸出日志記錄器記錄的消息
<encoder class='ch.qos.logback.classic.encoder.PatternLayoutEncoder'> <!--格式化輸出：%d表示日期，%thread表示線程名，%-5level：級別從左顯示5個字符寬度%msg：日志消息，%n是換行符--> <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS,CTT} %-5level [%thread] [%class:%line] %logger{50} - %msg%n</pattern></encoder>
多個模式之間分隔符，在大多數情況下，文字需包含空格或其他分隔字符（’[’,’]’,’-’），這樣就不會與轉換詞混淆
Filter
對appender收到的日志調用decide方法進行過濾，只有滿足Filter條件的日志才輸出到日志文件，decide方法有三個返回值，DENY、ACCEPT、NEUTRAL
如果返回的值為DENY，則立即刪除日志事件，而不咨詢其余的篩選器; 如果返回的值是NEUTRAL中性的，則查詢列表中的下一個篩選器,如果沒有其他篩選器可供查詢，則日志事件將正常處理; 如果返回值為ACCEPT，則會立即處理日志事件，跳過其余篩選器的調用。LevelFilter
該過濾器對日志的級別過濾，如果事件日志級別等于配置的級別，過濾器接受或者拒絕該事件日志，依賴于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
過濾低于指定閾值的事件。對于等于或高于閾值的事件，將在調用其（）方法時響應NEUTRAL 。但是，級別低于閾值的事件將被拒絕。
<!-- 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 是封裝了的通用過濾器 EventEvaluator。顧名思義， 評估對象是否滿足給定事件的給定條件。在匹配和不匹配時，托管將分別返回由onMatch 或onMismatch屬性指定的值。GEventEvaluator 實現了EventEvaluator，通過子元素采用任意Groovy語言布爾表達式作為評估標準的具體實現JaninoEventEvaluator實現了EventEvaluator，通過子元素采用任意Java語言塊返回布爾值作為評估標準。
uatorFilter
EvaluatorFilter 是封裝了的通用過濾器 EventEvaluator。顧名思義， 評估對象是否滿足給定事件的給定條件。在匹配和不匹配時，托管將分別返回由onMatch 或onMismatch屬性指定的值。GEventEvaluator 實現了EventEvaluator，通過子元素采用任意Groovy語言布爾表達式作為評估標準的具體實現JaninoEventEvaluator實現了EventEvaluator，通過子元素采用任意Java語言塊返回布爾值作為評估標準。
EvaluatorFilter 也可通過子元素支持正則匹配。
到此這篇關于詳解Springboot之Logback的使用學習的文章就介紹到這了,更多相關Logback詳解內容請搜索好吧啦網以前的文章或繼續瀏覽下面的相關文章希望大家以后多多支持好吧啦網！
相關文章：
網公網安備