SpringBoot整合Log4j2及配置步驟

更新時間：2023年01月17日 10:28:21 作者：我是流浪者

這篇文章主要介紹了SpringBoot整合Log4j2以及配置詳解,刪除spring-boot-starter-parent默認使用spring-boot-starter-logging依賴，本文結(jié)合實例代碼給大家介紹的非常詳細，對大家的學習或工作具有一定的參考借鑒價值，需要的朋友可以參考下

SpringBoot整合Log4j2以及配置詳解

SpringBoot整合Log4j2步驟：
1、刪除spring-boot-starter-parent默認使用spring-boot-starter-logging依賴
2、在pom.xml中增加spring-boot-starter-log4j2依賴
3、創(chuàng)建log4j2.xml文件即可
4、執(zhí)行，指定目錄會生成相應的log文件

1.加入依賴

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

2.在src.java.main.resources目錄下創(chuàng)建log4j2.xml文件 log4j2.xml文件內(nèi)容如下：

<!--定義appender-->
<appenders>
    <!--控制臺的輸出配置-->
    <console name="Console" target="SYSTEM_OUT">
        <!-- 設(shè)置控制臺只輸出INFO及以上級別的信息(onMatch),其他的直接拒絕(onMismatch) -->
        <ThresholdFilter level="INFO" onMatch="ACCEPT" onMismatch="DENY"/>
        <!--輸出日志的格式-->
        <PatternLayout pattern="${log_pattern}"/>
    </console>

    <!-- 所有的日志信息會打印到此文件中，append=false每次啟動程序會自動清空 -->
    <!-- <File name="all" fileName="${file_path}/all.log" append="true">
        <PatternLayout pattern="${log_pattern}"/>
    </File>-->
    <!--
    該RollingFile存儲INFO級別的日志，
    默認存儲到 fileName 文件中
    超過SizeBasedTriggeringPolicy的設(shè)定值，則存儲到 filePattern 文件中
    -->
    <RollingFile name="RollingFileInfo" fileName="${file_path}/info.log" filePattern="${file_path}/${backup_folder}/info${backup_file_suffix}">
        <!--控制臺只輸出level及以上級別的信息（onMatch），其他的直接拒絕（onMismatch）-->
        <ThresholdFilter level="INFO" onMatch="ACCEPT" onMismatch="DENY"/>
        <!-- 寫入日志文件的模板 -->
        <PatternLayout pattern="${log_pattern}"/>
        <Policies>
            <!-- DefaultRolloverStrategy屬性如不設(shè)置，則默認為最多同一文件夾下7個文件，超過該數(shù)量，會滾動刪除前面的記錄 -->
            <DefaultRolloverStrategy max="5">
				<Delete basePath="" maxDepth="">
					<IfFileName glob="*.log" />
					<IfLastModified age="*1d" />
				</Delete>
			</DefaultRolloverStrategy>
            <!--多長時間滾動一次-->
            <TimeBasedTriggeringPolicy interval="2 hour" />
            <!-- 一個日志文件的最大大小 -->
            <SizeBasedTriggeringPolicy size="${file_max_size}"/>
        </Policies>
    </RollingFile>
    <RollingFile name="RollingFileWarn" fileName="${file_path}/warn.log" filePattern="${file_path}/${backup_folder}/warn${backup_file_suffix}">
        <ThresholdFilter level="WARN" onMatch="ACCEPT" onMismatch="DENY"/>
        <PatternLayout pattern="${log_pattern}"/>
        <Policies>
            <TimeBasedTriggeringPolicy/>
            <SizeBasedTriggeringPolicy size="${file_max_size}"/>
        </Policies>
    </RollingFile>
    <RollingFile name="RollingFileError" fileName="${file_path}/error.log" filePattern="${file_path}/${backup_folder}/error${backup_file_suffix}">
        <ThresholdFilter level="ERROR" onMatch="ACCEPT" onMismatch="DENY"/>
        <PatternLayout pattern="${log_pattern}"/>
        <Policies>
            <TimeBasedTriggeringPolicy/>
            <SizeBasedTriggeringPolicy size="${file_max_size}"/>
        </Policies>
    </RollingFile>
</appenders>
<!-- 只有定義了logger并使用appender-ref，appender才會生效 -->
<loggers>
    <!--過濾掉spring和hibernate的一些無用的debug信息-->
    <logger name="org.springframework" level="INFO"/>
    <logger name="org.mybatis" level="INFO">
        <!-- 添加如下設(shè)置，控制臺會再打印一次 -->
        <AppenderRef ref="Console"/>
    </logger>
    <root level="INFO">
        <appender-ref ref="Console"/>
        <appender-ref ref="RollingFileInfo"/>
        <appender-ref ref="RollingFileWarn"/>
        <appender-ref ref="RollingFileError"/>
    </root>
</loggers>

3.配置參數(shù)詳解

1.日志級別

機制：如果一條日志信息的級別大于等于配置文件的級別，就記錄。
trace：追蹤，就是程序推進一下，可以寫個trace輸出
debug：調(diào)試，一般作為最低級別，trace基本不用。
info：輸出重要的信息，使用較多
warn：警告，有些信息不是錯誤信息，但也要給程序員一些提示。
error：錯誤信息。用的也很多。
fatal：致命錯誤。

2.輸出源

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

3. 格式

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

4.PatternLayout自定義日志布局：

%d：顯示日志記錄時間，{<日期格式>}使用ISO8601定義的日期格式
如：%d{yyyy-MM-dd HH:mm:ss}
%-5level : 輸出日志級別，-5表示左對齊并且固定輸出5個字符，如果不足在右邊補0
%c : 列出logger名字空間的全稱，如果加上{<層數(shù)>}表示列出從最內(nèi)層算起的指定層數(shù)的名字空間
%C : 列出調(diào)用logger的類的全名（包含包路徑）
%t : 輸出當前線程名稱
%p : 日志輸出格式
%m : 日志內(nèi)容，即 logger.info(“message”)
%M : 方法名
%n : 換行符
%F: 顯示調(diào)用logger的源文件名
%L : 行號
%l : 輸出語句所在的行數(shù), 包括類名、方法名、文件名、行數(shù)
%r : 顯示從程序啟動時到記錄該條日志時已經(jīng)經(jīng)過的毫秒數(shù)
%t : 輸出產(chǎn)生該日志事件的線程名
%x : 按NDC（Nested Diagnostic Context，線程堆棧）順序輸出日志
例：假設(shè)某程序調(diào)用順序是MyApp調(diào)用com.foo.Bar

 %c%x - %m%n ：MyApp - Call com.foo.Bar.com.foo.Bar - Log in Bar MyApp - Return to MyApp.

hostName : 本地機器名
hostAddress : 本地ip地址

4.log4j2配置詳解

根節(jié)點Configuration
有兩個屬性:

status
monitorinterval

有兩個子節(jié)點:

Appenders
Loggers(表明可以定義多個Appender和Logger).

status用來指定log4j本身的打印日志的級別.
monitorinterval用于指定log4j自動重新配置的監(jiān)測間隔時間，單位是s,最小是5s.

Appenders節(jié)點

常見的有三種子節(jié)點:Console、RollingFile、File

Console節(jié)點用來定義輸出到控制臺的Appender.

name:指定Appender的名字.
target:SYSTEM_OUT 或 SYSTEM_ERR,一般只設(shè)置默認:SYSTEM_OUT.
PatternLayout:輸出格式，不設(shè)置默認為:%m%n.

File節(jié)點用來定義輸出到指定位置的文件的Appender.

name:指定Appender的名字.
fileName:指定輸出日志的目的文件帶全路徑的文件名.
PatternLayout:輸出格式，不設(shè)置默認為:%m%n.
RollingFile節(jié)點用來定義超過指定條件自動刪除舊的創(chuàng)建新的Appender.
name:指定Appender的名字.
fileName:指定輸出日志的目的文件帶全路徑的文件名.
PatternLayout:輸出格式，不設(shè)置默認為:%m%n.
filePattern : 指定當發(fā)生Rolling時，文件的轉(zhuǎn)移和重命名規(guī)則.
Policies:指定滾動日志的策略，就是什么時候進行新建日志文件輸出日志.
TimeBasedTriggeringPolicy:Policies子節(jié)點，基于時間的滾動策略，interval屬性用來指定多久滾動一次，默認是1 hour。modulate=true用來調(diào)整時間：比如現(xiàn)在是早上3am，interval是4，那么第一次滾動是在4am，接著是8am，12am…而不是7am.
SizeBasedTriggeringPolicy:Policies子節(jié)點，基于指定文件大小的滾動策略，size屬性用來定義每個日志文件的大小.
DefaultRolloverStrategy:用來指定同一個文件夾下最多有幾個日志文件時開始刪除最舊的，創(chuàng)建新的(通過max屬性)。

Root節(jié)點用來指定項目的根日志，如果沒有單獨指定Logger，那么就會默認使用該Root日志輸出

level:日志輸出級別，共有8個級別，按照從低到高為：All < Trace < Debug < Info < Warn < Error < AppenderRef：Root的子節(jié)點，用來指定該日志輸出到哪個Appender.

Logger節(jié)點用來單獨指定日志的形式，比如要為指定包下的class指定不同的日志級別等。

level:日志輸出級別，共有8個級別，按照從低到高為：All < Trace < Debug < Info < Warn < Error < Fatal < OFF.
name:用來指定該Logger所適用的類或者類所在的包全路徑,繼承自Root節(jié)點.
AppenderRef：Logger的子節(jié)點，用來指定該日志輸出到哪個Appender,如果沒有指定，就會默認繼承自Root.如果指定了，那么會在指定的這個Appender和Root的Appender中都會輸出，此時我們可以設(shè)置Logger的additivity="false"只在自定義的Appender中進行輸出。

關(guān)于日志level.

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

All:最低等級的，用于打開所有日志記錄.
Trace:是追蹤，就是程序推進以下，你就可以寫個trace輸出，所以trace應該會特別多，不過沒關(guān)系，我們可以設(shè)置最低日志級別不讓他輸出.
Debug:指出細粒度信息事件對調(diào)試應用程序是非常有幫助的.
Info:消息在粗粒度級別上突出強調(diào)應用程序的運行過程.
Warn:輸出警告及warn以下級別的日志.
Error:輸出錯誤信息日志.
Fatal:輸出每個嚴重的錯誤事件將會導致應用程序的退出的日志.
OFF:最高等級的，用于關(guān)閉所有日志記錄.

5.測試

在啟動類添加如下信息：

@SpringBootApplication
public class SpringbootDemoApplication {
? ? private static final Logger log = org.slf4j.LoggerFactory.getLogger(SpringbootDemoApplication.class);
? ? public static void main(String[] args) {
? ? ? ? SpringApplication.run(SpringbootDemoApplication.class, args);
? ? ? ? log.error("Something else is wrong here");
? ? ? ? log.info("Something else is wrong here");
? ? ? ? log.warn("Something else is wrong here");
? ? }
}

查看啟動日志：

查看目錄：

進入日期下的目錄下,由于我們設(shè)置了0.5KB作為分隔，并且每個類型最多保留5個文件，所以可以看到下面的情況

現(xiàn)在給大家單獨介紹下springboot整合log4j2的方法

導入依賴

<dependency>
    <groupId>log4j</groupId>
    <artifactId>log4j</artifactId>
    <version>1.2.17</version>
</dependency>

<!--log4j2-->
<dependency>
    <groupId>org.apache.logging.log4j</groupId>
    <artifactId>log4j-core</artifactId>
    <version>2.17.2</version>
</dependency>
<dependency>
    <groupId>org.apache.logging.log4j</groupId>
    <artifactId>log4j-api</artifactId>
    <version>2.17.2</version>
</dependency>

?。?！注意，屏蔽內(nèi)部日志部分必須添加上，因為其自帶的是logback的依賴

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
    <exclusions>
        <!--屏蔽內(nèi)置日志-->
        <exclusion>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-logging</artifactId>
        </exclusion>
    </exclusions>
</dependency>

添加配置文件

<?xml version="1.0" encoding="UTF-8"?>

<Configuration status="WARN">
    <Properties>
        <Property name="patternLayout">%date{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</Property>
        <!--生成日志保存位置-->
        <Property name="logdir">D:/home/demo</Property>
    </Properties>

    <Appenders>
        <Console name="Console" target="SYSTEM_OUT">
            <PatternLayout pattern="${patternLayout}"/>

<!--            <ThresholdFilter level="INFO" onMatch="ACCEPT" onMismatch="DENY"/>-->
            <!--控制臺將會打印執(zhí)行sql及結(jié)果-->
            <!--<ThresholdFilter level="TRACE"/>-->
            <ThresholdFilter level="DEBUG"/>
        </Console>

        <RollingFile name="InfoLogger"
                     fileName="D:/home/demo/debug/log.log"
                     filePattern="D:/home/demo/debug/log_%d{yyyy-MM-dd}.log" append="true">
            <PatternLayout pattern="${patternLayout}"/>
            <ThresholdFilter level="INFO" onMatch="ACCEPT" onMismatch="DENY"/>
            <Policies>
                <!--根據(jù)時間來滾動 -->
                <TimeBasedTriggeringPolicy modulate="true" interval="1"/>
            </Policies>
            <!-- 日志保留策略，配置只保留七天 -->
            <DefaultRolloverStrategy>
                <Delete basePath="${logDir}/debug/" maxDepth="1">
                    <IfFileName glob="log_*.log"/>
                    <IfLastModified age="7d"/>
                </Delete>
            </DefaultRolloverStrategy>
        </RollingFile>

        <!-- sql：保存sql相關(guān)日志 -->
        <RollingFile name="sql"
                     fileName="${logdir}/sql/sql.log"
                     filePattern="${logdir}/sql/sql_%d{yyyy-MM-dd}.log" append="true">
            <PatternLayout pattern="${patternLayout}"/>
            <Policies>
                <TimeBasedTriggeringPolicy modulate="true" interval="1"/>
            </Policies>
            <DefaultRolloverStrategy>
                <Delete basePath="${logDir}/sql/" maxDepth="1">
                    <IfFileName glob="sql_*.log"/>
                    <IfLastModified age="7d"/>
                </Delete>
            </DefaultRolloverStrategy>
        </RollingFile>

    </Appenders>

    <Loggers>
        <!-- 開啟mybatis的sql日志, name和mybatis-config.xml的logPrefix一致 . 級別為debug或trace-->

        <Logger name="com.example.demo.mybatis.plus.dao" level="TRACE" additivity="false">
            <AppenderRef ref="Console"/>
            <AppenderRef ref="sql"/>
        </Logger>

        <Root level="debug">
            <AppenderRef ref="Console"/>
            <AppenderRef ref="InfoLogger"/>
        </Root>

    </Loggers>

</Configuration>

配置文件名字及位置如下圖: log4j2.xml

application.yml配置文件

# 日志配置
logging:
  config: classpath:log4j2.xml
  level:
  	# 查詢接口路徑
    com.example.demo.mybatis.plus.dao: DEBUG

常見問題及解決

① 常見問題
問題原因是沒有排除spring-boot中自帶的日志。

11:34:08.938 [Thread-1] DEBUG org.springframework.boot.devtools.restart.classloader.RestartClassLoader - Created RestartClassLoader org.springframework.boot.devtools.restart.classloader.RestartClassLoader@21253577
Logging system failed to initialize using configuration from 'classpath:log4j2.xml'
java.lang.IllegalStateException: Logback configuration error detected:
ERROR in ch.qos.logback.core.joran.spi.Interpreter@4:17 - no applicable action for [Properties], current ElementPath is [[Configuration][Properties]]