Spring Boot中引入log4j2及其相关配置详解

环境

springboot 2.3.1

maven依赖

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

在pom文件中引入log4j2的依赖

在这里插入图片描述

尝试启动项目，会发现jar包冲突，导致项目无法正常启动，选择将logback-classic-1.2.3.jar排掉

在这里插入图片描述

通过包与包之间的依赖关系我们可以看到spring-boot-starter->spring-boot-starter-logging->logback-classic

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

直接排掉spring-boot-starter-logging即可正常启动项目
在这里插入图片描述
期间尝试过只排掉logback-classic，项目启动依旧会抛异常

通过异常和拓扑图我们可以得知，log4j2中log4j-slf4j-impl与logging中log4j-to-slf4j 都依赖了log4j-api及slf4j-api

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
    <exclusions>
        <exclusion>
            <groupId>ch.qos.logback</groupId>
            <artifactId>logback-classic</artifactId>
        </exclusion>
        <exclusion>
            <groupId>org.apache.logging.log4j</groupId>
            <artifactId>log4j-to-slf4j</artifactId>
        </exclusion>
    </exclusions>
</dependency>

因此我们需要再排掉log4j-to-slf4j，排掉之后项目可正常启动

以上两种排包方式任选其一即可

日志参数配置

logging:
  config: classpath:log4j2.xml

在application.yml文件中指定配置文件的名称

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <Properties>
        <Property name="LOG_HOME">D:/logs</Property>
    </Properties>
    <appenders>
        <Console name="Console" target="SYSTEM_OUT">
            <PatternLayout pattern="%d %-5p [%t] %C (%F:%L) %m%n" />
        </Console>

        <RollingFile name="RollingFile" fileName="${LOG_HOME}/dst.log"
                     filePattern="${LOG_HOME}/dst-%d{MM-dd-yyyy}.log.gz">
            <PatternLayout pattern="%d %-5p [%t] %C (%F:%L) %m%n"/>
            <Policies>
                <TimeBasedTriggeringPolicy/>
            </Policies>
        </RollingFile>
        <RollingFile name="DebugRollingFile" fileName="${LOG_HOME}/debug-dst.log"
                     filePattern="${LOG_HOME}/debug-dst-%d{MM-dd-yyyy}.log.gz">
            <PatternLayout pattern="%d %-5p [%t] %C (%F:%L) %m%n"/>
            <Policies>
                <TimeBasedTriggeringPolicy/>
            </Policies>
            <Filters>
                <ThresholdFilter level="INFO" onMatch="DENY" onMismatch="NEUTRAL"/>
                <ThresholdFilter level="INFO" onMatch="ACCEPT" onMismatch="NEUTRAL"/>
            </Filters>
        </RollingFile>
        <RollingFile name="InfoAboveRollingFile" fileName="${LOG_HOME}/info-above-dst.log"
                     filePattern="${LOG_HOME}/info-above-dst-%d{MM-dd-yyyy}.log.gz">
            <PatternLayout pattern="%d %-5p [%t] %C (%F:%L) %m%n"/>
            <Policies>
                <TimeBasedTriggeringPolicy/>
            </Policies>
            <Filters>
                <ThresholdFilter level="INFO" onMatch="ACCEPT" onMismatch="DENY"/>
            </Filters>
        </RollingFile>
    </appenders>

    <loggers>
        <logger name="org.springframework" level="ERROR" additivity="true">
        </logger>
        <logger name="org.mybatis" level="DEBUG" additivity="true">
        </logger>
        <logger name="com.alibaba.druid" level="DEBUG" additivity="true">
        </logger>
        <logger name="org.apache.ibatis" level="DEBUG" additivity="true">
        </logger>
        <logger name="org.apache.activemq.ActiveMQSession" level="ERROR" additivity="true">
        </logger>

        <root level="DEBUG">
            <appender-ref ref="Console" />
            <appender-ref ref="RollingFile" />
            <!--<appender-ref ref="DebugRollingFile"/>-->
            <!--<appender-ref ref="InfoAboveRollingFile"/>-->
        </root>
    </loggers>
</configuration>

logf4j.xml文件中配置日志策略

日志参数详解

| Configuration

status:Configuration的属性，用来指定log4j本身的打印日志的级别
monitorinterval:Configuration的属性，用于指定log4j自动重新配置的监测间隔时间，单位是s,最小是5s

Appenders节点，常见的有三种子节点:Console、RollingFile、File

| Console

name:Console的属性，指定Appender的名字
target:Console的属性，SYSTEM_OUT 或 SYSTEM_ERR
PatternLayout:Console的子节点，输出格式，默认为:%m%n
| File

name:File的属性，指定Appender的名字
fileName:File的属性，指定输出日志的目的文件带全路径的文件名
PatternLayout:File的子节点，输出格式，默认为:%m%n
| RollingFile

name:RollingFile的属性，指定Appender的名字
fileName:RollingFile的属性，指定输出日志的目的文件带全路径的文件名
filePattern:RollingFile的属性，指定新建日志文件的名称格式
PatternLayout:RollingFile的子节点，输出格式，默认为:%m%n
DefaultRolloverStrategy:RollingFile的子节点，用来指定同一个文件夹下最多有几个日志文件时开始删除最旧的，创建新的(通过max属性)
Policies:RollingFile的子节点，指定滚动日志的策略，就是什么时候进行新建日志文件输出日志
TimeBasedTriggeringPolicy:Policies子节点，基于时间的滚动策略，interval属性用来指定多久滚动一次，默认是1h
SizeBasedTriggeringPolicy:Policies子节点，基于指定文件大小的滚动策略，size属性用来定义每个日志文件的大小
Filters:RollingFile的子节点，决定日志事件能否被输出。过滤条件有三个值：ACCEPT，DENY，NEUTRAL
ACCEP和DENY比较好理解就是接受和拒绝的意思，在使用单个过滤器的时候，一般就是使用这两个值。但是在组合过滤器中，如果用接受ACCEPT的话，日志信息就会直接写入日志文件,后续的过滤器不再进行过滤。所以，在组合过滤器中，接受使用NEUTRAL，被第一个过滤器接受的日志信息，会继续用后面的过滤器进行过滤，只有符合所有过滤器条件的日志信息，才会被最终写入日志文件
ThresholdFilter:Filters的子节点
level:ThresholdFilterde的属性，将被过滤的级别。
onMatch:ThresholdFilterde的属性，默认值是NEUTRAL
onMismatch:ThresholdFilterde的属性，默认是DENY

Loggers节点，常见的有两种:Root和Logger

| Root

level:Root属性，日志输出级别，共有8个级别，按照从低到高为：All < Trace < Debug < Info < Warn < Error < Fatal < OFF
appender-ref:Root的子节点，用来指定该日志输出到哪个Appender，通过ref指定
| Logger

level:Logger属性，日志输出级别，共有8个级别，按照从低到高为：All < Trace < Debug < Info < Warn < Error < Fatal < OFF.
name:Logger属性，用来指定该Logger所适用的类或者类所在的包全路径,继承自Root节点
additivity:Logger属性
appender-ref:Logger的子节点，用来指定该日志输出到哪个Appender,如果没有指定，就会默认继承自Root.如果指定了，那么会在指定的这个Appender和Root的Appender中都会输出，此时我们可以设置Logger的additivity="false"只在自定义的Appender中进行输出

日志级别

共有8个级别，按照从低到高为：All < Trace < Debug < Info < Warn < Error < Fatal < OFF

All:最低等级的，用于打开所有日志记录

Trace:追踪

Debug:调试

Info:消息在粗粒度级别上突出强调应用程序的运行过程

Warn:输出警告及warn以下级别的日志

Error:输出错误信息日志

Fatal:输出每个严重的错误事件将会导致应用程序的退出的日志

OFF:最高等级的，用于关闭所有日志记录

忘词
忘词
分享日常搬砖学习经验！
公众号
在这里插入图片描述