SpringBoot 2.x整合Log4j2紀錄檔的詳細步驟

2022-10-10 14:00:11

概述

公司的spring boot專案不是使用預設的logback作為紀錄檔框架，而是log4j2, 主要原因是logback出現過一個生產問題導致，具體什麼問題難以追溯了。本文主要講解下SpringBoot 2.x如何更換springboot的紀錄檔框架為log4j2, 以及log4j2的設定。

整合步驟

本次演示採用的springboot 版本為2.7.x。

依賴引入

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
    <exclusions>
        <exclusion>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-logging</artifactId>
        </exclusion>
    </exclusions>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-log4j2</artifactId>
</dependency>

需要排除掉logback紀錄檔框架的依賴spring-boot-starter-logging
引入log4j2的依賴spring-boot-starter-log4j2

新增log4j2組態檔

在classpath下新增log4j2-spring.xml或者log4j2.xml檔案，建議使用log4j-spring.xml，這種方式spring可以控制初始化。
如果你不想把設定放到classpath下，需要自定義位置，可以在組態檔中通過設定項logging.config: ./log4j2.xml來修改。

新增紀錄檔檔案內容

下面通過一個最精簡的設定內容，下一節詳細講解設定。

<?xml version="1.0" encoding="UTF-8"?>
<configuration monitorInterval="5">
    <!--變數設定-->
    <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="./logs"/>
        <property name="FILE_NAME" value="log4j2Demo"/>
    </Properties>

    <appenders>
        <Console name="Console" target="SYSTEM_OUT">
            <!--設定紀錄檔格式及顏色-->
            <PatternLayout
                    pattern="%style{%d{ISO8601}}{bright,green} %highlight{%-5level} [%style{%t}{bright,blue}] %style{%C{}}{bright,yellow}: %msg%n%style{%throwable}{red}"
                    disableAnsi="false" noConsoleNoAnsi="false"/>
        </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>
        <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>

新增測試程式碼

檢視結果

Log4j2設定詳解

log4j2紀錄檔級別從低到高，如下：

● trace：追蹤，就是程式推進一下，可以寫個trace輸出

● debug：偵錯，一般作為最低階別，trace基本不用。

● info：輸出重要的資訊，使用較多

● warn：警告，有些資訊不是錯誤資訊，但也要給程式設計師一些提示。

● error：錯誤資訊。用的也很多。

● fatal：致命錯誤。

如果一條紀錄檔資訊的級別大於等於組態檔的級別，就記錄。

組態檔模板如下：

<?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="%style{%d{ISO8601}}{bright,green} %highlight{%-5level} [%style{%t}{bright,blue}] %style{%C{}}{bright,yellow}: %msg%n%style{%throwable}{red}"
                    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="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>

根節點configuration

屬性status用來指定log4j本身的列印紀錄檔的級別.
屬性monitorinterval用於指定log4j自動重新設定的監測間隔時間，單位是s,最小是5s.

子節點Properties

設定全域性變數，可以通過${xxx}的方式參照

子節點Appenders

常見的有三種Appender: 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節點用來指定專案的根紀錄檔，如果沒有單獨指定logger，那麼就會預設使用該root紀錄檔輸出。

屬性level:紀錄檔輸出級別
屬性appenderRef，用來指定該紀錄檔輸出到哪個Appender。
logger節點用來單獨指定紀錄檔的形式，比如要為指定包下的class指定不同的紀錄檔級別等。
logger節點下屬性name用來指定該Logger所適用的類或者類所在的包全路徑,繼承自root節點。
logger節點下的屬性appenderRef, 用來指定該紀錄檔輸出到哪個Appender,如果沒有指定，就會預設繼承自root。如果指定了，那麼會在指定的這個appender和root的appender中都會輸出，此時我們可以設定Logger的additivity="false"只在自定義的appender中進行輸出。