如何在 Spring Boot 中指定不同的配置文件？

介绍

Spring Boot 提供了多种方式来管理和加载配置文件，特别是在多环境配置下，比如开发、测试和生产环境。通过指定不同的配置文件，可以灵活地调整应用程序的行为，以适应不同的需求。本文将介绍在 Spring Boot 中如何指定使用不同的配置文件，并详细讲解几种常见的方式。

---

1. 通过 application.properties 或 application.yml 文件指定配置

Spring Boot 默认会加载 src/main/resources 目录下的 application.properties 或 application.yml 文件。这两个文件用于配置应用程序的各种属性，如端口、数据源等。

示例：

假设你有一个 application.properties 文件，内容如下：

server.port=8080
spring.datasource.url=jdbc:mysql://localhost:3306/devdb

这种方式非常简单且直观，但如果你希望根据不同的环境（例如开发环境、生产环境）加载不同的配置文件，Spring Boot 允许你使用 Profile 来实现。

---

2. 通过 spring.config.location 指定配置文件的位置

有时你可能需要将配置文件放置在应用程序默认位置以外的地方，Spring Boot 提供了 spring.config.location 参数来指定自定义的配置文件路径。你可以在启动时通过命令行参数来设置这个位置。

示例：

java -jar myapp.jar --spring.config.location=classpath:/custom-config/application.properties

或者，你也可以指定多个配置文件路径：

java -jar myapp.jar --spring.config.location=classpath:/config/,classpath:/other-config/

这种方式非常适合需要使用多个外部配置文件的场景。

---

3. 通过 spring.config.name 指定配置文件的名称

如果你希望使用不同于默认名称（application.properties 或 application.yml）的配置文件，可以通过 spring.config.name 参数来指定配置文件的名称。

示例：

java -jar myapp.jar --spring.config.name=myapp-config

这样，Spring Boot 会去查找名为 myapp-config.properties 或 myapp-config.yml 的配置文件，而不是默认的 application.properties。

---

4. 通过 spring.profiles.active 指定激活的 Profile

Spring Boot 支持 Profile 功能，允许你为不同的环境提供不同的配置。当你在配置文件中配置了多个 profile 时，可以使用 spring.profiles.active 参数来指定要激活的 profile，这样 Spring Boot 会自动加载与该 profile 相关的配置文件。

示例：

在 application.properties 中，你可以这样设置：

spring.profiles.active=dev

如果你希望在命令行中指定，可以这样做：

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

然后，你可以为每个 profile 创建不同的配置文件，例如：

• application-dev.properties 或 application-dev.yml（开发环境）
• application-prod.properties 或 application-prod.yml（生产环境）

Spring Boot 会根据指定的 profile 自动加载相应的配置文件。

---

5. 通过命令行参数指定配置文件

在启动 Spring Boot 应用时，你可以通过命令行参数来直接指定配置文件的位置或名称，这使得动态配置变得非常灵活。

示例：

java -jar myapp.jar --spring.config.location=file:/path/to/config/application.properties

这种方式可以让你指定配置文件的位置，不需要修改源码，只需在启动时指定路径。

---

6. 通过 @PropertySource 指定外部配置文件

@PropertySource 注解允许你在 Java 配置类中加载外部配置文件。通常用于加载不在默认位置的配置文件。这种方式特别适用于从外部位置加载配置文件，而不需要通过命令行或 profile 配置。

示例：

@Configuration
@PropertySource("classpath:external-config.properties")
public class MyConfig {
    // 配置类逻辑
}

在这种方式下，你可以指定具体的外部配置文件路径，无论是类路径中的文件还是文件系统中的文件。

---

7. 通过环境变量指定配置文件

除了通过命令行参数指定配置文件外，你还可以通过操作系统的环境变量来指定配置文件的位置。环境变量可以帮助你在不同的部署环境中灵活地配置应用。

示例：

在 Unix/Linux 系统中，你可以设置环境变量：

export SPRING_CONFIG_LOCATION=/path/to/config/
export SPRING_PROFILES_ACTIVE=prod
java -jar myapp.jar

在 Windows 系统中：

set SPRING_CONFIG_LOCATION=C:\path\to\config\
set SPRING_PROFILES_ACTIVE=prod
java -jar myapp.jar

通过这种方式，你可以在运行时灵活地配置应用的行为，而无需修改配置文件。

---

小结

在 Spring Boot 中，指定不同的配置文件非常灵活。你可以通过以下几种方式来控制应用程序使用的配置文件：

• 使用 spring.config.location 和 spring.config.name 来指定配置文件的位置和名称。
• 通过 spring.profiles.active 来指定加载不同环境的配置。
• 命令行参数和环境变量 提供了灵活的动态配置方式。
• @PropertySource 注解允许在 Java 配置类中加载外部配置文件。

这些方式可以帮助你在不同的环境中轻松切换配置文件，确保应用程序在各个阶段都能按预期运行。根据你的需求选择合适的方式，让配置管理更加灵活和高效。