如何通过自定义环境变量配置Spring Boot自定义配置与日志路径

一、加载自定义配置文件（myproperty.properties） #

方案1：启动阶段通过SpringApplicationBuilder添加额外配置源 #

利用spring.config.additional-location参数添加自定义配置文件（该参数仅添加额外配置，不会覆盖默认配置，且不属于禁用的spring.config.name/location），直接在启动类中读取环境变量并构建路径：

@SpringBootApplication
public class MyApplication {
    public static void main(String[] args) {
        // 读取自定义环境变量MYENV，可设置默认值兜底
        String myEnv = System.getenv("MYENV");
        myEnv = myEnv == null ? "/defaultLocationFiles" : myEnv;
        String configFilePath = myEnv + "/config/myproperty.properties";

        new SpringApplicationBuilder(MyApplication.class)
                .properties("spring.config.additional-location=" + configFilePath)
                .run(args);
    }
}

方案2：实现EnvironmentPostProcessor手动加载配置 #

这种方式完全脱离Spring Boot默认配置参数，通过扩展环境后置处理器自定义加载逻辑：

1. 编写自定义后置处理器类：

import org.springframework.boot.SpringApplication;
import org.springframework.boot.env.EnvironmentPostProcessor;
import org.springframework.core.env.ConfigurableEnvironment;
import org.springframework.core.env.PropertiesPropertySource;
import org.springframework.core.io.FileSystemResource;
import org.springframework.core.io.Resource;
import java.io.IOException;
import java.util.Properties;

public class CustomConfigPostProcessor implements EnvironmentPostProcessor {
    @Override
    public void postProcessEnvironment(ConfigurableEnvironment environment, SpringApplication application) {
        // 从环境变量或系统属性中读取MYENV
        String myEnv = environment.getProperty("MYENV");
        if (myEnv == null) {
            myEnv = "/defaultLocationFiles"; // 默认路径
        }
        String configPath = myEnv + "/config/myproperty.properties";
        Resource configResource = new FileSystemResource(configPath);

        if (configResource.exists()) {
            Properties props = new Properties();
            try {
                props.load(configResource.getInputStream());
                // 将自定义配置添加到环境属性源中
                environment.getPropertySources().addLast(new PropertiesPropertySource("customConfig", props));
            } catch (IOException e) {
                throw new RuntimeException("加载自定义配置文件失败", e);
            }
        }
    }
}

2. 在src/main/resources/META-INF/spring.factories中注册处理器：

org.springframework.boot.env.EnvironmentPostProcessor=com.yourpackage.CustomConfigPostProcessor

二、配置自定义日志文件路径（myLogFile.log） #

日志系统初始化早于Spring上下文，需通过日志框架自身配置或提前设置系统属性实现：

方案1：Logback直接读取环境变量（推荐） #

在logback-spring.xml中通过springProperty标签读取MYENV，拼接日志路径：

<configuration>
    <!-- 读取环境变量MYENV，支持默认值 -->
    <springProperty scope="context" name="myEnvPath" source="MYENV" defaultValue="/defaultLocationFiles"/>
    
    <appender name="CUSTOM_FILE" class="ch.qos.logback.core.FileAppender">
        <file>${myEnvPath}/log/myLogFile.log</file>
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{36} - %msg%n</pattern>
        </encoder>
    </appender>

    <root level="info">
        <appender-ref ref="CUSTOM_FILE"/>
    </root>
</configuration>

方案2：通过EnvironmentPostProcessor设置系统属性 #

在之前的CustomConfigPostProcessor中添加系统属性设置，供日志框架读取：

@Override
public void postProcessEnvironment(ConfigurableEnvironment environment, SpringApplication application) {
    String myEnv = environment.getProperty("MYENV");
    myEnv = myEnv == null ? "/defaultLocationFiles" : myEnv;
    // 设置日志路径系统属性
    System.setProperty("custom.log.path", myEnv + "/log/myLogFile.log");
    
    // 加载自定义配置文件的逻辑...
}

然后在日志配置文件中引用该系统属性：

<file>${custom.log.path:-/defaultLocationFiles/log/myLogFile.log}</file>

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