SpringBoot 實現整合log4j2日誌

orginly發表於2021-06-04
Spring Boot

關於日誌級別

共有8個級別，按照從低到高為：All < Trace < Debug < Info < Warn < Error < Fatal < OFF.

  1. All： 最低等級的，用於開啟所有日誌記錄.
  2. Trace： 是追蹤，就是程式推進以下，你就可以寫個trace輸出，所以trace應該會特別多，不過沒關係，我們可以設定最低日誌級別不讓他輸出.
  3. Debug： 指出細粒度資訊事件對除錯應用程式是非常有幫助的.
  4. Info： 訊息在粗粒度級別上突出強調應用程式的執行過程.
  5. Warn： 輸出警告及warn以下級別的日誌.
  6. Error： 輸出錯誤資訊日誌.
  7. Fatal： 輸出每個嚴重的錯誤事件將會導致應用程式的退出的日誌.
  8. OFF： 最高等級的，用於關閉所有日誌記錄.

程式會列印高於或等於所設定級別的日誌，設定的日誌等級越高，列印出來的日誌就越少。

排除 spring-boot 自帶的 logback 依賴

因為多個日誌元件在一起的話會產生衝突 需要排除 spring-boot 自帶的 logback 依賴
pom.xml中原有的spring-boot-web 依賴中新增 exclusion標籤

<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>

新增 log4j2 依賴

不需要設定版本 會自動跟具當前 spring-boot 版本進行匹配

<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter-log4j2</artifactId>
</dependency>

配置檔案節點解析

根節點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： 指定新建日誌檔案的名稱格式.
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 < Fatal < OFF.
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中進行輸出。

配置 log4j2

將配置 log4j2.xml 配置檔案放在 resource 目錄中
例如以下完整的日誌配置檔案

<?xml version="1.0" encoding="UTF-8"?>
<!--日誌級別以及優先順序排序: OFF > FATAL > ERROR > WARN > INFO > DEBUG > TRACE > ALL -->
<!--Configuration後面的status，這個用於設定log4j2自身內部的資訊輸出，可以不設定，當設定成trace時，你會看到log4j2內部各種詳細輸出-->
<!--monitorInterval：Log4j能夠自動檢測修改配置 檔案和重新配置本身，設定間隔秒數-->
<configuration status="WARN" monitorInterval="30">
    <!--先定義所有的appender-->
    <appenders>
        <!--這個輸出控制檯的配置-->
        <console name="Console" target="SYSTEM_OUT">
            <!--輸出日誌的格式-->
            <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/>
        </console>
        <!--檔案會列印出所有資訊，這個log每次執行程式會自動清空，由append屬性決定，這個也挺有用的，適合臨時測試用-->
        <File name="log" fileName="log/test.log" append="false">
            <PatternLayout pattern="%d{HH:mm:ss.SSS} %-5level %class{36} %L %M - %msg%xEx%n"/>
        </File>
        <!-- 這個會列印出所有的info及以下級別的資訊，每次大小超過size，則這size大小的日誌會自動存入按年份-月份建立的資料夾下面並進行壓縮，作為存檔-->
        <RollingFile name="RollingFileInfo" fileName="${sys:user.home}/IdeaProjects/logs/info.log"
                     filePattern="${sys:user.home}/IdeaProjects/logs/$${date:yyyy-MM}/info-%d{yyyy-MM-dd}-%i.log">
            <!--控制檯只輸出level及以上級別的資訊（onMatch），其他的直接拒絕（onMismatch）-->
            <ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY"/>
            <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/>
            <Policies>
                <!-- 每天滾動一次 -->
                <TimeBasedTriggeringPolicy interval="1" modulate="true" />
                <!-- 或者日誌達到10KB 滾動一次 -->
                <SizeBasedTriggeringPolicy size="10k"/>
            </Policies>
        </RollingFile>
        <RollingFile name="RollingFileWarn" fileName="${sys:user.home}/IdeaProjects/logs/warn.log"
                     filePattern="${sys:user.home}/IdeaProjects/logs/$${date:yyyy-MM}/warn-%d{yyyy-MM-dd}-%i.log">
            <ThresholdFilter level="warn" onMatch="ACCEPT" onMismatch="DENY"/>
            <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/>
            <Policies>
                <!-- 每天滾動一次 -->
                <TimeBasedTriggeringPolicy interval="1" modulate="true" />
                <!-- 或者日誌達到10KB 滾動一次 -->
                <SizeBasedTriggeringPolicy size="10k"/>
            </Policies>
            <!-- DefaultRolloverStrategy屬性如不設定，則預設為最多同一資料夾下7個檔案，這裡設定了20 -->
            <DefaultRolloverStrategy max="20"/>
        </RollingFile>
        <RollingFile name="RollingFileError" fileName="${sys:user.home}/IdeaProjects/logs/error.log"
                     filePattern="${sys:user.home}/IdeaProjects/logs/$${date:yyyy-MM}/error-%d{yyyy-MM-dd}-%i.log">
            <ThresholdFilter level="error" onMatch="ACCEPT" onMismatch="DENY"/>
            <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/>
            <Policies>
                <!-- 每天滾動一次 -->
                <TimeBasedTriggeringPolicy interval="1" modulate="true" />
                <!-- 或者日誌達到10KB 滾動一次 -->
                <SizeBasedTriggeringPolicy size="10k"/>
            </Policies>
        </RollingFile>
    </appenders>
    <!--然後定義logger，只有定義了logger並引入的appender，appender才會生效-->
    <loggers>
        <!--過濾掉spring和mybatis的一些無用的DEBUG資訊-->
        <logger name="org.springframework" level="INFO"/>
        <logger name="org.mybatis" level="INFO"/>
        <root level="all">
            <appender-ref ref="Console"/>
            <appender-ref ref="RollingFileInfo"/>
            <appender-ref ref="RollingFileWarn"/>
            <appender-ref ref="RollingFileError"/>
        </root>
    </loggers>
</configuration>

相關文章