剖析Spring Boot中的配置文件加载顺序与优先级

2022-12-04 17:54:45

Spring Boot：深入解析配置文件的加载顺序与优先级

Spring Boot 是一款流行的 Java 框架，它简化了应用程序的开发和部署。配置文件在 Spring Boot 中扮演着至关重要的角色，因为它们提供了应用程序所需的环境和配置信息。本文将深入探讨 Spring Boot 中配置文件的加载顺序和优先级，帮助读者理解应用程序如何加载和处理配置文件。

配置文件加载顺序

Spring Boot 中配置文件的加载顺序如下：

bootstrap.yml/bootstrap.properties： 这些是引导配置文件，在应用程序启动之前加载。它们主要用于设置应用程序的初始环境，例如 Spring Boot 应用程序的名称和端口号。
config/application.yml/application.properties： 这些是应用程序的主配置文件，位于 config 目录中。它们通常包含应用程序的核心配置，例如数据源设置和 bean 定义。
classpath:/application.yml/application.properties： 这些是位于 classpath 路径下的配置文件。它们通常用于覆盖应用程序的主配置文件中的设置。
classpath:/config/application.yml/application.properties： 这些是位于 classpath 路径下的配置文件，但位于 config 子目录中。它们优先级高于其他 classpath 配置文件。

值得注意的是，如果某个位置的配置文件不存在，Spring Boot 会跳过该位置并继续加载下一个配置文件。

配置文件优先级

如果同一个属性在多个配置文件中都被定义，Spring Boot 会按照以下优先级选择最终生效的值：

bootstrap.yml/bootstrap.properties
config/application.yml/application.properties
classpath:/application.yml/application.properties
classpath:/config/application.yml/application.properties

这意味着后面加载的配置文件中的属性值会覆盖前面加载的配置文件中的属性值。

配置文件加载示例

假设我们在以下位置都有一个 application.properties 文件：

config/application.properties
classpath:/application.properties
classpath:/config/application.properties

config/application.properties 文件中有一个属性 "server.port=8080"，而 classpath:/application.properties 和 classpath:/config/application.properties 文件中的 "server.port" 属性值均为 "9090"。

当 Spring Boot 加载配置文件时：

首先，它会加载 bootstrap.yml/bootstrap.properties 文件，但由于我们没有在这些位置放置配置文件，因此 Spring Boot 会跳过此步骤。
接下来，它会加载 config/application.yml/application.properties 文件。由于我们在这个位置放置了一个 application.properties 文件，因此 Spring Boot 会加载该文件。
最后，它会加载 classpath:/application.yml/application.properties 和 classpath:/config/application.yml/application.properties 文件。由于我们在这两个位置都有一个 application.properties 文件，因此 Spring Boot 会加载这两个文件。

最终，Spring Boot 会选择 classpath:/config/application.properties 文件中的 "server.port=9090" 属性作为最终生效的值。

代码示例

@SpringBootApplication
public class ExampleApplication {
    public static void main(String[] args) {
        SpringApplication.run(ExampleApplication.class, args);
    }
}

在上面的示例中，SpringApplication.run() 方法将触发 Spring Boot 应用程序的启动过程，其中包括加载配置文件。

常见问题解答

为什么配置文件的加载顺序很重要？
加载顺序决定了不同配置文件中定义的属性的优先级。后面加载的配置文件中的属性会覆盖前面加载的配置文件中的属性。
如何覆盖应用程序主配置文件中的属性？
可以在 classpath 中创建 application.properties 或 application.yml 文件并覆盖要更改的属性。classpath 中的配置文件优先级高于主配置文件。
可以有多个 bootstrap.yml 文件吗？
不可以。bootstrap.yml 应该是唯一的，它用于设置应用程序的引导配置。
可以将所有配置文件都放在 classpath 中吗？
可以，但建议将应用程序的主配置文件放在 config 目录中，以便更轻松地进行管理和版本控制。
Spring Boot 如何处理没有扩展名的配置文件？
如果没有扩展名，Spring Boot 会假设配置文件是 .properties 文件。但是，最好给配置文件一个明确的扩展名，例如 .yml 或 .properties。