SpringBoot如何指定加载application-dev.yml配置文件？

Question

在SpringBoot项目中，如何指定加载`application-dev.yml`配置文件？ 默认情况下，SpringBoot会加载`application.yml`或`application.properties`作为全局配置文件。但当项目需要根据不同的环境（如开发、测试、生产）使用不同的配置时，可以通过激活特定的配置文件来实现。例如，要加载`application-dev.yml`，需设置`spring.profiles.active=dev`。此参数可通过多种方式指定：1) 在`application.yml`中直接声明；2) 通过命令行参数传递，如`--spring.profiles.active=dev`；3) 设置环境变量`SPRING_PROFILES_ACTIVE=dev`；4) 在IDE的运行配置中添加VM选项。一旦激活`dev`环境，SpringBoot会自动加载`application.yml`和`application-dev.yml`，后者中的配置会覆盖前者，满足环境特定需求。

Answer 1

1. 基础概念：Spring Boot 配置文件加载机制

Spring Boot 提供了灵活的配置文件管理机制，支持通过激活不同的环境来加载特定的配置文件。默认情况下，Spring Boot 会加载名为 application.yml 或 application.properties 的全局配置文件。

当需要根据开发、测试或生产等不同环境使用特定配置时，可以通过设置 spring.profiles.active 参数来激活相应的配置文件。

• application-dev.yml 是专门为开发环境设计的配置文件。
• application-test.yml 和 application-prod.yml 则分别用于测试和生产环境。

激活某个环境后，Spring Boot 会自动加载 application.yml 和对应的环境配置文件（如 application-dev.yml），并且后者中的配置会覆盖前者。

2. 激活特定环境的常见方法

以下是几种常用的激活特定环境的方法：

1. 在 application.yml 中直接声明 spring.profiles.active 参数。
2. 通过命令行参数传递，例如 --spring.profiles.active=dev。
3. 设置环境变量 SPRING_PROFILES_ACTIVE=dev。
4. 在 IDE 的运行配置中添加 VM 选项，例如 -Dspring.profiles.active=dev。

# 在 application.yml 中声明
spring:
  profiles:
    active: dev

3. 环境配置文件加载优先级

Spring Boot 的配置文件加载遵循一定的优先级规则。以下是一个简单的表格展示：

优先级	来源
最高	命令行参数
较高	环境变量
中等	IDE 运行配置中的 VM 选项
最低	application.yml 中的声明

这意味着如果同时设置了多个来源的 spring.profiles.active，命令行参数将覆盖其他来源的值。

4. 实际案例分析

假设我们有一个 Spring Boot 项目，需要为开发环境加载 application-dev.yml。以下是具体实现步骤：

4.1 方法一：在 application.yml 中声明

spring:
  profiles:
    active: dev

此方法适合固定环境的场景，但不适用于动态切换环境的情况。

4.2 方法二：通过命令行参数传递

在启动项目时，可以通过命令行指定环境：

java -jar myapp.jar --spring.profiles.active=dev

这种方法非常适合临时切换环境的需求。

4.3 方法三：设置环境变量

在 Linux 或 macOS 上，可以通过以下命令设置环境变量：

export SPRING_PROFILES_ACTIVE=dev

在 Windows 上，则可以使用：

set SPRING_PROFILES_ACTIVE=dev

5. 配置文件覆盖机制

Spring Boot 的配置文件覆盖机制确保了环境特定配置的优先级。例如，application-dev.yml 中的配置会覆盖 application.yml 中的同名配置项。

以下是覆盖机制的一个示例：

# application.yml
server:
  port: 8080

# application-dev.yml
server:
  port: 9090

在这种情况下，当激活 dev 环境时，服务器端口将被设置为 9090。

6. 流程图：配置文件加载过程

以下是 Spring Boot 加载配置文件的流程图：

graph TD;
            A[开始] --> B[检查 spring.profiles.active];
            B --> C{是否找到活动环境?};
            C --是--> D[加载对应环境配置文件];
            C --否--> E[仅加载 application.yml];
            D --> F[合并配置并启动应用];
            E --> F;