快捷導(dǎo)航

springboot?log4j2日志框架整合與使用過(guò)程解析

更新時(shí)間：2022年05月06日 09:34:19 作者：字母哥哥

這篇文章主要介紹了springboot?log4j2日志框架整合與使用,包括引入maven依賴和添加配置文件log4j2-spring.xml的相關(guān)知識(shí)，需要的朋友可以參考下

一、引入maven依賴

Spring Boot默認(rèn)使用LogBack，但是我們沒(méi)有看到顯示依賴的jar包，其實(shí)是因?yàn)樗诘膉ar包spring-boot-starter-logging都是作為spring-boot-starter-web或者spring-boot-starter依賴的一部分。
如果這里要使用Log4j2，需要從spring-boot-starter-web中去掉spring-boot-starter-logging依賴，同時(shí)顯示聲明使用Log4j2的依賴jar包，具體如下:

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

另外log4j是之前使用比較廣泛的軟件，容易與log4j2發(fā)生沖突，如果沖突將log4j從相應(yīng)的軟件里面排除掉,比如:dozer

<dependency>
    <groupId>net.sf.dozer</groupId>
    <artifactId>dozer</artifactId>
    <version>5.4.0</version>
    <exclusions>
        <exclusion>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-log4j12</artifactId>
        </exclusion>
    </exclusions>
</dependency>

二、添加配置文件log4j2-spring.xml

在resources目錄下新建一個(gè)log4j2-spring.xml文件，放在src/main/resources目錄下即可被Spring Boot應(yīng)用識(shí)別。

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <properties>
        <!--日志輸出位置-->
        <property name="LOG_HOME">D:/logs</property>
    </properties>

    <Appenders>
        <!-- 將日志輸出到控制臺(tái)-->
        <Console name="CONSOLE" target="SYSTEM_OUT">
            <!--設(shè)置日志格式及顏色-->
            <PatternLayout
                    pattern="[%style{%d}{bright,green}][%highlight{%p}][%style{%t}{bright,blue}][%style{%C}{bright,yellow}]: %msg%n%style{%throwable}{red}"
                    disableAnsi="false" noConsoleNoAnsi="false"/>
        </Console>

        <!-- 將日志輸出到文件-->
        <RollingFile name="FILE-APPENDER"
                     fileName="${LOG_HOME}/log4j2-demo.log"
                     filePattern="${LOG_HOME}/log4j2-demo-%d{yyyy-MM-dd}-%i.log">
            <!--設(shè)置日志格式-->
            <PatternLayout>
                <pattern>[%d][%p][%t][%C] %m%n</pattern>
            </PatternLayout>
            <Policies>
                <!-- 設(shè)置日志文件切分參數(shù) -->
                <SizeBasedTriggeringPolicy size="100 MB"/>
                <TimeBasedTriggeringPolicy/>
            </Policies>
            <!--設(shè)置最大存檔數(shù)-->
            <DefaultRolloverStrategy max="20"/>
        </RollingFile>
    </Appenders>

    <Loggers>
        <!-- 根日志設(shè)置 -->
        <Root level="debug">
            <AppenderRef ref="CONSOLE" level="debug"/>
            <AppenderRef ref="FILE-APPENDER" level="info"/>
        </Root>

        <!--spring日志-->
        <Logger name="org.springframework" level="info"/>
        <!-- mybatis日志 -->
        <Logger name="com.mybatis" level="warn"/>
    </Loggers>
</configuration>

上文兩個(gè)Appender，一個(gè)叫做CONSOLE用于輸出日志到控制臺(tái)，一個(gè)叫做FILE-APPENDER輸出日志到文件
PatternLayout用于指定輸出日志的格式，[%d][%p][%t][%C] %m%n 這些占位符將結(jié)合下文測(cè)試結(jié)果為大家介紹
Policies用于指定文件切分參數(shù)
TimeBasedTriggeringPolicy默認(rèn)的size是1，結(jié)合filePattern定義%d{yyyy-MM-dd}，則每天生成一個(gè)文件（最小的時(shí)間切分粒度是小時(shí)）
<SizeBasedTriggeringPolicy size="100 MB"/> 當(dāng)文件大小到100MB的時(shí)候，切分一個(gè)新的日志文件
<DefaultRolloverStrategy max="20"/>表示文件最大的存檔數(shù)量，多余的將被刪除
上文中的日志格式占位符號(hào)，在文末測(cè)試的時(shí)候?yàn)榇蠹医榻B。

三、自定義配置文件

但是我們通常會(huì)有這樣一個(gè)需求，就是不同的環(huán)境使用不同的配置，比如：我們需要三個(gè)log4j2 xml文件：

log4j2-dev.xml 開(kāi)發(fā)環(huán)境日志配置
log4j2-prod.xml 生產(chǎn)環(huán)境日志配置
log4j2-test.xml 測(cè)試環(huán)境日志配置

但是Spring Boot并不知道log4j2-<profile>.xml這些配置文件是干什么的，所以需要通過(guò)在application.yml文件中顯示聲明才行。

舉例：在application-dev.yml里面使用log4j2-dev.xml配置文件

logging:
    config: classpath:log4j2-dev.xml

以此類(lèi)推，在application-prod.yml里面使用log4j2-prod.xml配置文件，在application-test.yml里面使用log4j2-test.xml配置文件。

四、測(cè)試一下

寫(xiě)個(gè)Controller測(cè)試一下

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
@RestController
public class LogTestController {
    private static final Logger logger = LoggerFactory.getLogger(LogTestController.class);
    @GetMapping("/testlog")
    public void test(){
        logger.trace("Trace 日志...");
        logger.debug("Debug 日志...");
        logger.info("Info 日志...");
        logger.warn("Warn 日志...");
        logger.error("Error 日志...");
    }
}

日志輸出效果如下：

結(jié)合下面代碼說(shuō)一下占位符

<PatternLayout pattern="[%style{%d}{bright,green}][%highlight{%p}][%style{%t}{bright,blue}][%style{%C}{bright,yellow}]: %msg%n%style{%throwable}{red}"
                    disableAnsi="false" noConsoleNoAnsi="false"/>