Spring Boot应用如何通过命令行参数读取自定义配置文件？

这个需求我之前也碰到过，刚好可以给你梳理两种靠谱的实现方式，还有关于@PropertySource动态使用的问题也一起讲清楚～

一、先纠正启动命令的正确写法 #

首先要注意，JVM系统属性参数-D必须放在-jar前面，否则会被当成应用的命令行参数（而非JVM系统属性），正确命令应该是：

java -DConfigPath=conf/config.local -jar some.jar

如果是绝对路径也可以：

java -DConfigPath=/opt/app/conf/config.prod -jar some.jar

二、两种加载自定义配置的方式 #

方式1：用EnvironmentPostProcessor（推荐，灵活度高） #

这种方式是Spring Boot官方推荐的扩展环境配置的方式，能在应用启动初期就加载自定义配置，还能做各种逻辑判断。

1. 写一个实现EnvironmentPostProcessor的处理器类：

import org.springframework.boot.SpringApplication;
import org.springframework.boot.env.EnvironmentPostProcessor;
import org.springframework.core.env.ConfigurableEnvironment;
import org.springframework.core.env.MutablePropertySources;
import org.springframework.core.io.FileSystemResource;
import org.springframework.core.io.Resource;
import org.springframework.core.io.support.PropertiesLoaderUtils;

import java.io.IOException;
import java.util.Properties;

public class CustomConfigLoader implements EnvironmentPostProcessor {

    @Override
    public void postProcessEnvironment(ConfigurableEnvironment environment, SpringApplication application) {
        // 从JVM系统属性中获取配置路径
        String customConfigPath = System.getProperty("ConfigPath");
        if (customConfigPath != null) {
            Resource configResource = new FileSystemResource(customConfigPath);
            MutablePropertySources propertySources = environment.getPropertySources();
            try {
                // 加载配置文件
                Properties properties = PropertiesLoaderUtils.loadProperties(configResource);
                // 将自定义配置添加到环境中，addFirst表示优先级高于默认配置（会覆盖默认属性）
                propertySources.addFirst(new org.springframework.core.env.PropertiesPropertySource("customExternalConfig", properties));
            } catch (IOException e) {
                throw new RuntimeException("加载自定义配置文件失败：" + customConfigPath, e);
            }
        }
    }
}

2. 注册这个处理器：
   在src/main/resources/META-INF下创建spring.factories文件，添加如下内容：

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

（记得把com.yourpackage改成你自己的包路径）

方式2：用@PropertySource结合SpEL（简洁易用） #

@PropertySource的value属性支持SpEL表达式，所以可以直接通过${ConfigPath}获取JVM系统属性值，实现动态指定配置路径：

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.PropertySource;

@SpringBootApplication
// ignoreResourceNotFound=true 表示如果没指定ConfigPath参数也不会启动失败
@PropertySource(value = "file:${ConfigPath}", ignoreResourceNotFound = true)
public class YourAppApplication {
    public static void main(String[] args) {
        SpringApplication.run(YourAppApplication.class, args);
    }
}

三、关于动态使用@PropertySource的问题 #

当然可以！刚才的方式2就是动态使用的典型场景——通过SpEL表达式${ConfigPath}动态获取命令行传入的配置路径，替代了固定的路径字符串。

不过要注意：@PropertySource是在Spring上下文初始化阶段加载的，所以只能在启动时指定路径，运行时动态修改路径的话它不会重新加载。如果需要运行时刷新配置，就得结合Spring Cloud Config或者@RefreshScope这类方案，但你的需求是启动时指定，这个方式完全够用。

几个注意点 #

• 路径优先级：如果用addFirst添加自定义配置，它的属性会覆盖application.properties里的同名属性；如果用addLast则会被默认配置覆盖。
• 相对路径：使用相对路径时要注意启动命令的工作目录，比如你在/home/user下执行命令，conf/config.local就是/home/user/conf/config.local。
• 异常处理：方式1里可以根据需求调整异常处理逻辑，比如配置文件不存在时要不要抛出异常，或者加载默认配置。

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