Spring Boot 配置文件加载优先级全解析

嘵奇

于 2025-04-08 18:08:15 发布

阅读量1.1k

点赞数 18

分类专栏：提升自己文章标签： spring boot 后端 java

本文链接：https://blog.youkuaiyun.com/qq479850581/article/details/147074310

版权

提升自己专栏收录该内容

83 篇文章

订阅专栏

精心整理了最新的面试资料和简历模板，有需要的可以自行获取

点击前往百度网盘获取
 点击前往夸克网盘获取

Spring Boot 配置文件加载优先级全解析

Spring Boot 的配置文件加载机制是开发者管理不同环境配置的核心功能之一。其通过外部化配置（Externalized Configuration）支持从多种来源加载配置属性，并按照明确的优先级顺序进行覆盖。本文将从基础概念、优先级顺序、配置源解析到最佳实践，全面梳理 Spring Boot 的配置加载规则。

一、Spring Boot 配置加载的核心原则

Spring Boot 的配置加载遵循两个核心原则：

优先级覆盖：高优先级配置源的属性会覆盖低优先级的同名属性。
互补配置：不同配置源的属性可以互补，仅当存在同名属性时才会触发覆盖逻辑。

二、配置源及其优先级顺序

以下是 Spring Boot 支持的配置源及其从高到低的优先级顺序（基于 Spring Boot 2.7+）：

优先级	配置源	说明
1	命令行参数（Command Line Args）	通过 `--key=value` 传递，如 `java -jar app.jar --server.port=8081`
2	`SPRING_APPLICATION_JSON`	环境变量或系统属性中的 JSON 格式配置（支持内联或文件路径）
3	JNDI 属性（`java:comp/env`）	从 JNDI 上下文获取的配置
4	ServletConfig 初始化参数	在 `web.xml` 或 Servlet 3+ 的 `@WebServlet` 中定义的参数
5	ServletContext 初始化参数	类似 ServletConfig，但作用于整个应用上下文
6	JVM 系统属性（`-D`参数）	如 `-Dspring.datasource.url=jdbc:mysql://localhost/db`
7	操作系统环境变量	如 `export SERVER_PORT=8081`（需转换为大写+下划线格式）
8	Profile-specific 配置文件	`application-{profile}.properties` 或 `application-{profile}.yml`
9	默认配置文件	项目中的 `application.properties` 或 `application.yml`
10	`@PropertySource` 注解	在 `@Configuration` 类上通过注解加载的配置文件
11	默认属性（`SpringApplication.setDefaultProperties`）	通过代码设置的默认属性

三、关键配置源详解

1. 命令行参数

最高优先级，适合临时覆盖配置。
示例：java -jar app.jar --server.port=9090 --logging.level.root=DEBUG

2. 环境变量

常用于容器化部署（如 Docker/K8s）。
属性名需转换为大写+下划线，如 spring.datasource.url → SPRING_DATASOURCE_URL。

3. Profile-specific 配置文件

通过 spring.profiles.active 激活指定 Profile。
文件命名格式为 application-{profile}.yml，如 application-dev.yml。
Profile 配置优先级高于默认配置，但低于更高级别的配置源。

4. 默认配置文件

application.yml 优先级高于 application.properties（若两者存在同名属性）。
支持从以下位置加载（按优先级排序）：
1. 项目根目录的 /config 子目录
2. 项目根目录
3. Classpath 下的 /config 目录
4. Classpath 根目录

5. `@PropertySource`

用于加载自定义配置文件，但优先级较低。

示例：

@Configuration
@PropertySource("classpath:custom.properties")
public class AppConfig { }

四、版本差异与注意事项

Spring Boot 2.4+ 的变化：
- 废弃了 spring.config.location 和 spring.config.additional-location 的部分行为。
- 支持 spring.config.import 显式导入配置（如 spring.config.import=configtree:/etc/config/）。
多文档 YAML 文件：
- 可在单个 YAML 文件中通过 --- 分隔不同 Profile 的配置。
- 示例：
```
server:
  port: 8080
---
spring:
  profiles: dev
server:
  port: 8081
```

五、最佳实践

按环境分离配置：
- 使用 application-dev.yml、application-prod.yml 管理不同环境。
- 通过 spring.profiles.active=dev 激活 Profile。
优先使用外部化配置：
- 避免硬编码配置，将敏感信息（如数据库密码）通过环境变量或云平台密钥管理服务注入。
谨慎使用命令行参数：
- 仅用于临时调试，生产环境建议通过环境变量或配置文件管理。
自定义配置位置：
- 启动时指定 --spring.config.location=classpath:/default/,file:./external-config/。

六、常见问题

属性未生效？
- 检查是否有更高优先级的配置源覆盖了当前配置。
- 使用 Environment 端点（需开启 management.endpoints.web.exposure.include=env）查看最终生效的配置。
多 Profile 如何叠加？
- 同时激活多个 Profile（如 spring.profiles.active=dev,db-mysql），配置会按字母顺序加载并合并。
如何禁用默认配置文件？
- 设置 spring.config.name=__dummy__（加载一个不存在的文件）。