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 并不支持把连接地址的 hostdatabase 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 个配置文件即可管理所有的配置。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,657评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,662评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 158,143评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,732评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,837评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,036评论 1 291
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,126评论 3 410
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,868评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,315评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,641评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,773评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,470评论 4 333
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,126评论 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,859评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,095评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,584评论 2 362
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,676评论 2 351

推荐阅读更多精彩内容