springboot日志框架之log4j2-加载系统变量

解决问题1、在日志配置文件中配置了(日志路径)环境变量，变量来源application配置文件，项目启动报错，没有生效。

springboot2.xx版本日志的默认使用的logback日志框架，如果我们使用log4j2，需要更新pom依赖，去掉默认的依赖，增加log4j2的依赖

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <parent>
        <artifactId>springboot-test</artifactId>
        <groupId>org.example</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>log-output-test</artifactId>

    <properties>
        <maven.compiler.source>11</maven.compiler.source>
        <maven.compiler.target>11</maven.compiler.target>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
            <version>${spring.boot.starter.web.version}</version>
            <!--想要用log4j2，就要先排除springboot默认的logback-->
            <exclusions>
                <exclusion>
                    <artifactId>spring-boot-starter-logging</artifactId>
                    <groupId>org.springframework.boot</groupId>
                </exclusion>
            </exclusions>
        </dependency>

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>${lombok.version}</version>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-log4j2</artifactId>
            <version>${spring.boot.starter.log4j2.version}</version>
        </dependency>
    </dependencies>
</project>

log4j2.xml配置文件位置放在resource下面 springboot启动的时候会自动从该位置加载log4j2.xml配置文件，如果文件名不为log4j2.xml， 配置文件指定日志配置的位置。

logging:
  config: classpath:log4j2-liu.xml

log4j2.xml简单的配置文件

<Configuration status="debug" monitorInterval="30" >

    <Properties>
        <property name="log_pattern" value="%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level %class{-1}.%L [TID:%X{TID}] - %msg%xEx%n"/>

        <!-- 保存日志文件目录 -->
        <Property name="file_path" value="${sys:LOG_PATH}"/>
        <!-- 日志文件的最大容量，超过该值就进行备份 -->
        <Property name="file_max_size" value="30MB"/>
        <!-- 备份的文件夹名称 如下为：2020-02 -->
        <Property name="backup_folder" value="$${date:yyyy-MM}"/>
        <!-- 备份文件的后缀，日志文件超过file_max_size会备份到filePattern指定的目录下 -->
        <Property name="backup_file_suffix" value="-%d{yyyy-MM-dd}-%i.log"/>
    </Properties>

    <!--定义appender-->
    <appenders>

        <!--控制台的输出配置-->
        <console name="Console" target="SYSTEM_OUT">
            <!-- 设置控制台只输出INFO及以上级别的信息(onMatch),其他的直接拒绝(onMismatch) -->
            <ThresholdFilter level="INFO" onMatch="ACCEPT" onMismatch="DENY"/>
            <!--输出日志的格式-->
            <PatternLayout pattern="${log_pattern}"/>
        </console>

        <!--
        该RollingFile存储INFO级别的日志，
        默认存储到 fileName 文件中
        超过SizeBasedTriggeringPolicy的设定值，则存储到 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>
                <TimeBasedTriggeringPolicy/>
                <SizeBasedTriggeringPolicy size="${file_max_size}"/>
            </Policies>
            <!-- DefaultRolloverStrategy属性如不设置，则默认为最多同一文件夹下7个文件，超过该数量，会滚动删除前面的记录 -->
            <DefaultRolloverStrategy max="20"/>
        </RollingFile>

    </appenders>
    <!-- 只有定义了logger并使用appender-ref，appender才会生效 -->
    <loggers>
        <!--过滤掉spring和hibernate的一些无用的debug信息-->
        <logger name="org.springframework" level="INFO"/>
        <logger name="org.mybatis" level="INFO">
            <!-- 添加如下设置，控制台会再打印一次 -->
            <AppenderRef ref="Console"/>
        </logger>
        <root level="INFO">
            <appender-ref ref="Console"/>
            <appender-ref ref="RollingFileInfo"/>
        </root>
    </loggers>

</Configuration>

从配置文件中我们看到日志的路径配置"${sys:LOG_PATH}" 通过LOG_PATH获取日志的路径，这个变量是系统变量，对应的配置文件里面的logging.file.path。 通过上述配置实际上我们启动的时候发现有报错日志

项目启动的时候没有获取到变量，导致报错。

思考这个问题❓

既然我们log4j2配置文件执行的时候没有获取到系统变量，大概log4j2加载的时机比应用配置文件application.yml要早，我们知道了log4j2加载的太早了，想想怎么让他在application.yml后面加载。我们知道application.yml里面我们可以指定log4j2配置文件，如果我们在这里指定一个日志配置文件，会不会在application.yml之后加载，那我们就试试。

如果我们这边配置了，经测试发现并没效果，此刻有点挠头，冷静了一会。

想到springboot加载日志配置的模式，默认加载指定位置（resource）、指定名称的文件，例如log4j2默认会加载log4j2.xml，log4j2-spring.xml,log4j2-test.xml等等，如果没有再从application.yml中查询日志配置。

没有看源码，根据我们的猜测验证下。我们再resource下面放两个配置文件

所以我们要使用指定日志配置方式，日志文件我们需要修改成默认加载不到的名字。 例如log4j2-main.xml文件

按照上述配置，我们就可以获取到系统变量了。

另外log4j2配置里面 <Configuration status="debug" monitorInterval="30"

status属性只是用来看到Log4j2启动和加载配置文件时的打印信息。 具体说明这篇文章