Spring Boot 利用 YAML 变量引用来简化配置

微服务开发中，我们往往会为每一个服务创建一个独立的数据库；同一个服务在不同的环境中也会连接到不同的数据库实例中。这就导致我们数据源的配置变得非常复杂。

以 Spring Boot + MySQL 为例，我会简单描述一下配置思路，供大家学习交流。

最早期，大多数情况下都会这样配置:

spring.datasource:
  url: jdbc:mysql://127.0.0.1:3306/database1?foo=bar
  username: user
  password: pass

当你的公司正在深度使用微服务开发，有一堆微服务，并且还开了多个开发环境时，这种配置方式需要你维护 m*n 个配置。

在我们公司的场景中：我们每个服务拥有一个独立的数据库，但是多个库在一个实例上。不同环境上，同一个服务的数据库名不会变；同一个环境中，数据库的连接地址域名和端口不会变。即：每个环境跑了单独的 mysql 实例，配置了所有的服务数据库，使用一个集中式的 Spring Cloud Config 配置中心，通过 profile 切换不同环境的配置。所有环境的所有服务，配置的 spring.datasource.url 都是不同的，但是又是相似的，有迹可循的。

Spring 的 MySQL JDBC 配置 spring.datasource.url 并不支持把连接地址的 host 和 database name 拆分开啊？没关系，我们可以使用 YAML 配置文件的变量引用。

我们可以通过变通的方式巧妙地把 spring.datasource.url 拆分开，使用如下方式：

spring.datasource:
  url: jdbc:mysql://${spring.datasource.host}/${spring.datasource.database}?${spring.datasource.params}
  username: user
  password: pass

我们在上面代码中定义了几个自定义变量，但是值得注意的是，这几个变量并不是 spring datasource 本身所支持的变量。但是通过这种方式，我们就可以使用 m+n 个配置就可以搞定所有环境啦。

# application.yml 指定所有的服务直接相关的数据库连接地址参数
spring.datasource.url: jdbc:mysql://${spring.datasource.host}/${spring.datasource.database}?${spring.datasource.params}

# m 个环境负责自己的 host
# application-xxxx.yml xxxx开发环境
spring.datasource.host: jdbc:mysql://127.0.0.1:3306
# application-rc.yml  rc环境
spring.datasource.host: jdbc:mysql://127.0.0.1:3307
# application-staging.yml 预发环境
spring.datasource.host: jdbc:mysql://127.0.0.1:3308
# application-production.yml 生产环境（生产环境我推荐还是放在独立的配置中心，这里仅仅举个例子）
spring.datasource.host: jdbc:mysql://127.0.0.1:3309

# n 个服务负责自己的 database
# user service
spring.datasource.database: user
# foo service
spring.datasource.database: foo
# bar service
spring.datasource.database: bar

这样下来，配置中心只需要维护各个服务独立的 xxx-service.yml 和一个对应环境的 application-env.yml 就可以了。原来可能需要几十几百个配置文件，现在直接缩减了一个数量级。增加环境只需要增加 application-env.yml，增加服务只需要增加 xxx-service.yml。

在我们的实际操作中，原先约 30 多个服务，存在 5 个开发环境的情况下，需要至少 150 个配置文件来管理数据库连接地址这个属性，但是经过这样的变更之后，我们只需要 35 个配置文件即可管理所有的配置。