快捷導(dǎo)航

SpringBoot?Profiles?多環(huán)境配置及切換

更新時(shí)間：2021年12月08日 09:27:25 作者：萌貓他爸

大部分情況下，我們開發(fā)的產(chǎn)品應(yīng)用都會(huì)根據(jù)不同的目的，所以需要支持不同的環(huán)境，本文主要介紹了SpringBoot?Profiles?多環(huán)境配置及切換，感興趣的可以了解一下

前言

大部分情況下，我們開發(fā)的產(chǎn)品應(yīng)用都會(huì)根據(jù)不同的目的，支持運(yùn)行在不同的環(huán)境（Profile）下，比如：

開發(fā)環(huán)境（dev）
測(cè)試環(huán)境（test）
預(yù)覽環(huán)境（pre）
生產(chǎn)環(huán)境（prod）

這里的環(huán)境實(shí)際上是一個(gè)統(tǒng)稱，不同的環(huán)境可能代表著

使用的域名、端口、實(shí)例數(shù)目是不同的；
連接的數(shù)據(jù)庫地址、端口、名稱是不同的；
使用的日志輸出格式、級(jí)別、保存時(shí)間是不同的；

以數(shù)據(jù)庫為例，應(yīng)用在開發(fā)環(huán)境下運(yùn)行時(shí)，連接的是開發(fā)環(huán)境對(duì)應(yīng)的數(shù)據(jù)庫；應(yīng)用在生產(chǎn)環(huán)境下運(yùn)行時(shí)，連接的是生產(chǎn)環(huán)境對(duì)應(yīng)的數(shù)據(jù)庫。

我們不是要為不同的運(yùn)行環(huán)境開發(fā)多個(gè)不同的應(yīng)用，而是要使應(yīng)用可以運(yùn)行在多個(gè)不同的環(huán)境中，怎么做到？

通過配置，更準(zhǔn)備地說，是通過配置屬性。配置屬性本質(zhì)就是鍵值對(duì)。

以數(shù)據(jù)庫為例，應(yīng)用連接數(shù)據(jù)庫時(shí)，需要提供如下連接信息：

地址
端口
名稱
用戶名
密碼

這些信息不會(huì) 硬編碼到應(yīng)用代碼中，而是以配置屬性（鍵值對(duì)）的形式存儲(chǔ)到配置文件中；應(yīng)用運(yùn)行時(shí)通過讀取該配置文件中的配置屬性，進(jìn)而完成數(shù)據(jù)庫的連接。

應(yīng)用 = 程序代碼 + 配置文件

這個(gè)配置文件中連接信息指向測(cè)試使用的數(shù)據(jù)庫，我們就說應(yīng)用運(yùn)行在測(cè)試環(huán)境；連接信息指向生產(chǎn)使用的數(shù)據(jù)庫，我們就說應(yīng)用運(yùn)行在生產(chǎn)環(huán)境；應(yīng)用需要使用的其它服務(wù)（如：Redis、Kafka等）也是同樣的原理。

也說是說，我們可以通過為應(yīng)用運(yùn)行時(shí)指定不同的配置文件（不同的配置文件配置著不同的配置屬性），就可以使得應(yīng)用可以運(yùn)行在不同的環(huán)境中。SpringBoot 實(shí)際上也是通過類似的原理實(shí)現(xiàn)多環(huán)境的配置及切換的。

注：配置屬性可能有多種存儲(chǔ)方式，這里僅以配置文件為例。

默認(rèn)環(huán)境配置

多環(huán)境配置及切換并不是每個(gè)應(yīng)用所必須的，SpringBoot 也為我們考慮到了這一點(diǎn)，它提供了默認(rèn)的配置文件和運(yùn)行環(huán)境，即：如果沒有特別指定，SpringBoot 使用默認(rèn)的配置文件，運(yùn)行于默認(rèn)環(huán)境中。

默認(rèn)配置文件

SpringBoot 默認(rèn)配置文件：application.yml，默認(rèn)位于類路徑下。其中，application 代表 SpringBoot 配置文件名稱，yml 代表配置文件格式（后綴）。

默認(rèn)配置文件實(shí)際也可以不提供，或者內(nèi)容為空。這是為什么呢？

SpringBoot 是一個(gè)功能十分豐富的技術(shù)框架，自身內(nèi)置了很多的配置屬性，用以控制 Spring 容器的初始化行為；同時(shí)，SpringBoot 也支持通過外置配置文件的方式引入其它的配置屬性，application.yml 就是會(huì)被 SpringBoot 默認(rèn)加載的外置配置文件之一。

SpringBoot 配置屬性 = 內(nèi)置配置屬性 + 外置配置文件屬性（application.yml）

如果 application.yml 不存在或者內(nèi)容為空，SpringBoot 僅使用內(nèi)置配置屬性初始化容器環(huán)境；如果 application.yml 存在且內(nèi)容不為空，SpringBoot 使用內(nèi)置配置屬性和 application.yml 配置屬性的合集初始化容器環(huán)境。

如果 application.yml 中的配置屬性名稱和內(nèi)置屬性相同，那么這個(gè)配置屬性值最終以 application.yml 中的配置值為準(zhǔn)（覆蓋）。相當(dāng)于，application.yml 的配置文件屬性優(yōu)先級(jí)高于默認(rèn)的內(nèi)置屬性。

注：SpringBoot 也支持 properties 后綴的配置文件格式，本文以 yml 為例。

默認(rèn)運(yùn)行環(huán)境

SpringBoot 默認(rèn)運(yùn)行環(huán)境：default，default 為運(yùn)行環(huán)境名稱。

默認(rèn)運(yùn)行環(huán)境的名稱是哪里來的呢？

如前文所述，SpringBoot 是有內(nèi)置屬性的，默認(rèn)的運(yùn)行環(huán)境名稱即來自于內(nèi)置屬性：

spring.profiles.active=default

也就是說，內(nèi)置配置屬性 spring.profiles.active 指定 SpringBoot 的運(yùn)行環(huán)境名稱為 default，我們可以將其指定為其它值，進(jìn)行改變運(yùn)行環(huán)境名稱。

多環(huán)境配置

因?yàn)?application.yml 配置屬性的優(yōu)先級(jí)高于默認(rèn)的內(nèi)置屬性，我們可以通過在 application.yml 中指定配置屬性 spring.profiles.active 的值為 dev，將 SpringBoot 運(yùn)行環(huán)境的名稱修改為 dev：

application.yml

spring:
  profiles:
    active: dev

僅僅是修改運(yùn)行環(huán)境名稱么？SpringBoot 幫我們做的還有更多，它會(huì)自動(dòng)搜索名稱為 application-dev.yml 的配置文件并加載其中的配置屬性。

配置文件名稱是有固定模式的：

application-{profile}.yml

其中，{profile} 為我們通過配置屬性 spring.profiles.active 指定的運(yùn)行環(huán)境名稱。

也就是說，如果我們指定運(yùn)行環(huán)境名稱為 dev，SpringBoot 會(huì)為我們自動(dòng)搜索加載配置文件名稱為 application-dev.yml 中的配置屬性；如果我們指定運(yùn)行環(huán)境名稱為 test，SpringBoot 會(huì)為我們自動(dòng)搜索加載配置文件名稱為 application-test.yml 中的配置屬性；其它運(yùn)行環(huán)境名稱同理。

SpringBoot 配置屬性 = 內(nèi)置屬性 + application.yml 配置屬性 + application-{profile}.yml 配置屬性

SpringBoot 配置屬性優(yōu)先級(jí)：application-{profile}.yml 配置屬性 > application.yml 配置屬性 > 內(nèi)置屬性

也就是說，我們可以通過指定不同的運(yùn)行環(huán)境名稱，以及相應(yīng)名稱的配置文件，從而實(shí)現(xiàn)多環(huán)境之間的切換。

注：如果找不到相應(yīng)環(huán)境（profile）的配置文件，則會(huì)忽略。

多環(huán)境切換

以開發(fā)環(huán)境（dev）、測(cè)試環(huán)境（test）、預(yù)覽環(huán)境（pre）、生產(chǎn)環(huán)境（prod）為例，我們可以預(yù)先在項(xiàng)目中創(chuàng)建相應(yīng)環(huán)境的配置文件：

application-dev.yml
application-test.yml
application-pre.yml
application-prod.yml

每一個(gè)環(huán)境的配置文件中配置相應(yīng)環(huán)境對(duì)應(yīng)的屬性，如：數(shù)據(jù)庫連接信息等；然后在 application.yml 中通過指定配置屬性 spring.profiles.active 為不同的值實(shí)現(xiàn)多環(huán)境切換，如：

spring:
  profiles:
    active: prod

代表 SpringBoot 的運(yùn)行環(huán)境名稱為 prod，它將會(huì)加載 application-prod.yml 中的配置屬性。

還可以在 SpringBoot 啟動(dòng)時(shí)，通過命令行參數(shù)的方式指定配置屬性：

java -jar myproject.jar --spring.profiles.active=prod

SpringBoot 配置屬性優(yōu)先級(jí)：命令行參數(shù)配置屬性 > application-{profile}.yml 配置屬性 > application.yml 配置屬性 > 內(nèi)置屬性

推薦的方式是通過 application.yml/spring.profiles.active 指定 SpringBoot 應(yīng)用默認(rèn)的運(yùn)行環(huán)境，應(yīng)用啟動(dòng)時(shí)通過命令行參數(shù)指定具體的運(yùn)行環(huán)境；如果啟用啟動(dòng)時(shí)沒有指定，則應(yīng)用使用默認(rèn)的運(yùn)行環(huán)境運(yùn)行。

小結(jié)

SpringBoot 多環(huán)境配置及切換，本質(zhì)就是通過預(yù)先設(shè)定好多個(gè)運(yùn)行環(huán)境名稱及相應(yīng)的配置文件；應(yīng)用啟動(dòng)時(shí)通過指定運(yùn)行環(huán)境名稱，進(jìn)而加載對(duì)應(yīng)名稱的配置文件實(shí)現(xiàn)的。

實(shí)際使用時(shí)，我們還可以充分利用配置屬性加載的優(yōu)先級(jí)合理地規(guī)劃應(yīng)用的配置屬性，比如：

通用配置（與運(yùn)行環(huán)境無關(guān)的）屬性可以放到 application.yml 中；
運(yùn)行環(huán)境（profile）相關(guān)的配置屬性可以放到相應(yīng)的 application-{profile}.yml 中；
啟動(dòng)時(shí)需要臨時(shí)指定的配置屬性可以通過命令行參數(shù)設(shè)置；
2 和 3 中配置屬性也可以放到 application.yml 中一份，作為默認(rèn)配置。

到此這篇關(guān)于SpringBoot Profiles 多環(huán)境配置及切換的文章就介紹到這了,更多相關(guān)SpringBoot Profiles 多環(huán)境內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: