|
logback是java的日志開(kāi)源組件，是log4j創(chuàng)始人寫(xiě)的，性能比log4j要好，目前主要分為3個(gè)模塊
本篇博客會(huì)講解logback的使用、配置詳解、以及l(fā)ogback簡(jiǎn)單的一個(gè)原理。 一、logback的使用引入maven依賴(lài) <!--這個(gè)依賴(lài)直接包含了 logback-core 以及 slf4j-api的依賴(lài)--><dependency>
<groupId>ch.qos.logback</groupId>
<artifactId>logback-classic</artifactId>
<version>1.2.3</version></dependency>然后就可以直接在代碼中使用slf4j的接口獲取Logger輸出日志了。（配置在下面的章節(jié)介紹） 二、logback的配置配置獲取順序logback在啟動(dòng)的時(shí)候，會(huì)按照下面的順序加載配置文件
上面的順序表示優(yōu)先級(jí)，使用java -D配置的優(yōu)先級(jí)最高，只要獲取到配置后就不會(huì)再執(zhí)行下面的流程。相關(guān)代碼可以看 關(guān)于SLF4j的日志輸出級(jí)別在slf4j中，從小到大的日志級(jí)別依舊是 logback.xml 配置樣例<?xml version='1.0' encoding='UTF-8'?><configuration debug='true' scan='true' scanPeriod='1 seconds'>
<contextName>logback</contextName>
<!--定義參數(shù),后面可以通過(guò)${app.name}使用-->
<property name='app.name' value='logback_test'/>
<!--ConsoleAppender 用于在屏幕上輸出日志-->
<appender name='stdout' class='ch.qos.logback.core.ConsoleAppender'>
<!--定義了一個(gè)過(guò)濾器,在LEVEL之下的日志輸出不會(huì)被打印出來(lái)-->
<!--這里定義了DEBUG，也就是控制臺(tái)不會(huì)輸出比ERROR級(jí)別小的日志-->
<filter class='ch.qos.logback.classic.filter.ThresholdFilter'>
<level>DEBUG</level>
</filter>
<!-- encoder 默認(rèn)配置為PatternLayoutEncoder -->
<!--定義控制臺(tái)輸出格式-->
<encoder>
<pattern>%d [%thread] %-5level %logger{36} [%file : %line] - %msg%n</pattern>
</encoder>
</appender>
<appender name='file' class='ch.qos.logback.core.rolling.RollingFileAppender'>
<!--定義日志輸出的路徑-->
<!--這里的scheduler.manager.server.home 沒(méi)有在上面的配置中設(shè)定，所以會(huì)使用java啟動(dòng)時(shí)配置的值-->
<!--比如通過(guò) java -Dscheduler.manager.server.home=/path/to XXXX 配置該屬性-->
<file>${scheduler.manager.server.home}/logs/${app.name}.log</file>
<!--定義日志滾動(dòng)的策略-->
<rollingPolicy class='ch.qos.logback.core.rolling.TimeBasedRollingPolicy'>
<!--定義文件滾動(dòng)時(shí)的文件名的格式-->
<fileNamePattern>${scheduler.manager.server.home}/logs/${app.name}.%d{yyyy-MM-dd.HH}.log.gz </fileNamePattern>
<!--60天的時(shí)間周期，日志量最大20GB-->
<maxHistory>60</maxHistory>
<!-- 該屬性在 1.1.6版本后 才開(kāi)始支持-->
<totalSizeCap>20GB</totalSizeCap>
</rollingPolicy>
<triggeringPolicy class='ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy'>
<!--每個(gè)日志文件最大100MB-->
<maxFileSize>100MB</maxFileSize>
</triggeringPolicy>
<!--定義輸出格式-->
<encoder>
<pattern>%d [%thread] %-5level %logger{36} [%file : %line] - %msg%n</pattern>
</encoder>
</appender>
<!--root是默認(rèn)的logger 這里設(shè)定輸出級(jí)別是debug-->
<root level='trace'>
<!--定義了兩個(gè)appender，日志會(huì)通過(guò)往這兩個(gè)appender里面寫(xiě)-->
<appender-ref ref='stdout'/>
<appender-ref ref='file'/>
</root>
<!--對(duì)于類(lèi)路徑以 com.example.logback 開(kāi)頭的Logger,輸出級(jí)別設(shè)置為warn,并且只輸出到控制臺(tái)-->
<!--這個(gè)logger沒(méi)有指定appender，它會(huì)繼承root節(jié)點(diǎn)中定義的那些appender-->
<logger name='com.example.logback' level='warn'/>
<!--通過(guò) LoggerFactory.getLogger('mytest') 可以獲取到這個(gè)logger-->
<!--由于這個(gè)logger自動(dòng)繼承了root的appender，root中已經(jīng)有stdout的appender了，自己這邊又引入了stdout的appender-->
<!--如果沒(méi)有設(shè)置 additivity='false' ,就會(huì)導(dǎo)致一條日志在控制臺(tái)輸出兩次的情況-->
<!--additivity表示要不要使用rootLogger配置的appender進(jìn)行輸出-->
<logger name='mytest' level='info' additivity='false'>
<appender-ref ref='stdout'/>
</logger>
<!--由于設(shè)置了 additivity='false' ，所以輸出時(shí)不會(huì)使用rootLogger的appender-->
<!--但是這個(gè)logger本身又沒(méi)有配置appender，所以使用這個(gè)logger輸出日志的話就不會(huì)輸出到任何地方-->
<logger name='mytest2' level='info' additivity='false'/></configuration>配置詳解configuration節(jié)點(diǎn)相關(guān)屬性
configuration子節(jié)點(diǎn)介紹1. contextName節(jié)點(diǎn)設(shè)置日志上下文名稱(chēng)，后面輸出格式中可以通過(guò)定義 %contextName 來(lái)打印日志上下文名稱(chēng) 2.property節(jié)點(diǎn)用來(lái)設(shè)置相關(guān)變量,通過(guò)key-value的方式配置，然后在后面的配置文件中通過(guò) ${key}來(lái)訪問(wèn) 3.appender 節(jié)點(diǎn)日志輸出組件，主要負(fù)責(zé)日志的輸出以及格式化日志。常用的屬性有name和class
ConsoleAppender：向控制臺(tái)輸出日志內(nèi)容的組件，只要定義好encoder節(jié)點(diǎn)就可以使用。 FileAppender：向文件輸出日志內(nèi)容的組件，用法也很簡(jiǎn)單，不過(guò)由于沒(méi)有日志滾動(dòng)策略，一般很少使用 RollingFileAppender：向文件輸出日志內(nèi)容的組件，同時(shí)可以配置日志文件滾動(dòng)策略，在日志達(dá)到一定條件后生成一個(gè)新的日志文件。 appender節(jié)點(diǎn)中有一個(gè)子節(jié)點(diǎn) 在RollingFileAppender中，可以配置相關(guān)的滾動(dòng)策略，具體可以看配置樣例的注釋。 4.logger以及root節(jié)點(diǎn)root節(jié)點(diǎn)和logger節(jié)點(diǎn)其實(shí)都是表示 如果配置了logger，并且通過(guò)getLogger('name/class')獲取到這個(gè)logger，輸出日志的時(shí)候，就會(huì)使用這個(gè)logger配置的appender輸出，同時(shí)還會(huì)使用rootLogger配置的appender。我們可以使用logger節(jié)點(diǎn)的 關(guān)于logger的獲取，一般logger是配置name的。我們?cè)俅a中經(jīng)常通過(guò)指定的CLass來(lái)獲取Logger，比如這樣 也就是說(shuō)，name可以配置包名，也可以配置自定義名稱(chēng)。
一些特性的支持在看logback的啟動(dòng)日志時(shí)，看到下面這句話。
大概意思解析logbck配置時(shí)不支持totalSizeCap、maxFileSize的配置。后來(lái)查了下，果然，totalSizeCap是在1.1.6之后的版本才開(kāi)始支持的，切換到1.1.7之后就不會(huì)出現(xiàn)這句話了。 maxFileSize比較奇怪，試了目前所有的版本都不支持rollingPolicy—maxFileSize的配置方案，如果配置到triggeringPolicy節(jié)點(diǎn)下，又是可以生效的。但是官網(wǎng)給的文檔上又有出現(xiàn)rollingPolicy下面的。
三、實(shí)現(xiàn)原理slf4j是什么slf4j只是一套標(biāo)準(zhǔn)，通俗來(lái)講，就是定義了一系列接口，它并不提供任何的具體實(shí)現(xiàn)。所以，我們使用這套接口進(jìn)行開(kāi)發(fā)，可以任意的切換底層的實(shí)現(xiàn)框架。 比如，一開(kāi)始項(xiàng)目用的是log4j的實(shí)現(xiàn)，后來(lái)發(fā)現(xiàn)log4j的性能太差了，想換成logback，由于我們代碼中都是面向slf4j接口的，這樣我們只要吧log4j的依賴(lài)換成logback就可以了。 logback-classic啟動(dòng)原理我們?cè)谡{(diào)用 為了解決這個(gè)問(wèn)題，我追蹤了一下代碼，發(fā)現(xiàn)logback-classic底下，有一個(gè)slf4j的包.  logback-slf4j實(shí)現(xiàn).png slf4j在初始化時(shí)會(huì)調(diào)用 比如logback在自己定義的StaticLoggerBinder做了自己組件的初始化工作。下面是網(wǎng)上找的一個(gè)時(shí)序圖：  slf4j加載時(shí)序圖.png 多個(gè)依賴(lài)包都實(shí)現(xiàn)了slf4j如果引入了多個(gè)slf4j的實(shí)現(xiàn)依賴(lài)包，那么各個(gè)包底下都有 這個(gè)問(wèn)題和java的類(lèi)加載機(jī)制有關(guān)系，在雙親委派機(jī)制的模型中，這些引入的依賴(lài)包通常都是由 舉個(gè)例子，我們通過(guò) 四、總結(jié)日志組件的使用一般都非常簡(jiǎn)單，幾乎所有的項(xiàng)目中都會(huì)用到各種各樣的日志組件。但是可能就是由于太簡(jiǎn)單了，比較少的人會(huì)愿意深入系統(tǒng)的去了解。本人也只是對(duì)logback的配置以及一些簡(jiǎn)單的原理做了一些了解，并沒(méi)有很深入的去看logback的具體實(shí)現(xiàn)。 因此，本文的內(nèi)容大部分都是基于官網(wǎng)的文檔以及網(wǎng)上一些其他關(guān)于logback的博客，雖然也做了一些簡(jiǎn)單的測(cè)試，但并不保證全部都是正確的。 |
|
|
來(lái)自： liang1234_ > 《log》
