Spring Cloud 配置文件使用规范详解

在 Spring Cloud 项目中，配置文件的合理管理是应用稳定运行和维护的基础。本文将详细讲解配置文件的作用、加载顺序、优先级以及使用最佳实践，特别是在 Nacos 作为配置中心和注册中心的情况下。

一、配置文件的作用和加载顺序

1.1 配置文件类型及作用

bootstrap.properties / bootstrap.yml
- 作用：
  - 应用程序引导阶段加载的配置，主要用于连接 外部配置中心（如 Nacos Config）和 注册中心（如 Nacos Discovery）。
  - 存储一些需要优先加载的配置，例如加密解密密钥或远程配置中心的地址。
- 加载时机：在 Spring Boot 应用上下文初始化之前加载，属性优先级高于 application.properties。
application.properties / application.yml
- 作用：应用的主配置文件，定义通用的配置项，如数据库、缓存、队列等服务的连接信息。
- 加载时机：在 bootstrap.properties 之后加载，由应用程序上下文管理。
环境特定配置文件
- 作用：根据运行环境（如开发、测试、生产）加载特定配置。
- 命名规范：application-{profile}.properties 或 application-{profile}.yml。
- 激活方式：
  - spring.profiles.active（推荐）
  - spring.config.activate.on-profile（Spring Boot 2.4.0 及以上版本）

二、`bootstrap.properties` 的使用规范

2.1 作用与内容

作用：
- 配置外部配置中心（如 Nacos Config）的连接信息。
- 定义全局性配置，优先级高于应用上下文中的配置。

三、Nacos 配置中心与本地配置的关系

3.1 默认行为

远程配置优先级高于本地配置：默认情况下，Nacos 配置中心的配置会覆盖 application.properties 和 application.yml 中的同名属性。这是因为 Nacos 配置默认加载在 Spring 的 Environment 中较高的优先级位置。

3.2 本地配置覆盖远程配置

如果希望本地配置优先于远程配置，可以在 bootstrap.properties 或 bootstrap.yml 中设置以下属性：

# 如果设置为 false，本地配置优先级高于远程配置,
spring.cloud.nacos.config.override-local-properties=false
# 如果您希望远程配置优先级高于本地配置，请设置为 true
spring.cloud.nacos.config.override-local-properties=true

注：由于 Nacos 配置中心不支持像 Spring Cloud Config 那样的系统属性覆盖控制，所以没有与 spring.cloud.config.override-system-properties 等效的配置项，以下是Spring Cloud Config的相关配置

# 如果本地配置优先级高，那么 override-none 设置为 true，包括系统环境变量、本地配置文件等配置
spring.cloud.config.override-none=true
# 如果想要远程配置优先级高，那么 allow-override 设置为 false，如果想要本地配置优先级高那么 allow-override 设置为 true
spring.cloud.config.allow-override=true
# 只有系统环境变量或者系统属性才能覆盖远程配置文件的配置，本地配置文件中配置优先级低于远程配置；注意本地配置文件不是系统属性
spring.cloud.config.override-system-properties=false

四、环境特定配置文件的使用规范

4.1 激活方式

命令行激活

java -jar my-app.jar --spring.profiles.active=prod

配置文件激活（推荐用于 Spring Boot 2.4+）：
在 application.properties 文件中使用 spring.config.activate.on-profile 动态激活：
```
spring.config.activate.on-profile=local
```

五、最佳实践

5.1 合理组织配置文件

通用配置：放在 application.properties 或 Nacos 的共享配置中。
环境特定配置：使用 application-{profile}.properties 或 Nacos 命名空间。

5.2 使用动态激活功能

通过 spring.profiles.active 或者 spring.config.activate.on-profile 简化环境配置文件的管理，避免频繁修改主配置文件。

5.3 敏感信息管理

避免明文存储：使用 Nacos 加密存储敏感信息，或通过环境变量注入。
优先级高的配置：将敏感信息放在高优先级的配置源中，避免意外覆盖。

Spring Cloud 配置文件使用规范详解