SpringBoot-application.yml多环境配置详解

下面是关于“SpringBoot-application.yml多环境配置详解”的完整攻略。

一、背景

在日常开发中，我们经常需要在不同的环境中部署我们的程序，例如测试环境、预发布环境、生产环境等等。在这些环境中，我们需要配置不同的参数，如数据库连接信息、系统日志级别等等。如果每次部署时都手动修改配置文件，既费时也容易出错。因此，我们需要一种更加自动化和统一的方式来进行多环境配置。

Spring Boot 在多环境配置方面提供了非常便捷和强大的支持。

二、配置文件

在 Spring Boot 中，我们可以使用 application.yml 或 application.properties 这两个文件来进行配置。它们都具有多级配置的特性，可以像树形结构一样管理我们的配置项。其中，application.yml 是以 YAML 格式进行配置，而 application.properties 则采用传统的 key=value 的形式。在本文中，我将以 application.yml 举例。

Spring Boot 在读取配置文件时，会按照一定的规则进行查找，优先级大致如下：

1. 在项目根目录下，application.yml 或 application.properties
2. 在项目根目录下，config/application.yml 或 config/application.properties
3. 在 classpath 下，META-INF/spring 配置文件夹下的 application.yml 或 application.properties
4. 在 jar 包外部用户文件夹中，/etc/spring-boot 或者 ${user.home}/.spring-boot 文件夹下的 application.yml 或 application.properties

其中，1 和 2 都是相对路径，可以直接放置在项目根目录下的根路径或 config 子目录下。

为了实现多环境配置，我们需要在配置文件中加入一个 spring.profiles.active 属性，并将其值设置为当前的环境名称，例如：

spring:
  profiles:
    active: dev

上面的配置表明当前环境为 “dev”（开发环境），注意，这里的 dev 非常灵活，可以是任意字符串，只要能表述我们当前在使用的环境即可。

接下来我们就可以在同一个配置文件中，分别面向不同的环境来进行配置。

三、多环境配置示例

1. 数据库配置

我们可以在配置文件中为不同的环境分别指定不同的数据库连接信息，例如：

spring:
  profiles:
    active: dev

---

spring:
  profiles: test
  datasource:
    url: jdbc:mysql://localhost:3306/myapp_test
    username: testuser
    password: testpass

---

spring:
  profiles: prod
  datasource:
    url: jdbc:mysql://localhost:3306/myapp_prod
    username: produser
    password: prodpass

上面的配置表明：

• 在 dev 环境中，使用默认的 H2 内存数据库。
• 在 test 环境中，使用名为 myapp_test 的 MySQL 数据库，并使用 testuser/testpass 进行登录。
• 在 prod 环境中，使用名为 myapp_prod 的 MySQL 数据库，并使用 produser/prodpass 进行登录。

这样，在使用不同环境时，只需要在启动脚本或命令中设置 spring.profiles.active 的值即可，Spring Boot 会自动加载相应的配置项，从而实现多环境配置。

2. 系统日志配置

我们还可以针对不同的环境，设置不同的日志级别。例如：

spring:
  profiles:
    active: dev

logging:
  level:
    com.example: debug

---

spring:
  profiles: test
  logging:
    level:
      com.example: info

---

spring:
  profiles: prod
  logging:
    level:
      com.example: error

上面的配置表明：

• 在 dev 环境中，将 com.example 包下的日志级别设置为 debug。
• 在 test 环境中，将 com.example 包下的日志级别设置为 info。
• 在 prod 环境中，将 com.example 包下的日志级别设置为 error。

这样可以方便地根据不同环境需求，灵活地控制日志输出。

四、总结

通过以上两个示例，我们可以看到 Spring Boot 在多环境配置方面的强大支持。通过将不同环境的配置项放在同一个文件中，并使用 spring.profiles.active 属性来指定当前的环境，可以方便地实现多环境配置，从而进一步提高了程序的可移植性和复用性。

编写一个适合自己的多环境配置文件，尤其是结合业务场景、调整日志级别等，是一个非常值得推敲和细心的过程。