故事篇:終于給老婆講明白什么是logback了!

故事會遲到,但他從不會缺席。今天的故事開始了,你準(zhǔn)備好了嗎?
前奏
簡單介紹一下我的老婆:集智慧與美貌于一身的女子——阿貍,一句“我們心有靈犀,不是嗎?”讓我瞬間“淪陷”。



正題
LogBack簡介

常見的日志框架呢有以下幾種:
JUL(Java Util Logging) Logback Log4j Log4j2 JCL(Jakarta Commons Logging) Slf4j(Simple Logging Facade For Java)

首先它配置比較簡單,比較容易上手; 其次配置比較靈活,能滿足大部分項(xiàng)目的需求; 最后性能比較好,可以異步存儲日志。
我覺得這也是它在市面上比較流行,項(xiàng)目中使用比較多的原因吧。

「門面與實(shí)現(xiàn)的關(guān)系了解一下」

接著奉上官網(wǎng)地址,它分為以下三個模塊:
logback-core:其它兩個模塊的基礎(chǔ)模塊; logback-classic:它是 log4j的一個改良版本,同時它完整實(shí)現(xiàn)了slf4j API,你可以很方便地更換成其它日志框架(如log4j或者JUL);logback-access:訪問模塊與 Servlet容器集成提供通過Http來訪問日志的功能,可以輕松地在logback核心之上構(gòu)建自己的模塊。
logback組件之間的關(guān)系 「可以大體了解下,實(shí)戰(zhàn)篇更容易理解」:
Logger作為日志的記錄器,把它關(guān)聯(lián)到應(yīng)用的對應(yīng)的context上后,主要用于存放日志對象,也可以定義日志類型、級別;Appender主要用于指定日志輸出的目的地,可以是控制臺、文件、遠(yuǎn)程套接字服務(wù)器、MySQL、PostreSQL、Oracle和其他數(shù)據(jù)庫、JMS和遠(yuǎn)程UNIX Syslog守護(hù)進(jìn)程等;Layout負(fù)責(zé)把事件轉(zhuǎn)換成字符串,格式化的日志信息的輸出。在logback中Layout對象被封裝在encoder中;Logger Context:各個logger都被關(guān)聯(lián)到一個LoggerContext,它負(fù)責(zé)制造logger,也負(fù)責(zé)以樹結(jié)構(gòu)排列各logger。其他所有logger也通過org.slf4j.LoggerFactory類的靜態(tài)方法getLogger取得。
??
Logger可以被分配的級別包括:TRACE、DEBUG、INFO、WARN和ERROR,定義于ch.qos.logback.classic.Level類。如果logger沒有被分配級別,那么它將從有被分配級別的最近的祖先那里繼承級別。root logger默認(rèn)級別是DEBUG。
級別排序?yàn)椋?code style="overflow-wrap: break-word;margin-right: 2px;margin-left: 2px;font-family: "Operator Mono", Consolas, Monaco, Menlo, monospace;word-break: break-all;color: rgb(53, 148, 247);background: rgba(59, 170, 250, 0.1);padding-right: 2px;padding-left: 2px;border-radius: 2px;height: 21px;line-height: 22px;">TRACE < DEBUG < INFO < WARN < ERROR
項(xiàng)目實(shí)戰(zhàn)

?org.slf4j
?slf4j-api
?1.7.30
?ch.qos.logback
?logback-classic
?1.2.3
logback會從 classpath 下依次讀取以下類型的配置文件:
logback.groovy logback-test.xml logback.xml
如果文件都不存在,logback用 BasicConfigurator 自動對自己進(jìn)行配置,這會導(dǎo)致記錄輸出到控制臺。
基本信息配置
代碼測試樣例奉上:
public?class?TestLogBack?{
????private?static?final?Logger?logger?=?LoggerFactory.getLogger(TestLogBack.class);
????public?static?void?main(String[]?args)?{
????????for?(int?i?=?0;?i?10000;?i++)?{
????????????logger.error("error");
????????????logger.warn("warn");
????????????logger.info("info");
????????????logger.debug("debug");
????????????logger.trace("trace");
????????}
????}
}
首先我們在resources下創(chuàng)建一個logback.xml,然后進(jìn)行配置
<configuration>
????
????<property?name="pattern"?value="[%-5level]?%d{yyyy-MM-dd?HH:mm:ss.SSS}?%c?%M?%L?[%thread]?%m%n"/>
????
????
????<appender?name="console"?class="ch.qos.logback.core.ConsoleAppender">
????????
????????<target>System.errtarget>
????????
????????<encoder?class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
????????????<pattern>${pattern}pattern>
????????encoder>
????appender>
????
????<property?name="log_dir"?value="/logs"/>
????
????<appender?name="file"?class="ch.qos.logback.core.FileAppender">
????????
????????<file>${log_dir}/logback.logfile>
????????
????????<encoder?class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
????????????<pattern>${pattern}pattern>
????????encoder>
????appender>
????
????<appender?name="htmlFile"?class="ch.qos.logback.core.FileAppender">
????????
????????<file>${log_dir}/logback.htmlfile>
????????
????????<encoder?class="ch.qos.logback.core.encoder.LayoutWrappingEncoder">
????????????<layout?class="ch.qos.logback.classic.html.HTMLLayout">
????????????????<pattern>%-5level%d{yyyy-MM-dd?HH:mm:ss.SSS}%c%M%L%thread%mpattern>
????????????layout>
????????encoder>
????appender>
??
????<root?level="ALL">
????????<appender-ref?ref="console"/>
????????<appender-ref?ref="file"/>
????????<appender-ref?ref="htmlFile"/>
????root>
????
configuration>
運(yùn)行之后發(fā)現(xiàn)在控制臺打印出紅色字體的日志信息,在/log文件下有logback.log和logback.html兩個日志文件,在項(xiàng)目中一般都只會使用.log結(jié)尾的日志的。

<appender?name="rollFile"?class="ch.qos.logback.core.rolling.RollingFileAppender">
????
????<file>${log_dir}/roll_logback.logfile>
????
????<encoder?class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
????????<pattern>${pattern}pattern>
????encoder>
????
????<rollingPolicy?class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
????????
????????
????????<maxFileSize>1MBmaxFileSize>
????????
????????<fileNamePattern>${log_dir}/rolling.%d{yyyy-MM-dd-HH-mm-ss}.log%i.gzfileNamePattern>
????rollingPolicy>
appender>
此時我們對測試程序加上for循環(huán),循環(huán)1w次,發(fā)現(xiàn)每秒或者每超過1M都會產(chǎn)生新的文件。當(dāng)然也可以在appender下增加過濾器,過濾需要的日志級別。
<filter?class="ch.qos.logback.classic.filter.LevelFilter">
????
????<level>ERRORlevel>
????
????<onMatch>ACCEPTonMatch>
????
????<onMismatch>DENYonMismatch>
filter>

先打開 RollingFileAppender,可以看到他底下有個RollingPolicy策略
點(diǎn)進(jìn)去發(fā)現(xiàn)它是一個接口,然后看一下它的實(shí)現(xiàn)類,我們找到 SizeAndTimeBasedRollingPolicy策略看一下
3.發(fā)現(xiàn)這個類里邊就有文件大小的屬性maxFileSize,卻沒有找到按照時間分文件的屬性,我們進(jìn)入它的父類TimeBasedRollingPolicy查看
4.發(fā)現(xiàn)里邊就有該屬性,翻譯一下:必須在使用TimeBasedRollingPolicy之前設(shè)置FileNamePattern選項(xiàng)

<appender?name="async"?class="ch.qos.logback.classic.AsyncAppender">
????
????<appender-ref?ref="rollFile"/>
appender>
除了上邊用到的root,還支持自定義的logger呢。
<logger?name="com.aq.logback"?level="info"?additivity="false">
??<appender-ref?ref="console"/>
logger>
SpringBoot中使用


?默認(rèn)日志是
?info級別
我們還可以直接使用@Slf4j的注解來代替上邊的
private?static?final?Logger?logger?=?LoggerFactory.getLogger(TestLogBack.class);
引用是使用log.info("info");來實(shí)現(xiàn)。它的默認(rèn)加載順序是logback-spring.xml->logback.xml
我們可以在application.properties中簡單配置
#指定自定義 logger 對象的日志級別
logging.level.com.itzyq.sblogback=trace
#指定控制臺輸出消息格式
logging.pattern.console=[%-5level] %d{yyyy-MM-dd HH:mm:ss} %c [%thread] ===== %m %n
#指定存放日志文件的具體路徑(已經(jīng)棄用)
#logging.file=/logs/springboot.log
#指定日志文件存放的目錄,默認(rèn)的文件名為spring.log
logging.file.path=/logs/springboot/
#指定日志文件的消息格式
logging.pattern.file=[%-5level] %d{yyyy-MM-dd HH:mm:ss} %c [%thread] ===== %m %n
因?yàn)樵?code style="overflow-wrap: break-word;margin-right: 2px;margin-left: 2px;font-family: "Operator Mono", Consolas, Monaco, Menlo, monospace;word-break: break-all;color: rgb(53, 148, 247);background: rgba(59, 170, 250, 0.1);padding-right: 2px;padding-left: 2px;border-radius: 2px;height: 21px;line-height: 22px;">properties中配置功能有限,我們還是使用上文中的logback.xml來配置。

??
logback-spring.xml只有在Spring應(yīng)用程序運(yùn)行的時候才生效,即帶有@SpringBootApplication注解的類啟動的時候才會生效。這里我們完全可以使用它。
另外它還有個特殊的功能,可以用來解析日志的配置。
<configuration>
????<property?name="pattern"?value="[%-5level]?%d{yyyy-MM-dd?HH:mm:ss.SSS}?%c?%M?%L?[%thread]?%m%n"/>
????
????<property?name="log_dir"?value="/logs"/>
????
????<appender?name="file"?class="ch.qos.logback.core.FileAppender">
????????
????????<file>${log_dir}/logback.logfile>
????????
????????<encoder?class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
????????????<springProfile?name="dev">
????????????????<pattern>${pattern}pattern>
????????????springProfile>
????????????<springProfile?name="pro">
????????????????<pattern>?%d{yyyy-MM-dd?HH:mm:ss.SSS}?[%thread]?%-5level?%m%npattern>
????????????springProfile>
????????encoder>
????appender>
????<root?level="info">
????????<appender-ref?ref="file"/>
????root>
configuration>
此時在application.properties中引入spring.profiles.active=dev或者pro可以切換測試和正式環(huán)境了,是不是很方便呀。
Logback-access

logback-access模塊與Servlet容器(如Tomcat和jetty)集成,已提供HTTP訪問日志功能。我們可以使用logback-access模塊來替換tomcat的訪問日志;
將
logback-access.jar與logback-core.jar復(fù)制到$TOMCAT_HOME/lib/(安裝Tomcat的文件夾)目錄下;修改
$TOMCAT_HOME/conf/server.xml中的Host元素中添加:
"ch.qos.logback.access.tomcat.LogbackValue"?/>
這一行通常嵌套在一個 或 元素中。
logback默認(rèn)會在$TOMCAT_HOME/conf下查找文件logback-access.xml,該配置的官方地址:http://logback.qos.ch/access.html#configuration
<configuration>
??
??<statusListener?class="ch.qos.logback.core.status.OnConsoleStatusListener"?/>??
??<appender?name="FILE"?class="ch.qos.logback.core.rolling.RollingFileAppender">
????<file>access.logfile>
????<rollingPolicy?class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
??????<fileNamePattern>access.%d{yyyy-MM-dd}.log.zipfileNamePattern>
????rollingPolicy>
????<encoder>
??????
??????<pattern>%h?%l?%u?[%t]?"%r"?%s?%b?"%i{Referer}"?“%i{User-Agent}”pattern>
??????<pattern>combinedpattern>
????encoder>
??appender>
?
??<appender-ref?ref="FILE"?/>
configuration>
配置信息補(bǔ)充

(1)根節(jié)點(diǎn)configuration,包含下面三個屬性:
scan: 當(dāng)此屬性設(shè)置為 true時,配置文件如果發(fā)生改變,將會被重新加載,默認(rèn)值為true。scanPeriod: 設(shè)置監(jiān)測配置文件是否有修改的時間間隔,如果沒有給出時間單位,默認(rèn)單位是毫秒。當(dāng) scan為true時,此屬性生效。默認(rèn)的時間間隔為1分鐘。debug: 當(dāng)此屬性設(shè)置為 true時,將打印出logback內(nèi)部日志信息,實(shí)時查看logback運(yùn)行狀態(tài)。默認(rèn)值為false。
"true"?scanPeriod="60?seconds"?debug="false">?
?
(2)contextName:用來設(shè)置上下文名稱,每個logger都關(guān)聯(lián)到logger上下文,默認(rèn)上下文名稱為default。但可以使用contextName設(shè)置成其他名字,用于區(qū)分不同應(yīng)用程序的記錄。一旦設(shè)置,不能修改。
"true"?scanPeriod="60?seconds"?debug="false">?
?????myAppName ?
?? ????
(3)?property :用來定義變量值,它有兩個屬性name和value,通過property定義的值會被插入到logger上下文中,可以使“${}”來使用變量。
name: 變量的名稱value: 的值是變量定義的值
(4)?timestamp:獲取時間戳字符串,他有兩個屬性key和datePattern
key: 標(biāo)識此timestamp的名字;datePattern: 設(shè)置將當(dāng)前時間(解析配置文件的時間)轉(zhuǎn)換為字符串的模式,遵循java.txt.SimpleDateFormat的格式。
"true"?scanPeriod="60?seconds"?debug="false">?
????"bySecond"?datePattern="yyyyMMdd'T'HHmmss"/>?
(5)appender:負(fù)責(zé)寫日志的組件,它有兩個必要屬性name和class。name指定appender名稱,class指定appender的全限定名
5.1、ConsoleAppender 把日志輸出到控制臺,有以下子節(jié)點(diǎn):
encoder:對日志進(jìn)行格式化。target:字符串System.out(默認(rèn))或者System.err
5.2、FileAppender:把日志添加到文件,有以下子節(jié)點(diǎn):
file:被寫入的文件名,可以是相對目錄,也可以是絕對目錄,如果上級目錄不存在會自動創(chuàng)建,沒有默認(rèn)值。append:如果是true,日志被追加到文件結(jié)尾,如果是false,清空現(xiàn)存文件,默認(rèn)是true。encoder:對記錄事件進(jìn)行格式化。prudent:如果是true,日志會被安全的寫入文件,即使其他的FileAppender也在向此文件做寫入操作,效率低,默認(rèn)是false。
5.3、RollingFileAppender:滾動記錄文件,先將日志記錄到指定文件,當(dāng)符合某個條件時,將日志記錄到其他文件。有以下子節(jié)點(diǎn):
file:被寫入的文件名,可以是相對目錄,也可以是絕對目錄,如果上級目錄不存在會自動創(chuàng)建,沒有默認(rèn)值。append:如果是true,日志被追加到文件結(jié)尾,如果是false,清空現(xiàn)存文件,默認(rèn)是true。rollingPolicy:當(dāng)發(fā)生滾動時,決定RollingFileAppender的行為,涉及文件移動和重命名。屬性class定義具體的滾動策略類。
5.4、策略:「class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy":」 最常用的滾動策略,它根據(jù)時間來制定滾動策略,既負(fù)責(zé)滾動也負(fù)責(zé)觸發(fā)滾動。有以下子節(jié)點(diǎn):
fileNamePattern:必要節(jié)點(diǎn),包含文件名及“%d”轉(zhuǎn)換符,“%d”可以包含一個java.text.SimpleDateFormat指定的時間格式,如:%d{yyyy-MM}。如果直接使用%d,默認(rèn)格式是yyyy-MM-dd。RollingFileAppender的file子節(jié)點(diǎn)可有可無,通過設(shè)置file,可以為活動文件和歸檔文件指定不同位置,當(dāng)前日志總是記錄到file指定的文件(活動文件),活動文件的名字不會改變;如果沒設(shè)置file,活動文件的名字會根據(jù)fileNamePattern的值,每隔一段時間改變一次?!?”或者“\”會被當(dāng)做目錄分隔符。maxHistory:可選節(jié)點(diǎn),控制保留的歸檔文件的最大數(shù)量,超出數(shù)量就刪除舊文件。假設(shè)設(shè)置每個月滾動,且是6,則只保存最近6個月的文件,刪除之前的舊文件。注意,刪除舊文件時,那些為了歸檔而創(chuàng)建的目錄也會被刪除。
「class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy":」 查看當(dāng)前活動文件的大小,如果超過指定大小會告知RollingFileAppender 觸發(fā)當(dāng)前活動文件滾動。只有一個節(jié)點(diǎn):
maxFileSize:這是活動文件的大小,默認(rèn)值是10MB。prudent:當(dāng)為true時,不支持FixedWindowRollingPolicy。支持TimeBasedRollingPolicy,但是有兩個限制,1不支持也不允許文件壓縮,2不能設(shè)置file屬性,必須留空。triggeringPolicy: 告知RollingFileAppender合適激活滾動。
「class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy"」 根據(jù)固定窗口算法重命名文件的滾動策略。有以下子節(jié)點(diǎn):
minIndex:窗口索引最小值maxIndex:窗口索引最大值,當(dāng)用戶指定的窗口過大時,會自動將窗口設(shè)置為12。fileNamePattern:必須包含“%i”例如,假設(shè)最小值和最大值分別為1和2,命名模式為mylog%i.log,會產(chǎn)生歸檔文件mylog1.log和mylog2.log。還可以指定文件壓縮選項(xiàng),例如,mylog%i.log.gz或者 沒有log%i.log.zip
?
??????"FILE"?class="ch.qos.logback.core.rolling.RollingFileAppender">?
????????"ch.qos.logback.core.rolling.TimeBasedRollingPolicy">?
??????????logFile.%d{yyyy-MM-dd}.log ?
??????????30 ?
???????? ?
?????????
??????????%-4relative?[%thread]?%-5level?%logger{35}?-?%msg%n ?
???????? ?
?????? ?
??????"DEBUG">?
????????"FILE"?/>?
?????? ?
????
???//上述配置表示每天生成一個日志文件,保存30天的日志文件。
?
??????"FILE"?class="ch.qos.logback.core.rolling.RollingFileAppender">?
????????test.log ?
????????"ch.qos.logback.core.rolling.FixedWindowRollingPolicy">?
??????????tests.%i.log.zip ?
??????????1 ?
??????????3 ?
???????? ?
????????"ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">?
??????????5MB ?
???????? ?
?????????
??????????%-4relative?[%thread]?%-5level?%logger{35}?-?%msg%n ?
???????? ?
?????? ?
??????"DEBUG">?
????????"FILE"?/>?
?????? ?
????
????//上述配置表示按照固定窗口模式生成日志文件,當(dāng)文件大于5MB時,生成新的日志文件。窗口大小是1到3,當(dāng)保存了3個歸檔文件后,將覆蓋最早的日志。
encoder:對記錄事件進(jìn)行格式化。負(fù)責(zé)兩件事,一是把日志信息轉(zhuǎn)換成字節(jié)數(shù)組,二是把字節(jié)數(shù)組寫入到輸出流。
PatternLayoutEncoder 是唯一有用的且默認(rèn)的encoder ,有一個pattern節(jié)點(diǎn),用來設(shè)置日志的輸入格式。使用“%”加“轉(zhuǎn)換符”方式,如果要輸出“%”,則必須用“\”對“\%”進(jìn)行轉(zhuǎn)義。
(6)子節(jié)點(diǎn)logger:用來設(shè)置某一個包或具體的某一個類的日志打印級別、以及指定appender。僅有一個name屬性,一個可選的level和一個可選的additivity(「單詞一定要注意寫對,好多地方都寫成了addtivity」)屬性。可以包含零個或多個appender將會添加到這個logger
name:用來指定受此 logger約束的某一個包或者具體的某一個類;level:用來設(shè)置打印級別(日志級別),大小寫無關(guān): TRACE,DEBUG,INFO,WARN,ERROR,ALL和OFF,還有一個特殊值INHERITED或者同義詞NULL,代表強(qiáng)制執(zhí)行上級的級別。如果未設(shè)置此屬性,那么當(dāng)前logger將會繼承上級的級別。additivity:是否向上級 loger傳遞打印信息。默認(rèn)是true。
(7)子節(jié)點(diǎn)root:它也是logger元素,但是它是根 logger ,是所有logger的上級。只有一個level屬性,因?yàn)?code style="overflow-wrap: break-word;margin-right: 2px;margin-left: 2px;font-family: "Operator Mono", Consolas, Monaco, Menlo, monospace;word-break: break-all;color: rgb(53, 148, 247);background: rgba(59, 170, 250, 0.1);padding-right: 2px;padding-left: 2px;border-radius: 2px;height: 21px;line-height: 22px;">name已經(jīng)被命名為"root",且已經(jīng)是最上級了。同logger一樣,可以包含零個或多個appender-ref元素,標(biāo)識這個appender將會添加到這個logger。
level: 用來設(shè)置打印級別,大小寫無關(guān):TRACE,DEBUG,INFO,WARN,ERROR,ALL和OFF,不能設(shè)置為INHERITED或者同義詞NULL。默認(rèn)是DEBUG
常用logger配置
?
"org.hibernate.type.descriptor.sql.BasicBinder"?level="TRACE"?/>
"org.hibernate.type.descriptor.sql.BasicExtractor"?level="DEBUG"?/>
"org.hibernate.SQL"?level="DEBUG"?/>
"org.hibernate.engine.QueryParameters"?level="DEBUG"?/>
"org.hibernate.engine.query.HQLQueryPlan"?level="DEBUG"?/>
"com.apache.ibatis"?level="TRACE"/>
"java.sql.Connection"?level="DEBUG"/>
"java.sql.Statement"?level="DEBUG"/>
"java.sql.PreparedStatement"?level="DEBUG"/>

以上就是今天的所有內(nèi)容了,如果你有不同的意見或者更好的idea,歡迎聯(lián)系阿Q:qingqing-4132,阿Q期待你的到來!
后臺領(lǐng)取干貨資料:學(xué)習(xí)筆記與大廠面試題
「內(nèi)容推薦」
