Spring Boot 配置加载顺序详解

Spring Boot 配置加载顺序详解

使用 Spring Boot 会涉及到各类各样的配置，如开发、测试、线上就至少 3 套配置信息了。Spring Boot 能够轻松的帮助咱们使用相同的代码就能使开发、测试、线上环境使用不一样的配置。

在 Spring Boot 里面，可使用如下几种方式来加载配置。本章内容基于 Spring Boot 2.0 进行详解。

1. properties文件；
2. YAML文件；
3. 系统环境变量；
4. 命令行参数；
5. 等等……

配置属性加载的顺序以下：

一、开发者工具 `Devtools` 全局配置参数；

二、单元测试上的 `@TestPropertySource` 注解指定的参数；

三、单元测试上的 `@SpringBootTest` 注解指定的参数；

四、命令行指定的参数，如 `java -jar springboot.jar --name="Java技术栈"`；

五、命令行中的 `SPRING_APPLICATION_JSONJSON` 指定参数, 如 `java -Dspring.application.json='{"name":"Java技术栈"}' -jar springboot.jar`

六、`ServletConfig` 初始化参数；

七、`ServletContext` 初始化参数；

八、JNDI参数（如 `java:comp/env/spring.application.json`）；

九、Java系统参数（来源：`System.getProperties()`）；

十、操做系统环境变量参数；

十一、`RandomValuePropertySource` 随机数，仅匹配：`ramdom.*`；

十二、JAR包外面的配置文件参数（`application-{profile}.properties（YAML）`）

1三、JAR包里面的配置文件参数（`application-{profile}.properties（YAML）`）

1四、JAR包外面的配置文件参数（`application.properties（YAML）`）

1五、JAR包里面的配置文件参数（`application.properties（YAML）`）

1六、`@Configuration`配置文件上 `@PropertySource` 注解加载的参数；

1七、默认参数（经过 `SpringApplication.setDefaultProperties` 指定）；

数字小的优先级越高，即数字小的会覆盖数字大的参数值，咱们来实践下，验证以上配置参数的加载顺序。

一、在主应用程序中添加 Java 系统参数

@Bean
public CommandLineRunner commandLineRunner() {
    return (args) -> {
        System.setProperty("name", "javastack-system-properties");
    };
}

二、在 application.properties 文件中添加属性

name = javastack-application

三、在 application-dev.properties 文件中添加属性

name = javastack-application-dev

四、添加测试类

@RunWith(SpringRunner.class)
@SpringBootTest(value = { "name=javastack-test", "sex=1" })
@ActiveProfiles("dev")
public class SpringBootBestPracticeApplicationTests {

    @Value("${name}")
    private String name;

    @Test
    public void test() {
        System.out.println("name is " + name);
    }
}

运行 test 单元测试，程序输出：

name is javastack-test

根据以上参数动态调整，发现参数会被正确被覆盖。了解了 Spring Boot 各类配置的加载顺序，若是配置被覆盖了咱们就知道是什么问题了。