Spring Cloud 配置文件使用規(guī)范詳解
在 Spring Cloud 項(xiàng)目中澳泵，配置文件的合理管理是應(yīng)用穩(wěn)定運(yùn)行和維護(hù)的基礎(chǔ)。本文將詳細(xì)講解配置文件的作用重慢、加載順序测僵、優(yōu)先級(jí)以及使用最佳實(shí)踐票唆，特別是在 Nacos 作為配置中心和注冊(cè)中心的情況下朴读。
一、配置文件的作用和加載順序
1.1 配置文件類(lèi)型及作用
-
bootstrap.properties/bootstrap.yml-
作用：
- 應(yīng)用程序引導(dǎo)階段加載的配置走趋，主要用于連接 外部配置中心（如 Nacos Config）和 注冊(cè)中心（如 Nacos Discovery）衅金。
- 存儲(chǔ)一些需要優(yōu)先加載的配置，例如加密解密密鑰或遠(yuǎn)程配置中心的地址簿煌。
-
加載時(shí)機(jī)：在 Spring Boot 應(yīng)用上下文初始化之前加載氮唯，屬性優(yōu)先級(jí)高于
application.properties。
-
作用：
-
application.properties/application.yml- 作用：應(yīng)用的主配置文件啦吧，定義通用的配置項(xiàng)您觉，如數(shù)據(jù)庫(kù)、緩存授滓、隊(duì)列等服務(wù)的連接信息琳水。
-
加載時(shí)機(jī)：在
bootstrap.properties之后加載，由應(yīng)用程序上下文管理般堆。
-
環(huán)境特定配置文件
- 作用：根據(jù)運(yùn)行環(huán)境（如開(kāi)發(fā)在孝、測(cè)試、生產(chǎn)）加載特定配置淮摔。
-
命名規(guī)范：
application-{profile}.properties或application-{profile}.yml私沮。 -
激活方式：
-
spring.profiles.active（推薦） -
spring.config.activate.on-profile（Spring Boot 2.4.0 及以上版本）
-
二、bootstrap.properties 的使用規(guī)范
2.1 作用與內(nèi)容
-
作用：
- 配置外部配置中心（如 Nacos Config）的連接信息和橙。
- 定義全局性配置仔燕，優(yōu)先級(jí)高于應(yīng)用上下文中的配置。
三魔招、Nacos 配置中心與本地配置的關(guān)系
3.1 默認(rèn)行為
遠(yuǎn)程配置優(yōu)先級(jí)高于本地配置：默認(rèn)情況下晰搀，Nacos 配置中心的配置會(huì)覆蓋 application.properties 和 application.yml 中的同名屬性。這是因?yàn)?Nacos 配置默認(rèn)加載在 Spring 的 Environment 中較高的優(yōu)先級(jí)位置办斑。
3.2 本地配置覆蓋遠(yuǎn)程配置
如果希望本地配置優(yōu)先于遠(yuǎn)程配置外恕，可以在 bootstrap.properties 或 bootstrap.yml 中設(shè)置以下屬性：
# 如果設(shè)置為 false，本地配置優(yōu)先級(jí)高于遠(yuǎn)程配置,
spring.cloud.nacos.config.override-local-properties=false
# 如果您希望遠(yuǎn)程配置優(yōu)先級(jí)高于本地配置乡翅，請(qǐng)?jiān)O(shè)置為 true
spring.cloud.nacos.config.override-local-properties=true
注：由于 Nacos 配置中心不支持像 Spring Cloud Config 那樣的系統(tǒng)屬性覆蓋控制鳞疲，所以沒(méi)有與 spring.cloud.config.override-system-properties 等效的配置項(xiàng)，以下是Spring Cloud Config的相關(guān)配置
# 如果本地配置優(yōu)先級(jí)高蠕蚜，那么 override-none 設(shè)置為 true尚洽，包括系統(tǒng)環(huán)境變量、本地配置文件等配置
spring.cloud.config.override-none=true
# 如果想要遠(yuǎn)程配置優(yōu)先級(jí)高靶累，那么 allow-override 設(shè)置為 false翎朱，如果想要本地配置優(yōu)先級(jí)高那么 allow-override 設(shè)置為 true
spring.cloud.config.allow-override=true
# 只有系統(tǒng)環(huán)境變量或者系統(tǒng)屬性才能覆蓋遠(yuǎn)程配置文件的配置橄维，本地配置文件中配置優(yōu)先級(jí)低于遠(yuǎn)程配置；注意本地配置文件不是系統(tǒng)屬性
spring.cloud.config.override-system-properties=fals
四拴曲、環(huán)境特定配置文件的使用規(guī)范
4.1 激活方式
-
命令行激活
java -jar my-app.jar --spring.profiles.active=prod -
配置文件激活（推薦用于 Spring Boot 2.4+）：
在application.properties文件中使用spring.config.activate.on-profile動(dòng)態(tài)激活：spring.config.activate.on-profile=local
五争舞、最佳實(shí)踐
5.1 合理組織配置文件
-
通用配置：放在
application.properties或 Nacos 的共享配置中。 -
環(huán)境特定配置：使用
application-{profile}.properties或 Nacos 命名空間澈灼。
5.2 使用動(dòng)態(tài)激活功能
通過(guò) spring.profiles.active 或者 spring.config.activate.on-profile 簡(jiǎn)化環(huán)境配置文件的管理竞川，避免頻繁修改主配置文件。
5.3 敏感信息管理
- 避免明文存儲(chǔ)：使用 Nacos 加密存儲(chǔ)敏感信息叁熔，或通過(guò)環(huán)境變量注入委乌。
- 優(yōu)先級(jí)高的配置：將敏感信息放在高優(yōu)先級(jí)的配置源中，避免意外覆蓋荣回。
