SpringBoot 2.x整合Log4j2日志

概述

公司的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.

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

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

SpringBoot 2.x整合Log4j2日志

概述

整合步驟

Log4j2配置詳解

根節點configuration

子節點Properties

子節點Appenders

子節點Loggers

總結

繼續閱讀

SSM整合02---Spring-SpringMVC層一、添加web架構支援二、web.xml三、spring-mvc.xml

SSM架構（二）------------表現層的SpringMVC

Intellij idea基于Maven 的SSM 架構整合

PAT (Advanced Level) Practise 1131 Subway Map (30)

ZOJ 3938 Defuse the Bomb

CSU 1565 Word Cloud

ZOJ 3700 Ever Dream

為什麼要選擇UniDAC

ZOJ 1199 Point of Intersection

CSU 1567 Reverse Rot

SIP Presence SUBSCRIBE-NOTIFY

Spring資料和Redis

SpringMVC的啟動過程源碼分析1 SpringMVC 配置XML的方式啟動2 SpringMVC純注解模式啟動

Java Spring 架構

QName是什麼

SpringCloud微服務（四）之ribbon筆記ribbon是什麼？入門案例自定義均衡負載算法