配置spring.profiles.active的靈活使用

背景

很多時(shí)候荣倾,我們項(xiàng)目在開(kāi)發(fā)環(huán)境和生成環(huán)境的環(huán)境配置是不一樣的,例如骑丸,數(shù)據(jù)庫(kù)配置舌仍,在開(kāi)發(fā)的時(shí)候,我們一般用測(cè)試數(shù)據(jù)庫(kù)通危,而在生產(chǎn)環(huán)境的時(shí)候铸豁,我們是用正式的數(shù)據(jù),這時(shí)候菊碟,我們可以利用profile在不同的環(huán)境下配置用不同的配置文件或者不同的配置节芥。

spring boot 提供

spring boot允許你通過(guò)命名約定按照一定的格式(application-{profile}.properties)來(lái)定義多個(gè)配置文件,然后通過(guò)在application.properyies通過(guò)spring.profiles.active來(lái)具體激活一個(gè)或者多個(gè)配置文件逆害,如果沒(méi)有沒(méi)有指定任何profile的配置文件的話(huà)头镊,spring boot默認(rèn)會(huì)啟動(dòng)application-default.properties。

profile的配置文件可以按照application.properyies的放置位置一樣魄幕,放于以下四個(gè)位置:

當(dāng)前目錄的 “/config”的子目錄下

當(dāng)前目錄下

classpath根目錄的“/config”包下

classpath的根目錄下

demo 演示

在這里我們就定義倆個(gè)profile文件相艇,

application-sit.properties和application-prd.properties,

并在倆個(gè)文件中都分別

寫(xiě)上變量

我們?cè)赼pplication.properyies也寫(xiě)上纯陨,并把profile切換到application-sit.properties的配置文件

我們?cè)赼pplication.properyies也寫(xiě)上坛芽,并把profile切換到application-sit.properties的配置文件

#修改tomcat的默認(rèn)的端口號(hào),將8080改為8889

server.port=8889

#啟用shutdown endpoint的HTTP訪問(wèn)

endpoints.shutdown.enabled=true

#不需要用戶(hù)名密碼驗(yàn)證

endpoints.shutdown.sensitive=false

#默認(rèn)curvar值

curvar=default.curvar

#切換配置文件

spring.profiles.active=sit

可以通過(guò)這樣子來(lái)測(cè)試

package HelloWord;

import org.springframework.beans.factory.annotation.Value;

import org.springframework.web.bind.annotation.RequestMapping;

import org.springframework.web.bind.annotation.RestController;

@RestController

@RequestMapping("/task")

public class TaskController {

? ? @RequestMapping(value = {"/",""})

? ? public String hellTask(@Value("${curvar}")String cusvar ){

? ? ? ? return "hello task !! my current variable is " + cusvar;

? ? }

}


分別定義倆個(gè)實(shí)現(xiàn)類(lèi)來(lái)實(shí)現(xiàn)它

package config;

import org.springframework.context.annotation.Profile;

import org.springframework.stereotype.Component;

/**

* 測(cè)試數(shù)據(jù)庫(kù)

*/

@Component

@Profile("sitdb")

public class SitDBConnector implements DBConnector {

? ? @Override

? ? public void configure() {

? ? ? ? System.out.println("sit-db");

? ? }

}

package config;

import org.springframework.context.annotation.Profile;

import org.springframework.stereotype.Component;

/**

* 生產(chǎn)數(shù)據(jù)庫(kù)

*/

@Component

@Profile("prddb")

public class PrdDBConnector implements DBConnector {

? ? @Override

? ? public void configure() {

? ? ? ? System.out.println("prd-db");

? ? }

}

通過(guò)在配置文件激活具體使用哪個(gè)實(shí)現(xiàn)類(lèi)

#修改tomcat的默認(rèn)的端口號(hào)翼抠,將8080改為8889

server.port=8889

#啟用shutdown endpoint的HTTP訪問(wèn)

endpoints.shutdown.enabled=true

#不需要用戶(hù)名密碼驗(yàn)證

endpoints.shutdown.sensitive=false

#默認(rèn)curvar值

curvar=default.curvar

#切換配置文件

#修改tomcat的默認(rèn)的端口號(hào)靡馁,將8080改為8889

server.port=8889

#啟用shutdown endpoint的HTTP訪問(wèn)

endpoints.shutdown.enabled=true

#不需要用戶(hù)名密碼驗(yàn)證

endpoints.shutdown.sensitive=false

#默認(rèn)curvar值

curvar=default.curvar

#切換配置文件

spring.profiles.active=sitdb

然后就可以這么使用

package HelloWord;

import config.DBConnector;

import org.springframework.beans.factory.annotation.Autowired;

import org.springframework.beans.factory.annotation.Value;

import org.springframework.context.annotation.ComponentScan;

import org.springframework.web.bind.annotation.RequestMapping;

? ? ? ? import org.springframework.web.bind.annotation.RestController;

@RestController

@RequestMapping("/task")

@ComponentScan(basePackages={"config"})

public class TaskController {

? ? @Autowired DBConnector connector;

? ? @RequestMapping(value = {"/",""})

? ? public String hellTask(@Value("${curvar}")String cusvar ){

? ? ? ? connector.configure();//最終打印配置的db

? ? ? ? return "hello task !! my current variable is " + cusvar;

? ? }

}




以上就是spring boot用profile的作用。

以下為可選(主要是命令行使用):

通過(guò)命令行設(shè)置屬性值

相信使用過(guò)一段時(shí)間Spring Boot的用戶(hù)机久,一定知道這條命令:java -jar xxx.jar --server.port=8888臭墨,通過(guò)使用–server.port屬性來(lái)設(shè)置xxx.jar應(yīng)用的端口為8888。

在命令行運(yùn)行時(shí)膘盖,連續(xù)的兩個(gè)減號(hào)–就是對(duì)application.properties中的屬性值進(jìn)行賦值的標(biāo)識(shí)胧弛。所以尤误,java -jar xxx.jar --server.port=8888命令,等價(jià)于我們?cè)赼pplication.properties中添加屬性server.port=8888结缚,該設(shè)置在樣例工程中可見(jiàn)损晤,讀者可通過(guò)刪除該值或使用命令行來(lái)設(shè)置該值來(lái)驗(yàn)證。

通過(guò)命令行來(lái)修改屬性值固然提供了不錯(cuò)的便利性红竭,但是通過(guò)命令行就能更改應(yīng)用運(yùn)行的參數(shù)尤勋,那豈不是很不安全?是的茵宪,所以Spring Boot也貼心的提供了屏蔽命令行訪問(wèn)屬性的設(shè)置最冰,只需要這句設(shè)置就能屏蔽:SpringApplication.setAddCommandLineProperties(false)。

多環(huán)境配置

以上都不是重點(diǎn)稀火,這才是重點(diǎn)暖哨,這才是重點(diǎn),這才是重點(diǎn)凰狞,重要的事情說(shuō)3遍篇裁。我們?cè)陂_(kāi)發(fā)Spring Boot應(yīng)用時(shí),通常同一套程序會(huì)被應(yīng)用和安裝到幾個(gè)不同的環(huán)境赡若,比如:開(kāi)發(fā)达布、測(cè)試、生產(chǎn)等逾冬。其中每個(gè)環(huán)境的數(shù)據(jù)庫(kù)地址往枣、服務(wù)器端口等等配置都會(huì)不同,如果在為不同環(huán)境打包時(shí)都要頻繁修改配置文件的話(huà)粉渠,那必將是個(gè)非常繁瑣且容易發(fā)生錯(cuò)誤的事分冈。

對(duì)于多環(huán)境的配置,各種項(xiàng)目構(gòu)建工具或是框架的基本思路是一致的霸株,通過(guò)配置多份不同環(huán)境的配置文件雕沉,再通過(guò)打包命令指定需要打包的內(nèi)容之后進(jìn)行區(qū)分打包,Spring Boot也不例外去件,或者說(shuō)更加簡(jiǎn)單坡椒。

在Spring Boot中多環(huán)境配置文件名需要滿(mǎn)足application-{profile}.properties的格式,其中{profile}對(duì)應(yīng)你的環(huán)境標(biāo)識(shí)尤溜,比如:

application-dev.properties:開(kāi)發(fā)環(huán)境

application-test.properties:測(cè)試環(huán)境

application-prod.properties:生產(chǎn)環(huán)境

至于哪個(gè)具體的配置文件會(huì)被加載倔叼,需要在application.properties文件中通過(guò)spring.profiles.active屬性來(lái)設(shè)置,其值對(duì)應(yīng){profile}值宫莱。

如:spring.profiles.active=test就會(huì)加載application-test.properties配置文件內(nèi)容

下面丈攒,以不同環(huán)境配置不同的服務(wù)端口為例,進(jìn)行樣例實(shí)驗(yàn)。

針對(duì)各環(huán)境新建不同的配置文件application-dev.properties巡验、application-test.properties际插、application-prod.properties

在這三個(gè)文件均都設(shè)置不同的server.port屬性,如:dev環(huán)境設(shè)置為8080显设,test環(huán)境設(shè)置為9090框弛,prod環(huán)境設(shè)置為80

application.properties中設(shè)置spring.profiles.active=dev,就是說(shuō)默認(rèn)以dev環(huán)境設(shè)置

測(cè)試不同配置的加載:

執(zhí)行java -jar xxx.jar捕捂,可以觀察到服務(wù)端口被設(shè)置為8080瑟枫,也就是默認(rèn)的開(kāi)發(fā)環(huán)境(dev)

執(zhí)行java -jar xxx.jar --spring.profiles.active=test,可以觀察到服務(wù)端口被設(shè)置為9090指攒,也就是測(cè)試環(huán)境的配置(test)

執(zhí)行java -jar xxx.jar --spring.profiles.active=prod慷妙,可以觀察到服務(wù)端口被設(shè)置為80,也就是生產(chǎn)環(huán)境的配置(prod)

按照上面的實(shí)驗(yàn)幽七,可以如下總結(jié)多環(huán)境的配置思路:

application.properties中配置通用內(nèi)容,并設(shè)置spring.profiles.active=dev溅呢,以開(kāi)發(fā)環(huán)境為默認(rèn)配置

application-{profile}.properties中配置各個(gè)環(huán)境不同的內(nèi)容

通過(guò)命令行方式去激活不同環(huán)境的配置澡屡。

多環(huán)境高級(jí)應(yīng)用

在某些情況下,應(yīng)用的某些業(yè)務(wù)邏輯可能需要有不同的實(shí)現(xiàn)咐旧。例如郵件服務(wù)驶鹉,假設(shè)EmailService中包含的send(String email)方法向指定地址發(fā)送電子郵件,但是我們僅僅希望在生產(chǎn)環(huán)境中才執(zhí)行真正發(fā)送郵件的代碼铣墨,而開(kāi)發(fā)環(huán)境里則不發(fā)送以免向用戶(hù)發(fā)送無(wú)意義的垃圾郵件室埋。

我們可以借助Spring的注解@Profile實(shí)現(xiàn)這樣的功能,這樣需要定義兩個(gè)實(shí)現(xiàn)EmailService借口的類(lèi):

/**

* 發(fā)送郵件接口.

*/

public interface EmailService {

? ? /**發(fā)送郵件*/

? ? publicvoid send();

}

發(fā)送郵件的具體實(shí)現(xiàn)(dev-開(kāi)發(fā)環(huán)境的代碼):

@Service

@Profile("dev") //開(kāi)發(fā)環(huán)境的時(shí)候.

public class DevEmailServiceImpl implements EmailService{

? ? @Override

? ? publicvoid send() {

? ? ? System.out.println("DevEmailServiceImpl.send().開(kāi)發(fā)環(huán)境不執(zhí)行郵件的發(fā)送.");

? ? }

}

發(fā)送郵件的具體實(shí)現(xiàn)(prod-生產(chǎn)環(huán)境的代碼):

@Service

@Profile("prod") //生產(chǎn)環(huán)境.

public class ProdEmailServiceImpl2 implements EmailService{


? ? @Override

? ? publicvoid send() {

? ? ? System.out.println("DevEmailServiceImpl.send().生產(chǎn)環(huán)境執(zhí)行郵件的發(fā)送.");

? ? ? //具體的郵件發(fā)送代碼.

? ? ? //mail.send();

? ? }

}

Profile(“dev”)表明只有Spring定義的Profile為dev時(shí)才會(huì)實(shí)例化DevEmailService這個(gè)類(lèi)伊约。那么如何設(shè)置Profile呢姚淆?

在application.properties中加入:

spring.profiles.active=dev

通過(guò)命令行參數(shù)

java -jar app.jar --spring.profiles.active=dev

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市屡律,隨后出現(xiàn)的幾起案子腌逢,更是在濱河造成了極大的恐慌,老刑警劉巖超埋,帶你破解...
    沈念sama閱讀 211,194評(píng)論 6 490
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件搏讶,死亡現(xiàn)場(chǎng)離奇詭異,居然都是意外死亡霍殴,警方通過(guò)查閱死者的電腦和手機(jī)媒惕,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 90,058評(píng)論 2 385
  • 文/潘曉璐 我一進(jìn)店門(mén),熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái)来庭,“玉大人妒蔚,你說(shuō)我怎么就攤上這事。” “怎么了面睛?”我有些...
    開(kāi)封第一講書(shū)人閱讀 156,780評(píng)論 0 346
  • 文/不壞的土叔 我叫張陵絮蒿,是天一觀的道長(zhǎng)。 經(jīng)常有香客問(wèn)我叁鉴,道長(zhǎng)土涝,這世上最難降的妖魔是什么? 我笑而不...
    開(kāi)封第一講書(shū)人閱讀 56,388評(píng)論 1 283
  • 正文 為了忘掉前任幌墓,我火速辦了婚禮但壮,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘常侣。我一直安慰自己蜡饵,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 65,430評(píng)論 5 384
  • 文/花漫 我一把揭開(kāi)白布胳施。 她就那樣靜靜地躺著溯祸,像睡著了一般。 火紅的嫁衣襯著肌膚如雪舞肆。 梳的紋絲不亂的頭發(fā)上焦辅,一...
    開(kāi)封第一講書(shū)人閱讀 49,764評(píng)論 1 290
  • 那天,我揣著相機(jī)與錄音椿胯,去河邊找鬼筷登。 笑死,一個(gè)胖子當(dāng)著我的面吹牛哩盲,可吹牛的內(nèi)容都是我干的前方。 我是一名探鬼主播,決...
    沈念sama閱讀 38,907評(píng)論 3 406
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼廉油,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼惠险!你這毒婦竟也來(lái)了?” 一聲冷哼從身側(cè)響起抒线,我...
    開(kāi)封第一講書(shū)人閱讀 37,679評(píng)論 0 266
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤莺匠,失蹤者是張志新(化名)和其女友劉穎,沒(méi)想到半個(gè)月后十兢,有當(dāng)?shù)厝嗽跇?shù)林里發(fā)現(xiàn)了一具尸體趣竣,經(jīng)...
    沈念sama閱讀 44,122評(píng)論 1 303
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 36,459評(píng)論 2 325
  • 正文 我和宋清朗相戀三年旱物,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了遥缕。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 38,605評(píng)論 1 340
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡宵呛,死狀恐怖单匣,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤户秤,帶...
    沈念sama閱讀 34,270評(píng)論 4 329
  • 正文 年R本政府宣布码秉,位于F島的核電站,受9級(jí)特大地震影響鸡号,放射性物質(zhì)發(fā)生泄漏转砖。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 39,867評(píng)論 3 312
  • 文/蒙蒙 一鲸伴、第九天 我趴在偏房一處隱蔽的房頂上張望府蔗。 院中可真熱鬧,春花似錦汞窗、人聲如沸姓赤。這莊子的主人今日做“春日...
    開(kāi)封第一講書(shū)人閱讀 30,734評(píng)論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)不铆。三九已至,卻和暖如春裹唆,著一層夾襖步出監(jiān)牢的瞬間誓斥,已是汗流浹背。 一陣腳步聲響...
    開(kāi)封第一講書(shū)人閱讀 31,961評(píng)論 1 265
  • 我被黑心中介騙來(lái)泰國(guó)打工品腹, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留岖食,地道東北人红碑。 一個(gè)月前我還...
    沈念sama閱讀 46,297評(píng)論 2 360
  • 正文 我出身青樓舞吭,卻偏偏與公主長(zhǎng)得像,于是被迫代替她去往敵國(guó)和親析珊。 傳聞我的和親對(duì)象是個(gè)殘疾皇子羡鸥,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 43,472評(píng)論 2 348

推薦閱讀更多精彩內(nèi)容