SpringBoot多环境配置详解：Profile+YAML+Apollo动态切换

本文链接：https://blog.csdn.net/ashyyyy/article/details/149387975

🎓博主介绍：Java、Python、js全栈开发 “多面手”，精通多种编程语言和技术，痴迷于人工智能领域。秉持着对技术的热爱与执着，持续探索创新，愿在此分享交流和学习，与大家共进步。
📖DeepSeek-行业融合之万象视界(附实战案例详解100+)
📖全栈开发环境搭建运行攻略：多语言一站式指南(环境搭建+运行+调试+发布+保姆级详解)
👉感兴趣的可以先收藏起来，希望帮助更多的人

SpringBoot多环境配置详解：Profile+YAML+Apollo动态切换

一、引言

在软件开发过程中，我们通常会有多个不同的运行环境，如开发环境（Dev）、测试环境（Test）、生产环境（Prod）等。不同环境的配置可能存在差异，例如数据库连接信息、日志级别等。Spring Boot 提供了多种方式来实现多环境配置，本文将详细介绍如何使用 Profile、YAML 以及 Apollo 来实现多环境配置的动态切换。

二、Spring Boot Profile 配置

2.1 Profile 简介

Spring Boot 的 Profile 功能允许我们根据不同的环境加载不同的配置文件。通过激活不同的 Profile，我们可以轻松地切换应用程序的配置。

2.2 基于 properties 文件的 Profile 配置

2.2.1 创建配置文件

首先，我们创建不同环境的配置文件，例如：

application.properties：通用配置文件
application-dev.properties：开发环境配置文件
application-test.properties：测试环境配置文件
application-prod.properties：生产环境配置文件

以下是示例代码：

# application.properties
server.port=8080

# application-dev.properties
spring.datasource.url=jdbc:mysql://localhost:3306/dev_db
spring.datasource.username=dev_user
spring.datasource.password=dev_password

# application-test.properties
spring.datasource.url=jdbc:mysql://test-server:3306/test_db
spring.datasource.username=test_user
spring.datasource.password=test_password

# application-prod.properties
spring.datasource.url=jdbc:mysql://prod-server:3306/prod_db
spring.datasource.username=prod_user
spring.datasource.password=prod_password

2.2.2 激活 Profile

我们可以通过以下几种方式激活不同的 Profile：

命令行参数：在启动应用程序时，通过 --spring.profiles.active 参数指定要激活的 Profile。

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

系统属性：在 Java 代码中设置系统属性 spring.profiles.active。

System.setProperty("spring.profiles.active", "dev");

配置文件：在 application.properties 中设置 spring.profiles.active。

spring.profiles.active=dev

2.3 基于 YAML 文件的 Profile 配置

2.3.1 创建 YAML 配置文件

YAML 文件以树形结构组织配置信息，更加直观和易读。我们可以将不同环境的配置写在同一个 application.yml 文件中，使用 --- 分隔不同的 Profile。

server:
  port: 8080

spring:
  profiles:
    active: dev

---
spring:
  profiles: dev
  datasource:
    url: jdbc:mysql://localhost:3306/dev_db
    username: dev_user
    password: dev_password

---
spring:
  profiles: test
  datasource:
    url: jdbc:mysql://test-server:3306/test_db
    username: test_user
    password: test_password

---
spring:
  profiles: prod
  datasource:
    url: jdbc:mysql://prod-server:3306/prod_db
    username: prod_user
    password: prod_password

2.3.2 激活 Profile

激活 YAML 文件中的 Profile 与 properties 文件的方式相同，可以通过命令行参数、系统属性或配置文件来指定。

三、使用 Apollo 实现动态配置

3.1 Apollo 简介

Apollo（阿波罗）是携程开源的分布式配置中心，它可以帮助我们实现配置的集中管理和动态更新。Apollo 支持多环境、多集群、多数据中心的配置管理，并且提供了友好的 Web 界面。

3.2 集成 Apollo 到 Spring Boot 项目

3.2.1 添加依赖

在 pom.xml 中添加 Apollo 客户端依赖：

<dependency>
    <groupId>com.ctrip.framework.apollo</groupId>
    <artifactId>apollo-client</artifactId>
    <version>2.0.0</version>
</dependency>

3.2.2 配置 Apollo

在 application.properties 或 application.yml 中配置 Apollo 的相关信息：

app.id=myapp
apollo.meta=http://apollo-config-server:8080

3.2.3 创建 Apollo 配置

在 Apollo 的 Web 界面中创建配置项，例如创建一个名为 datasource.url 的配置项，并分别为不同的环境设置不同的值。

3.2.4 在代码中使用 Apollo 配置

使用 @Value 注解注入 Apollo 配置项：

import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;

@Component
public class MyConfig {
    @Value("${datasource.url}")
    private String datasourceUrl;

    public String getDatasourceUrl() {
        return datasourceUrl;
    }
}

3.3 动态更新配置

Apollo 支持动态更新配置，当配置项发生变化时，应用程序可以自动感知并更新配置。我们可以使用 @ApolloConfigChangeListener 注解来监听配置变化：

import com.ctrip.framework.apollo.model.ConfigChangeEvent;
import com.ctrip.framework.apollo.spring.annotation.ApolloConfigChangeListener;
import org.springframework.stereotype.Component;

@Component
public class MyConfigChangeListener {
    @ApolloConfigChangeListener
    public void onChange(ConfigChangeEvent changeEvent) {
        if (changeEvent.isChanged("datasource.url")) {
            String newUrl = changeEvent.getChange("datasource.url").getNewValue();
            // 更新配置逻辑
            System.out.println("Datasource URL has been updated to: " + newUrl);
        }
    }
}

四、结合 Profile 和 Apollo 实现多环境动态配置

4.1 配置不同环境的 Apollo 元数据

在不同环境的配置文件中配置不同的 Apollo 元数据：

# application-dev.properties
app.id=myapp
apollo.meta=http://dev-apollo-config-server:8080

# application-test.properties
app.id=myapp
apollo.meta=http://test-apollo-config-server:8080

# application-prod.properties
app.id=myapp
apollo.meta=http://prod-apollo-config-server:8080

4.2 动态切换环境

通过激活不同的 Profile，我们可以动态切换应用程序所使用的 Apollo 配置中心地址，从而实现多环境的动态配置。

五、总结

本文详细介绍了 Spring Boot 中使用 Profile、YAML 以及 Apollo 实现多环境配置的方法。通过 Profile 和 YAML 文件，我们可以方便地管理不同环境的静态配置；而 Apollo 则提供了动态配置的能力，使得我们可以在不重启应用程序的情况下更新配置。结合使用这些技术，我们可以更加灵活地应对不同环境的配置需求。