SpringBoot整合log4j2進行日志配置及防坑指南

寫在前面

        最近項目經理要求將原先項目中的日志配置logBack，修改為log4j2，據說是log4j2性能更優於logback，具體快多少，網上有說快10多倍，看來還是很快的，於是新的一波挑戰又開始了，網上查找各種資料，官方文檔各種啃，最終實現了遷移，所以，鑒於此，特記錄一下，謹防遺忘。

SpringBoot整合log4j2進行日志配置及防坑指南

1、Log4j2優點

         具體優點可以參考官方文檔：https://logging.apache.org/log4j/2.x/

我這邊只簡單說一下：

相比與其他的日志系統，log4j2丟數據的情況少；在多線程環境下，性能高於logback等10倍以上；利用jdk1.5並發的特性，減少了死鎖的發生

這里列舉一下，網上關於相關日志系統的性能測試圖，僅做參考

 2、SpringBoot整合Log4j2配置

2.1>   導入依賴

可以參考SpringBoot官方文檔： https://docs.spring.io/spring-boot/docs/1.5.19.RELEASE/reference/htmlsingle/#howto-configure-log4j-for-logging

        <!-- 排除 Spring-boot-starter 默認的日志配置 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
            <exclusions>
                <exclusion>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-starter-logging</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
        <!-- 引入log4j2依賴 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-log4j2</artifactId>
        </dependency>

避坑指南：

由於springboot默認是用logback的日志框架的，所以需要排除logback，不然會出現jar依賴沖突的報錯；
但是，網上大部分博文，都是以下寫法：

<dependency>  
    <groupId>org.springframework.boot</groupId>  
    <artifactId>spring-boot-starter-web</artifactId>
    <!-- 去掉springboot默認配置 --> 
    <exclusions>  
        <exclusion>  
            <groupId>org.springframework.boot</groupId>  
            <artifactId>spring-boot-starter-logging</artifactId>  
        </exclusion>  
    </exclusions>  
</dependency> 

誠然，這種方法有其存在的合理性，但是如果當前項目中有多個 spring-boot-starter 下的依賴，這時，如果只這樣寫，往往就會出現配置了日志打印到文件中，但是日志文件就是不能生成，所以，關於這部分配置還是建議采用第一種方式，而且springBoot的官方文檔也是這種方式： 

https://docs.spring.io/spring-boot/docs/1.5.19.RELEASE/reference/htmlsingle/#howto-configure-log4j-for-logging

2.2> log4j2配置文件

在你項目的resource目錄下，添加一個配置文件，文件名為 log4j2.xml 或者 log4j2-spring.xml。

避坑指南：

1、如果定義的配置文件名為：log4j2.xml，此時需要在application.yml中添加如下配置：

# log4j2 日志配置
logging:
  config: classpath:log4j2.xml

2、如果定義的配置文件名為：log4j2-spring.xml，此時則不需要再添加上面的配置（建議采用此種方式)

3、log4j是通過一個.properties的文件作為主配置文件的，而現在的log4j2則已經棄用了這種方式，采用的是.xml，.json或者.jsn這種方式來做，可能這也是技術發展的一個必然性，況且properties文件的可閱讀性不友好。這里給出一個模版，供大家參考。（模板如下）

<?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>
        <!-- 格式化輸出： %d表示日期， %thread表示線程名， %-5level：級別從左顯示5個字符寬度 %msg：日志消息，%n是換行符 -->
        <!-- %logger{36} 表示 Logger 名字最長36個字符 -->
        <property name="LOG_PATTERN" value="%d{yyyy-MM-dd HH:mm:ss.SSS} %highlight{%-5level}[%thread] %style{%logger{36}}{cyan} : %msg%n" />

        <!-- 定義日志存儲的路徑，不要配置相對路徑 -->
        <property name="FILE_PATH" value="此處更換為你的日志文件存儲路徑" />
        <property name="FILE_NAME" value="此處更換為你的項目名稱" />
    </Properties>

    <appenders>
        <console name="Console" target="SYSTEM_OUT">
            <!--輸出日志的格式-->
            <PatternLayout pattern="${LOG_PATTERN}" disableAnsi="false" noConsoleNoAnsi="false"/>

            <!--控制台只輸出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="20MB"/>
            </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="20MB"/>
            </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="20MB"/>
            </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>

2.3> 配置參數解釋

這里僅簡單做一下介紹，詳細介紹可參考官方文檔：https://logging.apache.org/log4j/2.x/

1、日志級別

trace：追蹤，就是程序推進一下，可以寫個trace輸出
debug：調試，一般作為最低級別，trace基本不用。
info： 輸出重要的信息，使用較多
warn： 警告，有些信息不是錯誤信息，但也要給程序員一些提示。
error：錯誤信息。用的也很多。
fatal：致命錯誤。

2、輸出源

CONSOLE（輸出到控制台）
FILE   （輸出到文件）

格式

SimpleLayout： 以簡單的形式顯示
HTMLLayout：   以HTML表格顯示
PatternLayout：自定義形式顯示

PatternLayout自定義日志布局：

%d{yyyy-MM-dd HH:mm:ss, SSS} : 日志產生時間,輸出到毫秒的時間
%-5level : 輸出日志級別，-5表示左對齊並且固定輸出5個字符，如果不足在右邊補0
%c : logger的名稱(%logger)
%t : 輸出當前線程名稱
%p : 日志輸出格式
%m : 日志內容，即 logger.info("message")
%n : 換行符
%C : Java類名(%F)
%L : 行號
%M : 方法名
%l : 輸出語句所在的行數, 包括類名、方法名、文件名、行數
hostName : 本地機器名
hostAddress : 本地ip地址

2.4> log4j2.xml配置解釋

根節點Configuration 有兩個屬性: status monitorinterval 有兩個子節點: Appenders Loggers(表明可以定義多個Appender和Logger). status用來指定log4j本身的打印日志的級別. monitorinterval用於指定log4j自動重新配置的監測間隔時間，單位是s,最小是5s. Appenders節點 常見的有三種子節點:Console、RollingFile、File Console節點用來定義輸出到控制台的Appender. name:指定Appender的名字. target:SYSTEM_OUT 或 SYSTEM_ERR,一般只設置默認:SYSTEM_OUT. PatternLayout:輸出格式，不設置默認為:%m%n. File節點用來定義輸出到指定位置的文件的Appender. name:指定Appender的名字. fileName:指定輸出日志的目的文件帶全路徑的文件名. PatternLayout:輸出格式，不設置默認為:%m%n. RollingFile節點用來定義超過指定條件自動刪除舊的創建新的Appender. name:指定Appender的名字. fileName:指定輸出日志的目的文件帶全路徑的文件名. PatternLayout:輸出格式，不設置默認為:%m%n. filePattern : 指定當發生Rolling時，文件的轉移和重命名規則. Policies:指定滾動日志的策略，就是什么時候進行新建日志文件輸出日志. TimeBasedTriggeringPolicy:Policies子節點，基於時間的滾動策略，interval屬性用來指定多久滾動一次，默認是1 hour。modulate=true用來調整時間：比如現在是早上3am，interval是4，那么第一次滾動是在4am，接着是8am，12am...而不是7am. SizeBasedTriggeringPolicy:Policies子節點，基於指定文件大小的滾動策略，size屬性用來定義每個日志文件的大小. DefaultRolloverStrategy:用來指定同一個文件夾下最多有幾個日志文件時開始刪除最舊的，創建新的(通過max屬性)。 Loggers節點，常見的有兩種:Root和Logger. Root節點用來指定項目的根日志，如果沒有單獨指定Logger，那么就會默認使用該Root日志輸出 level:日志輸出級別，共有8個級別，按照從低到高為：All < Trace < Debug < Info < Warn < Error < AppenderRef：Root的子節點，用來指定該日志輸出到哪個Appender. Logger節點用來單獨指定日志的形式，比如要為指定包下的class指定不同的日志級別等。 level:日志輸出級別，共有8個級別，按照從低到高為：All < Trace < Debug < Info < Warn < Error < Fatal < OFF. name:用來指定該Logger所適用的類或者類所在的包全路徑,繼承自Root節點. AppenderRef：Logger的子節點，用來指定該日志輸出到哪個Appender,如果沒有指定，就會默認繼承自Root.如果指定了，那么會在指定的這個Appender和Root的Appender中都會輸出，此時我們可以設置Logger的additivity="false"只在自定義的Appender中進行輸出。

3、結合Lombok使用Log4j2

這里使用Lombok插件主要是為了簡化開發，從而更方便地使用日志。下面只是一個很簡單的Demo，具體使用，大家可以在Controller層添加 @Log4j2 注解，調用對應的log方法進行使用，這里博主就不多做介紹了，相關使用可以參考相關教程。

import lombok.extern.log4j.Log4j2;

@Log4j2
public class LogTest {
    public static void main(String[] args) {
        log.info("this is info log");
        log.error("this is error log");
        log.debug("this is debug log");
        log.warn("this is warn log");
        log.trace("this is trace log");
        log.fatal("this is fatal log");
    }
}

參考鏈接：

• Apache官網： https://logging.apache.org/log4j/2.x/log4j-to-slf4j/index.html
• SpringBoot官網： https://docs.spring.io/spring-boot/docs/1.5.19.RELEASE/reference/htmlsingle/#howto-configure-log4j-for-logging

      相關博文 ：

• https://www.cnblogs.com/keeya/p/10101547.html
• https://blog.csdn.net/Honnyee/article/details/89150820
• https://blog.csdn.net/u013314786/article/details/89280476
• https://blog.csdn.net/fishman45/article/details/88528458