作者：何甜甜在嗎
juejin.im/post/5d4d61326fb9a06aff5e5ff5

受臺(tái)風(fēng)利奇馬的影響很多地方都迎來了強(qiáng)降雨略贮，雙休日不能出去玩一起學(xué)習(xí)吧掉房，就先從最基本的配置講起再介紹高級(jí)特性異步輸出日志。如果只想看異步輸出日志提升性能的部分請(qǐng)將文章往下拉一點(diǎn)颤芬。

通過閱讀本篇文章將了解到

1. 日志輸出到文件并根據(jù)LEVEL級(jí)別將日志分類保存到不同文件

2. 通過異步輸出日志減少磁盤IO提高性能

3. 異步輸出日志的原理

配置文件logback-spring.xml

SpringBoot工程自帶logback和slf4j的依賴悲幅，所以重點(diǎn)放在編寫配置文件上，需要引入什么依賴站蝠，日志依賴沖突統(tǒng)統(tǒng)都不需要我們管了汰具。

logback框架會(huì)默認(rèn)加載classpath下命名為logback-spring或logback的配置文件。將所有日志都存儲(chǔ)在一個(gè)文件中文件大小也隨著應(yīng)用的運(yùn)行越來越大并且不好排查問題菱魔，正確的做法應(yīng)該是將error日志和其他日志分開留荔，并且不同級(jí)別的日志根據(jù)時(shí)間段進(jìn)行記錄存儲(chǔ)。

<?xml version="1.0" encoding="utf-8"?>
<configuration>
    <property resource="logback.properties"/>
    <appender name="CONSOLE-LOG" class="ch.qos.logback.core.ConsoleAppender">
        <layout class="ch.qos.logback.classic.PatternLayout">
            <pattern>[%d{yyyy-MM-dd' 'HH:mm:ss.sss}] [%C] [%t] [%L] [%-5p] %m%n</pattern>
        </layout>
    </appender>
    <!--獲取比info級(jí)別高(包括info級(jí)別)但除error級(jí)別的日志-->
    <appender name="INFO-LOG" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>ERROR</level>
            <onMatch>DENY</onMatch>
            <onMismatch>ACCEPT</onMismatch>
        </filter>
        <encoder>
            <pattern>[%d{yyyy-MM-dd' 'HH:mm:ss.sss}] [%C] [%t] [%L] [%-5p] %m%n</pattern>
        </encoder>

        <!--滾動(dòng)策略-->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!--路徑-->
            <fileNamePattern>${LOG_INFO_HOME}//%d.log</fileNamePattern>
            <maxHistory>30</maxHistory>
        </rollingPolicy>
    </appender>
    <appender name="ERROR-LOG" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>ERROR</level>
        </filter>
        <encoder>
            <pattern>[%d{yyyy-MM-dd' 'HH:mm:ss.sss}] [%C] [%t] [%L] [%-5p] %m%n</pattern>
        </encoder>
        <!--滾動(dòng)策略-->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!--路徑-->
            <fileNamePattern>${LOG_ERROR_HOME}//%d.log</fileNamePattern>
            <maxHistory>30</maxHistory>
        </rollingPolicy>
    </appender>

    <root level="info">
        <appender-ref ref="CONSOLE-LOG" />
        <appender-ref ref="INFO-LOG" />
        <appender-ref ref="ERROR-LOG" />
    </root>
</configuration>

部分標(biāo)簽說明

<root>標(biāo)簽澜倦，必填標(biāo)簽聚蝶，用來指定最基礎(chǔ)的日志輸出級(jí)別

• <appender-ref>標(biāo)簽，添加append

<append>標(biāo)簽藻治，通過使用該標(biāo)簽指定日志的收集策略

• name屬性指定appender命名

• class屬性指定輸出策略碘勉，通常有兩種，控制臺(tái)輸出和文件輸出桩卵，文件輸出就是將日志進(jìn)行一個(gè)持久化验靡。ConsoleAppender將日志輸出到控制臺(tái)

<filter>標(biāo)簽倍宾，通過使用該標(biāo)簽指定過濾策略

• <level>標(biāo)簽指定過濾的類型

<encoder>標(biāo)簽，使用該標(biāo)簽下的<pattern style="margin: 0px; padding: 0px; max-width: 100%; box-sizing: border-box; word-wrap: break-word !important; font-size: inherit; color: inherit; line-height: inherit;">標(biāo)簽指定日志輸出格式
<rollingPolicy>標(biāo)簽指定收集策略晴叨，比如基于時(shí)間進(jìn)行收集</pattern>

• <fileNamePattern>標(biāo)簽指定生成日志保存地址凿宾，通過這樣配置已經(jīng)實(shí)現(xiàn)了分類分天手機(jī)日志的目標(biāo)了

image

logback 高級(jí)特性異步輸出日志

之前的日志配置方式是基于同步的矾屯，每次日志輸出到文件都會(huì)進(jìn)行一次磁盤IO兼蕊。采用異步寫日志的方式而不讓此次寫日志發(fā)生磁盤IO，阻塞線程從而造成不必要的性能損耗件蚕。異步輸出日志的方式很簡單孙技，添加一個(gè)基于異步寫日志的appender，并指向原先配置的appender即可

<!-- 異步輸出 -->
    <appender name="ASYNC-INFO" class="ch.qos.logback.classic.AsyncAppender">
        <!-- 不丟失日志.默認(rèn)的,如果隊(duì)列的80%已滿,則會(huì)丟棄TRACT排作、DEBUG牵啦、INFO級(jí)別的日志 -->
        <discardingThreshold>0</discardingThreshold>
        <!-- 更改默認(rèn)的隊(duì)列的深度,該值會(huì)影響性能.默認(rèn)值為256 -->
        <queueSize>256</queueSize>
        <!-- 添加附加的appender,最多只能添加一個(gè) -->
        <appender-ref ref="INFO-LOG"/>
    </appender>

    <appender name="ASYNC-ERROR" class="ch.qos.logback.classic.AsyncAppender">
        <!-- 不丟失日志.默認(rèn)的,如果隊(duì)列的80%已滿,則會(huì)丟棄TRACT、DEBUG妄痪、INFO級(jí)別的日志 -->
        <discardingThreshold>0</discardingThreshold>
        <!-- 更改默認(rèn)的隊(duì)列的深度,該值會(huì)影響性能.默認(rèn)值為256 -->
        <queueSize>256</queueSize>
        <!-- 添加附加的appender,最多只能添加一個(gè) -->
        <appender-ref ref="ERROR-LOG"/>
    </appender>

異步輸出日志性能測試

既然能提高性能的話哈雏，必須進(jìn)行一次測試比對(duì)，同步和異步輸出日志性能到底能提升多少倍衫生？

服務(wù)器硬件

• CPU 六核

• 內(nèi)存 8G

測試工具

• Apache Jmeter

同步輸出日志

• 線程數(shù)：100

• Ramp-Up Loop(可以理解為啟動(dòng)線程所用時(shí)間) ：0

• 可以理解為100個(gè)線程同時(shí)啟用

測試結(jié)果

image

重點(diǎn)關(guān)注指標(biāo)Throughput【TPS】吞吐量：系統(tǒng)在單位時(shí)間內(nèi)處理請(qǐng)求的數(shù)量裳瘪，在同步輸出日志中TPS為44.2/sec

異步輸出日志

• 線程數(shù) 100

• Ramp-Up Loop：0

測試結(jié)果

image

TPS為497.5/sec，性能提升了10多倍Ｗ镎搿Ｅ砀！

異步日志輸出原理

從logback框架下的Logger.info方法開始追蹤泪酱。一路的方法調(diào)用路徑如下圖所示：

image

異步輸出日志中最關(guān)鍵的就是配置文件中ch.qos.logback.classic包下AsyncAppenderBase類中的append方法派殷，查看該方法的源碼:

protected void append(E eventObject) {
        if(!this.isQueueBelowDiscardingThreshold() || !this.isDiscardable(eventObject)) {
            this.preprocess(eventObject);
            this.put(eventObject);
        }
    }

通過隊(duì)列情況判斷是否需要丟棄日志，不丟棄的話將它放到阻塞隊(duì)列中墓阀，通過查看代碼毡惜，這個(gè)阻塞隊(duì)列為ArrayBlockingQueueu，默認(rèn)大小為256斯撮，可以通過配置文件進(jìn)行修改经伙。

Logger.info(…)到append(…)就結(jié)束了，只做了將日志塞入到阻塞隊(duì)列的事吮成，然后繼續(xù)執(zhí)行Logger.info(…)下面的語句了橱乱。

在AsyncAppenderBase類中定義了一個(gè)Worker線程，run方法中的關(guān)鍵部分代碼如下:

E e = parent.blockingQueue.take();
aai.appendLoopOnAppenders(e);

最主要的兩個(gè)方法就是encode和write方法粱甫，前一個(gè)法方會(huì)根據(jù)配置文件中encode指定的方式轉(zhuǎn)化為字節(jié)碼泳叠，后一個(gè)方法將轉(zhuǎn)化成的字節(jié)碼寫入到文件中去。所以寫文件是通過新起一個(gè)線程去完成的茶宵，主線程將日志扔到阻塞隊(duì)列中危纫，然后又去做其他事情了。

源碼

https://github.com/TiantianUpup/springboot-log