Spring Boot 多個(gè)環(huán)境的配置方式
大家好,我是風(fēng)箏
這是一篇寫給新手的文章,老手可以繞行了。
起因是一個(gè)同學(xué)讓我?guī)退磦€(gè)問題,他說有兩個(gè)環(huán)境,一個(gè)環(huán)境有問題,另一個(gè)環(huán)境沒問題,但是一直找不到原因,假設(shè)一個(gè)環(huán)境是 dev,另一個(gè)環(huán)境是 test。
于是,我遠(yuǎn)程了他的機(jī)器,想分別看下兩個(gè)環(huán)境的現(xiàn)象,結(jié)果發(fā)現(xiàn)沒有地方可以配置環(huán)境。我問他是怎么切換環(huán)境的,他說要連另外一個(gè)環(huán)境就把 application.yml 中的配置改了,之后切換回來的時(shí)候再改回來。
我當(dāng)時(shí)直接就無語(yǔ)住了。后來想想他還沒畢業(yè),不知道也正常,我剛學(xué) Spring Boot 的時(shí)候連多個(gè)環(huán)境都不知道,也是后來正式加入工作團(tuán)隊(duì)后才學(xué)來的。
我們平時(shí)做項(xiàng)目的時(shí)候,一般都會(huì)分幾套環(huán)境,開發(fā)環(huán)境、測(cè)試環(huán)境、預(yù)發(fā)布環(huán)境以及生產(chǎn)環(huán)境。每一套環(huán)境的配置都是不一樣的,比如數(shù)據(jù)庫(kù)連接串不一樣、redis不一樣,還有其他一些配置很可能都不一樣。
那這時(shí)候,我們切換環(huán)境的時(shí)候就不能像前面說的那樣手動(dòng)改配置文件的內(nèi)容了,那樣既傻又費(fèi)事。
有兩種區(qū)分多個(gè)環(huán)境的方式可以使用。
多個(gè)配置文件
當(dāng)配置Spring Boot應(yīng)用程序的多個(gè)環(huán)境時(shí),使用多配置文件的方式,通常會(huì)使用以下約定:application-{profile}.yml,其中{profile}是配置文件的名稱。在這些配置文件中,你可以根據(jù)不同的環(huán)境指定不同的屬性值。
例如 application-dev.yml 表示開發(fā)環(huán)境, application-test.yml 表示測(cè)試環(huán)境,application-prod.yml 表示生產(chǎn)環(huán)境,還有一個(gè) application.yml表示通用的公共配置。
圖片
通用配置文件 application.yml
和環(huán)境無關(guān)的配置都可以放在這里,例如啟動(dòng)端口號(hào)、服務(wù)名稱以及其他共用屬性等。
還可以在通用配置中設(shè)置 spring.profiles.active來控制啟動(dòng)配置,比如配置成 dev,那就是用 application-dev.yml的配置。
server:
port: 9000
spring:
application:
name: fengzheng
profiles:
# 環(huán)境配置
active: dev
common:
key: 公共 key
各環(huán)境配置
除了通用配置外, 其他幾個(gè)配置文件就是配置與各自環(huán)境有關(guān)的配置了,比如開發(fā)環(huán)境和測(cè)試環(huán)境使用不用的數(shù)據(jù)庫(kù)服務(wù)器,不同的redis集群,這就要在各自的配置中區(qū)分開來。
dev 環(huán)境配置文件 application-dev.yml:
dev-property: dev-value
dev-another-property: dev-another-value
# Dev 環(huán)境的數(shù)據(jù)庫(kù)配置
spring:
datasource:
url: jdbc:mysql://localhost:3306/devdb
username: devuser
password: devpassword
test 環(huán)境配置文件 application-test.yml:
test-property: test-value
test-another-property: test-another-value
# Test 環(huán)境的數(shù)據(jù)庫(kù)配置
spring:
datasource:
url: jdbc:mysql://localhost:3306/testdb
username: testuser
password: testpassword
prod 環(huán)境配置文件 application-prod.yml:
prod-property: prod-value
prod-another-property: prod-another-value
# Prod 環(huán)境的數(shù)據(jù)庫(kù)配置
spring:
datasource:
url: jdbc:mysql://production-db-url:3306/proddb
username: produser
password: prodpassword
指定環(huán)境啟動(dòng)
之后在啟動(dòng)項(xiàng)目的時(shí)候,就可以通過-Dspring.profiles.active來指定使用的配置文件,也就是指定的環(huán)境了。
java -jar myapp.jar -Dspring.profiles.active=dev
例如上面的命令,將激活 application-dev.yml 中的配置。
在 IDEA 中,通過 "Run/Debug Configurations",在 VM options 中加入相應(yīng)的配置啟動(dòng),可以直接連接到對(duì)應(yīng)的環(huán)境。
圖片
或者找到 Active profiles ,直接在后面填寫對(duì)應(yīng)的配置名稱也可以。
圖片
在一個(gè)配置文件中配置多個(gè)環(huán)境
除了使用多個(gè)配置文件,用后綴區(qū)分外,還可以直接在一個(gè)配置文件中配置多個(gè)環(huán)境。
例如下面的配置,把公共配置寫在最前面,然后之后每一個(gè)環(huán)境的配置用 ---區(qū)分,spring.profiles來指定當(dāng)前段落代表的配置。
spring:
application:
name: fengzheng
---
spring:
profiles: dev
datasource:
url: jdbc:mysql://production-db-url:3306/dev-db
username: produser
password: prodpassword
server:
port: 1990
---
spring:
profiles: test
datasource:
url: jdbc:mysql://production-db-url:3306/test-db
username: produser
password: prodpassword
server:
port: 1991
---
spring:
profiles: prod
datasource:
url: jdbc:mysql://production-db-url:3306/prod-db
username: produser
password: prodpassword
server:
port: 1992
之后啟動(dòng)項(xiàng)目的時(shí)候,和前面多個(gè)配置文件的方式一樣。
通過-Dspring.profiles.active來指定使用的配置文件,也就是指定的環(huán)境了。
java -jar myapp.jar -Dspring.profiles.active=dev
例如上面的命令,將激活 application-dev.yml 中的配置。
在 IDEA 中,通過 "Run/Debug Configurations",在 VM options 中加入相應(yīng)的配置啟動(dòng),可以直接連接到對(duì)應(yīng)的環(huán)境。
圖片
或者找到 Active profiles ,直接在后面填寫對(duì)應(yīng)的配置名稱也可以。