基于 Yaml 文件的多环境配置

Spring Boot 基于 Yaml 文件的多环境配置

在开发实践中，维护多个环境（如开发、测试和生产）已经成为标准操作。Spring Boot 通过其灵活的配置机制，使得在不同环境中管理应用设置变得简单。尤其是使用 YAML 文件进行配置，它提供了一种简洁、易读的方式来定义应用的配置。本文将探讨在 Spring Boot 中使用 YAML 文件进行多环境配置的三种方法。

一、使用不同文件名进行环境配置

Spring Boot 允许你为不同的环境创建具有特定名称的配置文件。例如，你可以有 application.yml 用于默认配置，application-dev.yml 用于开发环境，application-test.yml 用于测试环境，以及 application-prod.yml 用于生产环境。

# application.yml (默认环境)
spring:
  datasource:
    url: ${DB_URL:localhost}

# application-dev.yml (开发环境)
spring:
  profiles:
    active: dev
  datasource:
    url: localhost:3306/db_dev

# application-test.yml (测试环境)
spring:
  profiles:
    active: test
  datasource:
    url: localhost:3306/db_test

# application-prod.yml (生产环境)
spring:
  profiles:
    active: prod
  datasource:
    url: localhost:3306/db_prod

可以通过设置 spring.profiles.active 属性来激活特定的环境配置。例如，如果你想使用开发环境配置，可以在启动应用时添加 -Dspring.profiles.active=dev 参数。

二、使用 YAML 文件内的部分进行环境配置

在单个 YAML 文件中，你可以使用“部分”来区分不同环境的配置。这种方法的好处是所有配置都集中在一个文件中，易于管理。

spring:
  profiles:
    include: common
  # 公共配置
  datasource:
    driver-class-name: com.mysql.cj.jdbc.Driver

# 特定环境配置
---
spring:
  profiles: dev
  datasource:
    url: localhost:3306/db_dev
    username: dev_user
    password: dev_pass

---
spring:
  profiles: test
  datasource:
    url: localhost:3306/db_test
    username: test_user
    password: test_pass

---
spring:
  profiles: prod
  datasource:
    url: localhost:3306/db_prod
    username: prod_user
    password: prod_pass

在这个例子中，common 部分包含了所有环境共享的配置。每个 — 分隔的块代表一个特定的环境配置。

三、使用环境变量进行动态配置

Spring Boot 可以读取环境变量来动态设置配置。你可以在系统环境变量或启动参数中设置 SPRING_CONFIG_NAME 和 SPRING_CONFIG_LOCATION 来指定配置文件的名称和位置。

例如，你可以创建一个 application-override.yml 文件来覆盖其他配置：

# application-override.yml
spring:
  datasource:
    username: override_user
    password: override_pass

然后，通过设置环境变量 SPRING_CONFIG_NAME=application 和 SPRING_CONFIG_LOCATION=/path/to/config，Spring Boot 会加载 application.yml 和指定路径下的配置文件，并使用 application-override.yml 中的配置覆盖它们。

Spring Boot 提供了灵活的配置机制来适应多环境开发的需求。通过使用不同的配置文件、YAML 文件内的部分，以及环境变量，你可以轻松管理和切换不同环境的配置。这些方法不仅提高了开发效率，也使得配置管理变得更加清晰和有序。无论你的项目需要支持多少种环境，Spring Boot 的配置系统都能够提供有效的解决方案。