如何在log4j2.xml中使用application.yml定义的${variable}及监听器顺序问题

我之前也踩过这个坑——在Spring Boot 2.0搭配Spring Cloud Config的场景下，默认的LoggingApplicationListener执行时机居然比ConfigFileApplicationListener还早，直接导致log4j2.xml加载时，application.yml里定义的${variable}变量还没被解析加载，完全没法在日志配置里生效。

问题根源 #

正常Spring Boot环境下，ConfigFileApplicationListener的优先级本应高于日志监听器，但结合Spring Cloud后，配置加载的流程被调整，导致日志系统先完成了初始化，错过了配置加载的时机，自然读不到application.yml里的变量。

亲测有效的解决方案 #

方案一：自定义监听器强制调整执行顺序

我们可以插一个自定义监听器，卡在ConfigFileApplicationListener之后、LoggingApplicationListener之前，确保配置先加载完成再初始化日志：

1. 编写自定义监听器类：

import org.springframework.boot.context.event.ApplicationEnvironmentPreparedEvent;
import org.springframework.boot.logging.LoggingApplicationListener;
import org.springframework.context.ApplicationListener;
import org.springframework.core.Ordered;

public class PreloadConfigBeforeLoggingListener implements ApplicationListener<ApplicationEnvironmentPreparedEvent>, Ordered {

    @Override
    public void onApplicationEvent(ApplicationEnvironmentPreparedEvent event) {
        // 不需要额外逻辑，只要这个监听器的顺序比LoggingApplicationListener高，
        // 就能保证ConfigFileApplicationListener先完成配置加载
    }

    @Override
    public int getOrder() {
        // 比LoggingApplicationListener的默认顺序小1，确保先执行
        return LoggingApplicationListener.DEFAULT_ORDER - 1;
    }
}

2. 在src/main/resources/META-INF/spring.factories中注册这个监听器：

org.springframework.context.ApplicationListener=com.your.package.PreloadConfigBeforeLoggingListener

启动项目后，log4j2.xml里的${variable}就能正常读取到application.yml里的配置了。

方案二：利用Spring Cloud Config的系统属性覆盖（适用于Config Server场景）

如果你的项目基于Spring Cloud Config Server，可以把log4j2需要的变量放在Config Server的配置中，让这些配置覆盖系统属性，log4j2就能直接读取到：

1. 在Config Server的对应配置文件（比如application.yml）中添加变量：

custom:
  log:
    path: /var/log/my-application

2. 在客户端的bootstrap.yml里开启系统属性覆盖：

spring:
  cloud:
    config:
      override-system-properties: true

这样这些变量会被加载为系统属性，log4j2.xml里直接使用${custom.log.path}即可正常解析。

验证方式 #

启动项目后，检查日志输出路径或其他使用变量的配置项是否符合预期；也可以在代码中打印Spring Environment中的变量，确认application.yml的配置已被正确加载。

内容的提问来源于stack exchange，提问作者Evilsylvana