29. Spring Boot中的`profiles`是什么？如何实现不同环境的配置管理？

PangHu大约 3 分钟

在 Spring Boot 中，profiles 是一种用于区分和管理不同环境配置的机制。通过使用 profiles，你可以为应用的不同运行环境（如开发、测试、生产）定义不同的配置集。这样，当应用运行在不同环境时，Spring Boot 会自动选择并应用相应的配置。

1. 配置 `profiles`

Spring Boot 提供了两种主要方式来定义和管理 profiles：

配置文件：在 application.properties 或 application.yml 文件中定义多个 profiles。
命令行参数或环境变量：通过启动参数或环境变量来激活特定的 profile。

2. 定义不同环境的配置文件

Spring Boot 的配置文件命名遵循一定的规则，application-{profile}.properties 或 application-{profile}.yml 是与 profiles 关联的配置文件。例如，你可以为开发环境、测试环境和生产环境分别创建不同的配置文件：

2.1 创建不同的配置文件

示例：

application-dev.properties 或 application-dev.yml（开发环境）

spring.datasource.url=jdbc:mysql://localhost:3306/dev_db
spring.datasource.username=dev_user
spring.datasource.password=dev_password

server.port=8080

application-test.properties 或 application-test.yml（测试环境）

spring.datasource.url=jdbc:mysql://localhost:3306/test_db
spring.datasource.username=test_user
spring.datasource.password=test_password

server.port=8081

application-prod.properties 或 application-prod.yml（生产环境）

spring.datasource.url=jdbc:mysql://localhost:3306/prod_db
spring.datasource.username=prod_user
spring.datasource.password=prod_password

server.port=8082

这些文件中的配置将根据激活的 profile 被 Spring Boot 自动加载。

3. 激活 `profiles`

3.1 使用命令行参数激活 `profiles`

可以通过在启动应用时添加命令行参数 --spring.profiles.active={profile} 来激活指定的 profile。

示例：

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

这个命令会启动应用并使用 application-prod.properties 中的配置。

3.2 使用环境变量激活 `profiles`

也可以通过环境变量 SPRING_PROFILES_ACTIVE 来激活 profile。

示例：

export SPRING_PROFILES_ACTIVE=prod
java -jar myapp.jar

这样设置后，应用会使用 application-prod.properties 中的配置。

3.3 在 `application.properties` 中设置默认 `profile`

你可以在主配置文件 application.properties 或 application.yml 中设置一个默认的 profile，它将在没有指定 profile 时生效。

spring.profiles.active=dev

4. 使用 `@Profile` 注解管理 Bean

除了配置文件，Spring Boot 还允许你通过 @Profile 注解来控制特定 profile 下的 Bean 加载。

4.1 `@Profile` 注解示例

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Profile;

@Configuration
public class DataSourceConfig {

    @Bean
    @Profile("dev")
    public DataSource devDataSource() {
        return new DataSource("jdbc:mysql://localhost:3306/dev_db", "dev_user", "dev_password");
    }

    @Bean
    @Profile("prod")
    public DataSource prodDataSource() {
        return new DataSource("jdbc:mysql://localhost:3306/prod_db", "prod_user", "prod_password");
    }
}

在这个示例中，当激活 dev profile 时，将使用 devDataSource() Bean，当激活 prod profile 时，将使用 prodDataSource() Bean。

5. 多个 `profile` 的组合使用

你可以激活多个 profile，并让它们共同生效。激活多个 profile 时，Spring Boot 会按照顺序加载配置，并且后加载的配置会覆盖先前的配置。

5.1 组合使用多个 `profile`

示例：

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

在这个示例中，Spring Boot 会首先加载 application-dev.properties，然后加载 application-debug.properties，后者的配置将覆盖前者相同的配置项。

6. 使用 `@Profile` 注解控制配置类的加载

你也可以使用 @Profile 注解来控制整个配置类的加载。

示例：

import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Profile;

@Configuration
@Profile("test")
public class TestDataSourceConfig {

    // 定义测试环境的数据源配置
}

7. 总结

profiles 是 Spring Boot 中用于管理不同环境配置的机制，可以在 application.properties 或 application.yml 文件中通过不同的文件后缀来定义不同环境的配置。
激活 profile：可以通过命令行参数、环境变量或在主配置文件中设置来激活不同的 profile。
使用 @Profile 注解：可以根据不同的 profile 选择性地加载特定的 Bean 或配置类。
组合使用 profile：可以同时激活多个 profile，并且后激活的 profile 会覆盖先前的配置。

通过 profiles，Spring Boot 可以在不同的环境下灵活地管理配置，这使得应用程序的开发、测试和部署更加方便和高效。