SpringBoot 2.x整合Log4j2日誌
theme: cyanosis
持續創作，加速成長！這是我參與「掘金日新計劃 · 10 月更文挑戰」的第8天，點選檢視活動詳情
概述
公司的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來修改。
- 新增日誌檔案內容
下面通過一個最精簡的配置內容，下一節詳細講解配置。
```
<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>
```
- 新增測試程式碼
- 檢視結果
Log4j2配置詳解
log4j2日誌級別從低到高，如下：
● trace：追蹤，就是程式推進一下，可以寫個trace輸出
● debug：除錯，一般作為最低級別，trace基本不用。
● info：輸出重要的資訊，使用較多
● warn：警告，有些資訊不是錯誤資訊，但也要給程式設計師一些提示。
● error：錯誤資訊。用的也很多。
● fatal：致命錯誤。
如果一條日誌資訊的級別大於等於配置檔案的級別，就記錄。
配置檔案模板如下：
```
<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>
<!--過濾掉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>
```
根節點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中進行輸出。
總結
本文主要講解了springboot 2.x整合log4j2的教程，希望對大家有幫助。
參考
「其他文章」
- Java7到Java17, Switch語句進化史
- 樂觀鎖思想在JAVA中的實現——CAS
- 一步步帶你設計MySQL索引資料結構
- 我總結了寫出高質量程式碼的12條建議
- 工作這麼多年，我總結的資料傳輸物件 (DTO) 的最佳實踐
- Spring專案中用了這種解耦模式，經理對我刮目相看
- 大資料HDFS憑啥能存下百億資料？
- 5個介面效能提升的通用技巧
- 你的哪些SQL慢？看看MySQL慢查詢日誌吧
- 90%的Java開發人員都會犯的5個錯誤
- 喪心病狂，竟有Thread.sleep(0)這種寫法？
- 為什麼更推薦使用組合而非繼承關係？
- 一個30歲程式設計師的覺醒和進擊
- 推薦8個提高工作效率的IntelliJ外掛
- 公司的這種打包啟動方式，我簡直驚呆了
- 告別醜陋判空，一個Optional類搞定
- 你不知道的Map家族中的那些冷門容器
- SpringBoot 2.x整合Log4j2日誌
- SpringBoot應用自定義logback日誌
- 你確定懂了Java中的序列化機制嗎