bootstrap.properties 和 application.properties 有何区别 ?

type

status

date

slug

summary

一、概述

1.1 `application.properties`

application.properties是Spring Boot应用程序的主要配置文件。开发者可以在该文件中配置应用程序的各种参数，如数据库连接、端口号、日志级别等。Spring Boot会自动加载application.properties文件，并在应用程序启动时使用其中的配置。

application.properties通常位于src/main/resources目录下，并且可以使用不同的profile来区分不同的环境配置（如application-dev.properties用于开发环境，application-prod.properties用于生产环境）。

1.2 `bootstrap.properties`

bootstrap.properties是Spring Cloud引入的一个配置文件，主要用于配置应用程序启动时的一些初始化设置。这些设置通常与Spring Cloud Config等分布式配置服务相关。bootstrap.properties文件的配置内容在Spring应用程序初始化时就会被加载，比application.properties文件更早。

通常情况下，bootstrap.properties用于配置应用程序从外部配置中心（如Spring Cloud Config Server）加载配置的相关信息，比如配置中心的地址、配置文件的名称、访问凭证等。

二、加载顺序与优先

2.1 加载顺序

bootstrap.properties：加载顺序早于application.properties。它在应用程序上下文（ApplicationContext）创建之前加载。因此，任何定义在bootstrap.properties中的配置都会在Spring的环境准备之前应用。

application.properties：在bootstrap.properties加载之后，application.properties才会被加载。这意味着在application.properties中配置的参数可能会覆盖bootstrap.properties中的配置，除非特定的配置已经在初始化阶段锁定。

2.2 配置优先级

由于bootstrap.properties的加载顺序早于application.properties，因此当配置参数在这两个文件中都存在时，后加载的application.properties中的配置通常会覆盖bootstrap.properties中的配置。

然而，这种覆盖行为在一些特定的场景下可能不成立。例如，Spring Cloud Config的配置信息一旦通过bootstrap.properties加载，通常在应用程序运行期间不会被覆盖。

三、应用场景

3.1 `application.properties`的应用场景

application.properties主要用于定义应用程序的通用配置。这些配置包括但不限于：

数据库连接配置：如JDBC URL、用户名、密码等。

应用程序端口：如server.port=8080。

日志配置：如logging.level.root=INFO。

缓存配置：如spring.cache.type=redis。

Spring相关配置：如Spring Bean的定义、数据源配置等。

此外，application.properties可以通过使用不同的profile来区分环境。例如，在开发环境中使用application-dev.properties，在生产环境中使用application-prod.properties，Spring Boot会根据当前的激活环境选择加载相应的配置文件。

3.2 `bootstrap.properties`的应用场景

bootstrap.properties的主要应用场景是Spring Cloud环境下的配置，它通常用于以下场景：

分布式配置中心的连接配置：例如，Spring Cloud Config Server的地址和凭证配置。

配置加密和解密：如果配置中心存储的配置是加密的，bootstrap.properties中可以配置用于解密的密钥或算法。

应用程序的初始化配置：包括设置应用程序名称、环境等，这些配置通常在应用程序上下文创建之前就需要被加载。

配置文件的远程加载：例如，当配置文件存储在远程服务器上时，bootstrap.properties会包含访问这些文件的必要信息。

这些场景中的配置通常在应用程序启动时就必须确定，或者说这些配置关系到应用程序的基础设施，因此需要在最早的阶段加载。

四、配置示例

4.1 `application.properties`示例

4.2 `bootstrap.properties`示例

在这个示例中，bootstrap.properties中的配置用于连接Spring Cloud Config Server，并指定应用程序在启动时应从远程配置中心加载配置。而application.properties中的配置则用于应用程序的具体运行参数。

五、配置文件扩展与自定义

5.1 外部化配置

Spring Boot支持外部化配置，意味着配置文件不一定需要放在应用程序的内部。开发者可以将application.properties或bootstrap.properties文件放置在外部，例如通过命令行参数、环境变量、JAR包外部的文件等方式提供配置。

5.2 YAML配置

除了.properties文件，Spring Boot还支持.yml格式的配置文件。相比.properties文件，YAML格式更加简洁和层次化，适合用于复杂的配置结构。

例如，将application.properties转换为YAML格式的application.yml：

5.3 自定义配置文件

开发者还可以定义自定义的配置文件，并在Spring Boot应用程序中加载。例如，可以在src/main/resources下创建一个custom.properties文件，并通过Java代码或注解的方式加载：

六、注意事项

6.1 环境隔离

在实际项目中，不同环境（如开发、测试、生产）通常需要不同的配置。为了确保配置隔离，可以为不同的环境创建不同的配置文件，并在启动应用程序时指定激活的profile：

6.2 配置安全性

当应用程序涉及敏感信息（如密码、密钥等）时，务必注意配置文件的安全性。在可能的情况下，应使用加密技术保护敏感配置，或将这些信息存储在更安全的地方，如环境变量或受控的配置中心。

6.3 配置优先级陷阱

由于bootstrap.properties和application.properties的加载顺序不同，开发者可能会遇到配置优先级导致的意外行为。例如，如果在两个文件中配置了同一个参数值，而预期中的值并未生效，这可能与加载顺序有关。在这种情况下，需要仔细检查配置的优先级和覆盖关系。

七、总结

bootstrap.properties和application.properties在Spring Boot和Spring Cloud应用程序中都扮演着重要角色。前者用于配置应用程序启动时的初始化设置，尤其是在与分布式配置中心交互时，而后者则用于配置应用程序运行时的各项参数。理解这两者的区别及其应用场景，对于开发高效、灵活的Spring Boot应用程序至关重要。

通过合理地使用这两个配置文件，开发者可以更好地管理应用程序的配置，使其更容易适应不同的运行环境和需求。同时，借助Spring Boot强大的配置管理机制，开发者可以实现配置的外部化和集中化管理，从而提升应用程序的可维护性和安全性。