揭秘SpringBoot加载配置文件的优先级，从入门到精通

后端

2023-11-08 22:55:22

Spring Boot：揭秘配置文件加载的优先级

简介

SpringBoot 以其自动配置和便捷性而闻名，这很大程度上归功于其灵活的配置文件加载机制。了解配置文件加载的优先级对于充分利用 SpringBoot 的强大功能至关重要。

加载优先级

SpringBoot 按照特定的顺序加载配置文件，遵循以下优先级：

应用内属性 ：最高优先级，可覆盖所有其他属性来源。
应用包内配置文件 ：位于应用程序类所在包及其子包内的 application.properties 和 application.yml 文件。
类路径配置文件 ：位于类路径中的 application.properties 和 application.yml 文件。
配置中心 ：如 Spring Cloud Config，允许在运行时加载配置文件。
JAR 包默认配置文件 ：当其他来源均未找到配置文件时，SpringBoot 会从 JAR 包中加载默认配置文件（通常是 application.properties 或 application.yml）。

自定义加载顺序

可以通过修改加载顺序来定制配置文件优先级。为此，可以使用 SpringBoot 的 Environment 和 SpringApplication 类，如下所示：

// 创建 SpringApplication 对象
SpringApplication application = new SpringApplication(App.class);

// 设置配置文件加载顺序
application.setDefaultProperties(Collections.singletonMap("spring.profiles.active", "dev"));

// 启动 Spring Boot 应用程序
application.run(args);

示例

假设我们在 src/main/resources/application.yml 中定义了以下属性：

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/mydb

我们还可以在 src/main/java/com/example 中创建自定义 DataSourceConfig 类，该类定义了一个带应用内属性的附加数据源：

@Configuration
public class DataSourceConfig {

    @Value("${my.datasource.url}")
    private String myDatasourceUrl;

    @Bean
    public DataSource dataSource() {
        // 创建数据源，使用 myDatasourceUrl 属性
        // ...
    }
}

在这个示例中，应用内属性 my.datasource.url 的优先级最高，可以覆盖 application.yml 中的 spring.datasource.url 属性。

常见问题解答

可以加载多个配置文件吗？
- 是的，SpringBoot 支持加载多个配置文件。只需将它们放在适当的目录中即可。
加载顺序可以对应用程序配置产生什么影响？
- 加载顺序决定了特定属性的优先级。优先级较高的配置文件将覆盖优先级较低的配置文件中的属性值。
如何调试配置文件加载问题？
- 使用 SpringApplication.getEnvironment() 访问已加载的属性，并使用 spring.config.location 属性查看已加载配置文件的列表。
可以从外部源加载配置文件吗？
- 是的，可以使用 Spring Cloud Config 等配置中心从外部源加载配置文件。
配置文件加载顺序如何影响性能？
- 通常，加载顺序对性能影响很小。但是，如果加载大量配置文件，加载顺序可能会产生轻微影响。