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 各類配置的加載順序，若是配置被覆蓋了咱們就知道是什麼問題了。