Spring Boot第四彈，一文教你如何無感知切換日誌框架？

2020 年 9 月 30 日
筆記
JAVA, springboot, 碼猿技術專欄

持續原創輸出，點擊上方藍字關注我吧

前言

首先要感謝一下讀者朋友們的支援，你們每一個的贊都是對陳某最大的肯定，陳某也會一如既往的加油，奧利給！！！

言歸正傳，上一篇文章寫了Spring Boot的默認日誌框架Logback的基本配置，有興趣的可以看看：Spring Boot第三彈，一文帶你搞懂日誌如何配置？。

今天就來介紹一下Spring Boot如何無感的切換日誌框架？

Spring Boot 版本

本文基於的Spring Boot的版本是2.3.4.RELEASE。

什麼是日誌門面？

前面介紹的日誌框架都是基於日誌門面SLF4j即簡單日誌門面（Simple Logging Facade for Java），SLF4j並不是一個真正的日誌實現，而是一個抽象層，它允許你在後台使用任意一個日誌實現。

使用了slf4j後，對於應用程式來說，無論底層的日誌框架如何變，應用程式不需要修改任意一行程式碼，就可以直接上線了。

如果對SLF4j比較感興趣的可以去官網看看：SLF4j官網

如何做到無感知切換？

SLF4j是日誌門面，無論什麼日誌框架都是基於SLF4j的API實現，因此無論是程式碼列印日誌還是Lombok註解形式列印日誌，都要使用的SLF4j的API，而不是日誌框架的API，這樣才能解耦，做到無感知。因為最終切換的框架只是對於SLF4j的實現，並不是切換SLF4j。

其實這一條在阿里開發手冊中也是明確指出了，如下：

如何切換？

Spring Boot默認是Logback日誌框架，如果需要切換到其他的日誌框架應該如何做？

首先我們先看官網的一張圖，一切都在圖中，如下：

SLF4j只是一個門面，共有兩大特性。一是靜態綁定、二是橋接。

什麼是靜態綁定？：我們以log4j為例。首先我們的application中會使用slf4j的api進行日誌記錄。我們引入適配層的jar包slf4j-log412.jar及底層日誌框架實現log4j.jar。簡單的說適配層做的事情就是把slf4j的api轉化成log4j的api。通過這樣的方式來屏蔽底層框架實現細節。

什麼是橋接？：比如你的application中使用了slf4j，並綁定了logback。但是項目中引入了一個A.jar，A.jar使用的日誌框架是log4j。那麼有沒有方法讓slf4j來接管這個A.jar包中使用log4j輸出的日誌呢？這就用到了橋接包。你只需要引入log4j-over-slf4j.jar並刪除log4j.jar就可以實現slf4j對A.jar中log4j的接管.聽起來有些不可思議。你可能會想如果刪除log4j.jar那A.jar不會報編譯錯誤嘛？答案是不會。因為log4j-over-slf4j.jar實現了log4j幾乎所有public的API。但關鍵方法都被改寫了。不再是簡單的輸出日誌，而是將日誌輸出指令委託給slf4j。

下面就以log4j2為例，切換Spring Boot的日誌框架為Log4j2。

引入依賴

Spring Boot 默認是Logback日誌框架，如果想要切換log4j2肯定是要將Logback的依賴移除，只需要排除web模組中的日誌啟動器即可，如下：

<dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
            <!-- 去掉springboot默認日誌框架logback -->
            <exclusions>
                <exclusion>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-starter-logging</artifactId>
                </exclusion>
            </exclusions>
        </dependency>

排除了默認的logback依賴，肯定是需要引入log4j2的依賴，其實log4j2為了與Spring Boot適配也做了個啟動器，不需要在引入其他的jar包了，只需要添加如下依賴即可：

<!-- 引入log4j2依賴 -->
<dependency> 
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-log4j2</artifactId>
</dependency>

指定配置文件

Spring Boot官方文檔已經給出了默認兩個log4j2的配置的名稱，分別為：log4j2-spring.xml, log4j2.xml，但是建議使用log4j2-spring.xml，因為Spring Boot會做一些擴展，行吧，就整這個放在src/resources文件夾下即可。

另外上篇文章也說過，如果不使用默認的配置名稱，則需要在application.properties指定配置文件，如下：

logging.config=classpath:logging-config.xml

日誌如何配置？

其實log4j2的一些配置和logback很相似，這裡就不再一一介紹，有興趣的可以去官網查查，直接貼出一些即用的配置，如下：

<?xml version="1.0" encoding="UTF-8"?>
<!--Configuration後面的status，這個用於設置log4j2自身內部的資訊輸出，可以不設置，當設置成trace時，你會看到log4j2內部各種詳細輸出-->
<!--monitorInterval：Log4j能夠自動檢測修改配置 文件和重新配置本身，設置間隔秒數-->
<configuration monitorInterval="5">
    <!--日誌級別以及優先順序排序: OFF > FATAL > ERROR > WARN > INFO > DEBUG > TRACE > ALL -->

    <!--變數配置-->
    <Properties>
        <!-- 格式化輸出：%date表示日期，%thread表示執行緒名，%-5level：級別從左顯示5個字元寬度 %msg：日誌消息，%n是換行符-->
        <!-- %logger{36} 表示 Logger 名字最長36個字元 -->
        <property name="LOG_PATTERN" value="%date{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n" />
        <!-- 定義日誌存儲的路徑 -->
        <property name="FILE_PATH" value="更換為你的日誌路徑" />
        <property name="FILE_NAME" value="更換為你的項目名" />
    </Properties>

    <appenders>

        <console name="Console" target="SYSTEM_OUT">
            <!--輸出日誌的格式-->
            <PatternLayout pattern="${LOG_PATTERN}"/>
            <!--控制台只輸出level及其以上級別的資訊（onMatch），其他的直接拒絕（onMismatch）-->
            <ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY"/>
        </console>

        <!--文件會列印出所有資訊，這個log每次運行程式會自動清空，由append屬性決定，適合臨時測試用-->
        <File name="Filelog" fileName="${FILE_PATH}/test.log" append="false">
            <PatternLayout pattern="${LOG_PATTERN}"/>
        </File>

        <!-- 這個會列印出所有的info及以下級別的資訊，每次大小超過size，則這size大小的日誌會自動存入按年份-月份建立的文件夾下面並進行壓縮，作為存檔-->
        <RollingFile name="RollingFileInfo" fileName="${FILE_PATH}/info.log" filePattern="${FILE_PATH}/${FILE_NAME}-INFO-%d{yyyy-MM-dd}_%i.log.gz">
            <!--控制台只輸出level及以上級別的資訊（onMatch），其他的直接拒絕（onMismatch）-->
            <ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY"/>
            <PatternLayout pattern="${LOG_PATTERN}"/>
            <Policies>
                <!--interval屬性用來指定多久滾動一次，默認是1 hour-->
                <TimeBasedTriggeringPolicy interval="1"/>
                <SizeBasedTriggeringPolicy size="10MB"/>
            </Policies>
            <!-- DefaultRolloverStrategy屬性如不設置，則默認為最多同一文件夾下7個文件開始覆蓋-->
            <DefaultRolloverStrategy max="15"/>
        </RollingFile>

        <!-- 這個會列印出所有的warn及以下級別的資訊，每次大小超過size，則這size大小的日誌會自動存入按年份-月份建立的文件夾下面並進行壓縮，作為存檔-->
        <RollingFile name="RollingFileWarn" fileName="${FILE_PATH}/warn.log" filePattern="${FILE_PATH}/${FILE_NAME}-WARN-%d{yyyy-MM-dd}_%i.log.gz">
            <!--控制台只輸出level及以上級別的資訊（onMatch），其他的直接拒絕（onMismatch）-->
            <ThresholdFilter level="warn" onMatch="ACCEPT" onMismatch="DENY"/>
            <PatternLayout pattern="${LOG_PATTERN}"/>
            <Policies>
                <!--interval屬性用來指定多久滾動一次，默認是1 hour-->
                <TimeBasedTriggeringPolicy interval="1"/>
                <SizeBasedTriggeringPolicy size="10MB"/>
            </Policies>
            <!-- DefaultRolloverStrategy屬性如不設置，則默認為最多同一文件夾下7個文件開始覆蓋-->
            <DefaultRolloverStrategy max="15"/>
        </RollingFile>

        <!-- 這個會列印出所有的error及以下級別的資訊，每次大小超過size，則這size大小的日誌會自動存入按年份-月份建立的文件夾下面並進行壓縮，作為存檔-->
        <RollingFile name="RollingFileError" fileName="${FILE_PATH}/error.log" filePattern="${FILE_PATH}/${FILE_NAME}-ERROR-%d{yyyy-MM-dd}_%i.log.gz">
            <!--控制台只輸出level及以上級別的資訊（onMatch），其他的直接拒絕（onMismatch）-->
            <ThresholdFilter level="error" onMatch="ACCEPT" onMismatch="DENY"/>
            <PatternLayout pattern="${LOG_PATTERN}"/>
            <Policies>
                <!--interval屬性用來指定多久滾動一次，默認是1 hour-->
                <TimeBasedTriggeringPolicy interval="1"/>
                <SizeBasedTriggeringPolicy size="10MB"/>
            </Policies>
            <!-- DefaultRolloverStrategy屬性如不設置，則默認為最多同一文件夾下7個文件開始覆蓋-->
            <DefaultRolloverStrategy max="15"/>
        </RollingFile>

    </appenders>

    <!--Logger節點用來單獨指定日誌的形式，比如要為指定包下的class指定不同的日誌級別等。-->
    <!--然後定義loggers，只有定義了logger並引入的appender，appender才會生效-->
    <loggers>

        <!--過濾掉spring和mybatis的一些無用的DEBUG資訊-->
        <logger name="org.mybatis" level="info" additivity="false">
            <AppenderRef ref="Console"/>
        </logger>
        <!--監控系統資訊-->
        <!--若是additivity設為false，則 子Logger 只會在自己的appender里輸出，而不會在 父Logger 的appender里輸出。-->
        <Logger name="org.springframework" level="info" additivity="false">
            <AppenderRef ref="Console"/>
        </Logger>

        <root level="info">
            <appender-ref ref="Console"/>
            <appender-ref ref="Filelog"/>
            <appender-ref ref="RollingFileInfo"/>
            <appender-ref ref="RollingFileWarn"/>
            <appender-ref ref="RollingFileError"/>
        </root>
    </loggers>
</configuration>

上面的配置中如果需要使用的話，需要改掉全局變數中的日誌路徑和項目名稱，如下部分：

<property name="FILE_PATH" value="更換為你的日誌路徑" />
<property name="FILE_NAME" value="更換為你的項目名" />

總結

本篇文章介紹了Spring Boot如何切換日誌框架以及SLF4j一些內容，如果有所收點點在看關注分享一波，謝謝！！！

作者的上個Mybatis專欄已經結束了，作者特意將全部文章整理成冊，關注【碼猿技術專欄】回復關鍵詞Mybatis進階即可領取此冊。

Tags: JAVA springboot 碼猿技術專欄