springBoot项目配置文件加载优先级及同配置覆盖问题

背景:

由于目前网上对于springboot配置文件的加载问题,存在着各种不同的说法。所以导致自己不敢确定到底何种结论才是真正正确的,故专门花费了一些时间进行亲自验证。

验证:

在经过自己对配置文件的加载问题进行验证后,发现所谓配置文件的优先级并不一定是固定不变的,而是会受一些前提条件的影响。下面将对bootstrap.properties、bootstrap.yml、application.properties、application.yml这四种我们可能使用到的配置文件的加载优先级问题进行详细的说明(此处以springCloud微服务项目为背景,不然单纯的springBoot项目是不会加载bootstrap配置文件的,且以下说明默认配置文件都是在同一目录)。

一.非活动的profile

首先,在默认的情况下也就是不存在活动的profile(即不指定spring.profiles.active=?)时,四种文件的加载优先级依次为bootstrap.properties -> bootstrap.yml -> application.properties -> application.yml。感兴趣可以在源码上打断点可以得知配置文件的加载分为两次,如图所示:
第一次是bootstrap(.properties/.yml)的加载:
在这里插入图片描述
以此得出加载优先级bootstrap.properties -> bootstrap.yml

第二次是application(.properties/yml)的加载:
在这里插入图片描述
以此得出application.properties -> application.yml。
总结:bootstrap的配置先于application的配置加载,同时.properties的加载又先于.yml的加载,即加载优先级bootstrap.properties -> bootstrap.yml -> application.properties -> application.yml。
需要注意的是:
1.当同一个配置属性在bootstrap.properties和bootstrap.yml文件中都存在时,那么properties中的配置会被加载,而忽略yml文件中的配置(即优先级高的配置覆盖优先级低的配置),不同配置相互互补。此处application(.properties/yml)同理。
2.但当同一配置在bootstrap.properties和application.properties中都存在时,那么虽然优先加载bootstrap.properties但是会被applicatioin.properties中的配置覆盖,此时则变成了低优先级覆盖高优先的配置,所以网上很多文章所说的高优先级覆盖低优先级其实是不严谨的。
3.不同的配置会进行互补操作,即SpringBoot会读取全部的配置文件,加载所有不同的配置项,汇成一个总的配置。

二、活动的profile

例如在指定了spring.profiles.active=dev/test/prod此类时,即有了活动的profile时,加载优先级便会发生变化此时活动的优先级最高,还是直接上图:
在这里插入图片描述
指定profile为dev
在这里插入图片描述
配置文件如上
看一下加载顺序变成怎么样的了,同样第一次先加载bootstrap:
在这里插入图片描述
第二次加载application:
在这里插入图片描述
综上此时的加载优先级变为了bootstrap-dev.yml -> bootstrap.properties -> application-dev.yml ->application.properties。且同属性配置的覆盖问题和之前一样,在同为bootstrap或同为application的情况下,优先级高的覆盖优先级低的。但当同时存在bootstrap和application时后者仍会覆盖前者中的配置。
举例1:假如此时只有bootstrap-dev.yml 和bootstrap.properties且存在相同配置,则使用bootstrap-dev.yml中的配置,此时遵循高优先级覆盖低优先级。
举例2:假如此时有bootstrap-dev.yml 、bootstrap.properties及application.properties且存在相同配置,则使用application.properties中的配置,遵循application覆盖bootstrap原则,同样此时变成了低优先级覆盖高优先级。

三、使用外部配置

如项目使用nacos做配置中心,则存在相同配置时以nacos中配置为主(在没有开启本地覆盖nacos远程配置的情况下),nacos中的配置将会覆盖一切本地相同的配置,不同配置可以和本地进行互补。

扩展nacos开启本地覆盖远程配置

如果需要启动参数或者本地配置覆盖远程配置,那么需要在远程配置里配置上允许重写:
spring.cloud.config.allowOverride=true
但这是不够的,尽管它开启了总开关,但是还有两个默认的小开关卡住了。
应同时添加如下配置:
spring.cloud.config.overrideNone=true
spring.cloud.config.overrideSystemProperties=false
第一个开关是远端不覆盖本地?true 是的不覆盖。
第二个开关是远端是否覆盖系统配置?false 不覆盖。 (默认为true 覆盖)
请注意,第一个小开关包括第二个。
overrideNone = true的话会开启所有包括本地配置和系统配置并忽略掉overrideSystemProperties配置。
如果只想开启overrideSystemProperties,那么就是overrideNone = false,overrideSystemProperties=false。

<think>嗯,用户之前问过MQ的工作模式,现在转向Spring Boot配置文件加载优先级。可能是在学习Spring Boot,或者在项目中遇到了配置冲突的问题。需要确认用户的实际需求,是否在部署时遇到了不环境的配置覆盖问题,或者想了解如何正确管理多环境配置。 首先,Spring Boot配置加载机制确实复杂,因为有多个来源,优先级。用户可能想知道这些优先级顺序,以便正确配置应用。需要系统地列出各个配置源的优先级,从高到低,并举例说明常见场景。 然后,考虑到用户可能对某些细节不太清楚,比如外部化配置、profile-specific文件的作用。需要解释每个配置源的作用,比如命令行参数、JNDI属性、测试环境的@TestPropertySource,以及不位置的配置文件如classpath、file:./config等。 另外,用户可能对如何覆盖配置感兴趣,比如在生产环境中如何通过外部文件覆盖默认配置。需要强调spring.config.location和spring.config.additional-location的使用方法,以及配置文件的命名规则,比如application-{profile}.properties。 还要注意用户是否混淆了配置加载的顺序和profile激活的顺序。可能需要简单提一下profile的激活方式,但重点还是在配置文件优先级上。最后,确保回答结构清晰,分点列出优先级,并给出实际例子帮助理解。</think>好的,Spring Boot配置文件加载遵循特定的优先级规则,不配置源的优先级决定了**最终生效的配置值**。以下是详细解析: --- ### 一、配置加载的核心原则 1. **优先级高的配置覆盖优先级配置** 2. **相配置项以高优先级来源为准** 3. **多环境支持**:通过`spring.profiles.active`指定激活的 Profile --- ### 二、配置优先级(从高到低) 以下按优先级**从高到低**排序,越靠前的配置优先级越高: 1. **命令行参数** - 启动时通过`--key=value`传递,例如: ```bash java -jar app.jar --server.port=8081 ``` 2. **Java 系统属性(`System.getProperties()`)** - 通过`-Dkey=value`设置,例如: ```bash java -Dserver.port=8082 -jar app.jar ``` 3. **操作系统环境变量** - 直接读取操作系统的环境变量(如`SERVER_PORT=8083`)。 4. **`application-{profile}.properties`/`application-{profile}.yml`(Profile 专属文件)** - 例如:`application-prod.properties`会覆盖`application.properties`中的相配置。 5. **非 Profile 专属的配置文件** - `application.properties`或`application.yml`(位于项目外部目录或 classpath 中)。 6. **`@Configuration`注解的类中的`@PropertySource`** - 例如: ```java @Configuration @PropertySource("classpath:custom.properties") public class AppConfig { ... } ``` 7. **默认属性(通过`SpringApplication.setDefaultProperties`设置)** - 在代码中硬编码的默认值。 --- ### 三、配置文件路径的优先级 当存在多个位置的`application.properties`或`application.yml`时,优先级按以下顺序(从高到低): 1. **项目根目录下的`/config`子目录** - `file:./config/`(当前运行目录的 config 文件夹) 2. **项目根目录** - `file:./`(当前运行目录) 3. **Classpath 中的`/config`目录** - `classpath:/config/` 4. **Classpath 根目录** - `classpath:/` **示例**: 若在`file:./config/application.yml`和`classpath:/application.yml`中时定义`server.port`,则前者优先生效。 --- ### 四、Profile 的激活与覆盖 1. **指定激活的 Profile** - 通过命令行:`--spring.profiles.active=prod` - 通过环境变量:`SPRING_PROFILES_ACTIVE=prod` 2. **Profile 专属文件的命名规则** - `application-{profile}.properties`,例如:`application-dev.properties` 3. **多 Profile 叠加** - 可时激活多个 Profile,例如: ```properties spring.profiles.active=dev,db-mysql ``` --- ### 五、外部化配置的扩展 1. **自定义配置位置** - 通过`spring.config.additional-location`添加额外路径: ```bash java -jar app.jar --spring.config.additional-location=file:/etc/app/config/ ``` - 通过`spring.config.location`完全替换默认路径: ```bash java -jar app.jar --spring.config.location=classpath:/default/ ``` --- ### 六、实际应用示例 **场景**:需要为生产环境覆盖端口和数据库配置 1. 创建`application-prod.yml`,内容为: ```yaml server: port: 8080 spring: datasource: url: jdbc:mysql://prod-db:3306/app ``` 2. 启动命令指定 Profile 和额外参数: ```bash java -jar app.jar --spring.profiles.active=prod --server.port=8081 ``` - 最终生效的`server.port`是`8081`(命令行参数优先级最高)。 --- ### 七、总结 Spring Boot 通过灵活的优先级规则实现配置的**分层管理**,开发者可通过以下方式控制配置: - **命令行参数**快速调试 - **Profile 专属文件**隔离环境配置 - **外部目录**适配容器化部署(如 Docker Volume) - **环境变量**兼容云原生场景(如 Kubernetes ConfigMap)
评论 5
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值