Spring Boot - 自定義屬性及多環(huán)境配置

很多人選擇Spring Boot就是因?yàn)閽仐壛艘酝爆嵉腦ML配置噪矛,我們只需要在pom.xml文件中引入不同的模塊医清,比如spring-boot-starter-web起暮、spring-boot-starter-redis、spring-boot-starter-data-mongodb等会烙,這些模塊一般都已經(jīng)有自己默認(rèn)的配置负懦,我們只需要在appication.properties中完成一些屬性的配置就可以使用各模塊了。

我們通常會(huì)在appication.properties中針對(duì)數(shù)據(jù)庫(kù)連接柏腻、服務(wù)器參數(shù)等進(jìn)行配置纸厉,與此同時(shí)我們也可以自定義一些參數(shù)放在這個(gè)文件中供系統(tǒng)使用。

自定義屬性及加載

首先自定義屬性如下

com.bluecoffee.space.author=bluecoffee    
com.bluecoffee.space.title=Spring Boot基礎(chǔ)教程

通過(guò)@Value("${屬性名}")注解來(lái)加載對(duì)應(yīng)的配置屬性,如下所示

    @Value("${com.bluecoffee.space.author}")
    private String blogAuthor;

    @Value("${com.bluecoffee.space.title}")
    private String blogTitle;

通過(guò)單元測(cè)試來(lái)驗(yàn)證一下

@RunWith(SpringJUnit4ClassRunner.class)
@SpringApplicationConfiguration(classes = RestApplication.class)
public class TestProperties {

    @Value("${com.bluecoffee.space.author}")
    private String blogAuthor;

    @Value("${com.bluecoffee.space.title}")
    private String blogTitle;

    private Logger logger = LoggerFactory.getLogger(this.getClass());

    @Test
    public void test1(){
        try{
            Assert.assertEquals("bluecoffee", blogAuthor);
            Assert.assertEquals("Spring Boot基礎(chǔ)教程", blogTitle);
        }catch (Exception ex){
            ex.printStackTrace();
        }
    }
}

使用隨機(jī)數(shù)及自定義配置類(lèi)

有時(shí)候我們需要我們的參數(shù)不是一個(gè)固定值五嫂,而是一個(gè)隨機(jī)數(shù)(比如密鑰)颗品。Spring Boot的屬性配置文件中可以通過(guò)${random}來(lái)產(chǎn)生int值、long值或者String字符串沃缘,來(lái)支持屬性的隨機(jī)值躯枢。

#隨機(jī)字符串
com.bluecoffee.random.str=${random.value}
#隨機(jī)int
com.bluecoffee.random.number=${random.int}
#隨機(jī)long
com.bluecoffee.random.bigNumber=${random.long}
#10以?xún)?nèi)的隨機(jī)數(shù)
com.bluecoffee.random.test1=${random.int(10)}
#10-20的隨機(jī)數(shù)
com.bluecoffee.random.test2=${random.int[20,30]}

在這邊配置中我們發(fā)現(xiàn)有一個(gè)特點(diǎn),所有配置都是以"com.bluecoffee.random"開(kāi)頭的槐臀,我們也可以自定義一個(gè)配置類(lèi)來(lái)進(jìn)行聲明锄蹂,代碼如下

@ConfigurationProperties(prefix = "com.bluecoffee.random")
public class RandomProperties {

    private String str;

    private Integer number;

    private Long bigNumber;

    private Integer test1;

    private Integer test2;

    // getter/setter方法省略
}

在上面一段代碼中用@ConfigurationProperties(prefix = "com.bluecoffee.random")來(lái)約定了讀取以"com.bluecoffe.random"開(kāi)頭的配置項(xiàng),然后我們別忘了在RestApplication.java中使用@ EnableConfigurationProperties來(lái)開(kāi)啟讀取配置文件的功能水慨。

@SpringBootApplication
@EnableConfigurationProperties(RandomProperties.class)
public class RestApplication {

    public static void main(String[] args) throws Exception {
        SpringApplication.run(RestApplication.class, args);
    }
}

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

將Spring Boot應(yīng)用打包后得糜,我們可以使用java -jar xxx.jar --server.port=9001敬扛,通過(guò)使用--server.port屬性來(lái)設(shè)置xxx.jar應(yīng)用的端口為9001。

在命令行運(yùn)行時(shí)朝抖,連續(xù)的兩個(gè)減號(hào)--就是對(duì)application.properties中的屬性值進(jìn)行賦值的標(biāo)識(shí)啥箭。所以,java -jar xxx.jar --server.port=9001命令槽棍,等價(jià)于我們?cè)赼pplication.properties中添加屬性server.port=9001捉蚤,我們可通過(guò)刪除該值或使用命令行來(lái)設(shè)置該值來(lái)驗(yàn)證。

通過(guò)命令行來(lái)修改屬性值固然提供了不錯(cuò)的便利性炼七,但是通過(guò)命令行就能更改應(yīng)用運(yùn)行的參數(shù),有時(shí)候并不安全布持,不用擔(dān)心豌拙,Spring Boot也提供了屏蔽命令行訪(fǎng)問(wèn)屬性的設(shè)置,只需要這句設(shè)置就能屏蔽:

SpringApplication.setAddCommandLineProperties(false)

多環(huán)境配置

我們知道在研發(fā)過(guò)程中题暖,從開(kāi)發(fā)-測(cè)試-上線(xiàn)按傅,至少也有3個(gè)環(huán)境,實(shí)際上僅測(cè)試階段可能還會(huì)有SIT胧卤、UAT階段唯绍,然后每個(gè)環(huán)境的配置都不一樣,比如數(shù)據(jù)庫(kù)配置枝誊、Redis配置况芒、分布式消息組件配置等。如果在打包環(huán)節(jié)來(lái)進(jìn)行修改配置的話(huà)叶撒,非常容易出錯(cuò)绝骚。

對(duì)于多環(huán)境的配置,有非常多的項(xiàng)目構(gòu)建工具祠够,原理基本上都是通過(guò)配置多份不同環(huán)境的配置文件压汪,再通過(guò)打包命令指定需要打包的內(nèi)容之后進(jìn)行區(qū)分打包,Spring Boot同樣也支持古瓤。

在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=prod就會(huì)加載application-prod.properties配置文件內(nèi)容

下面叽奥,以不同環(huán)境配置不同的服務(wù)端口為例扔水,進(jìn)行測(cè)試:

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

  • 在這三個(gè)文件均都設(shè)置不同的server.port屬性魔市,如:dev環(huán)境設(shè)置為1111主届,test環(huán)境設(shè)置為2222,prod環(huán)境設(shè)置為3333

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

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

執(zhí)行java -jar xxx.jar君丁,可以觀(guān)察到服務(wù)端口被設(shè)置為1111,也就是默認(rèn)的開(kāi)發(fā)環(huán)境(dev)
執(zhí)行java -jar xxx.jar --spring.profiles.active=test将宪,可以觀(guān)察到服務(wù)端口被設(shè)置為2222绘闷,也就是測(cè)試環(huán)境的配置(test)
執(zhí)行java -jar xxx.jar --spring.profiles.active=prod,可以觀(guān)察到服務(wù)端口被設(shè)置為3333较坛,也就是生產(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ò)java -jar xxx.jar --spring.profiles.active={}方式去激活不同環(huán)境的配置

完整代碼戳這里: Chapter 2-1-1 - 自定義參數(shù)及多環(huán)境配置

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末华嘹,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子法竞,更是在濱河造成了極大的恐慌耙厚,老刑警劉巖,帶你破解...
    沈念sama閱讀 218,451評(píng)論 6 506
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件岔霸,死亡現(xiàn)場(chǎng)離奇詭異薛躬,居然都是意外死亡,警方通過(guò)查閱死者的電腦和手機(jī)呆细,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,172評(píng)論 3 394
  • 文/潘曉璐 我一進(jìn)店門(mén)型宝,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái),“玉大人侦鹏,你說(shuō)我怎么就攤上這事诡曙。” “怎么了略水?”我有些...
    開(kāi)封第一講書(shū)人閱讀 164,782評(píng)論 0 354
  • 文/不壞的土叔 我叫張陵价卤,是天一觀(guān)的道長(zhǎng)。 經(jīng)常有香客問(wèn)我渊涝,道長(zhǎng)慎璧,這世上最難降的妖魔是什么? 我笑而不...
    開(kāi)封第一講書(shū)人閱讀 58,709評(píng)論 1 294
  • 正文 為了忘掉前任跨释,我火速辦了婚禮胸私,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘鳖谈。我一直安慰自己岁疼,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,733評(píng)論 6 392
  • 文/花漫 我一把揭開(kāi)白布缆娃。 她就那樣靜靜地躺著捷绒,像睡著了一般瑰排。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上暖侨,一...
    開(kāi)封第一講書(shū)人閱讀 51,578評(píng)論 1 305
  • 那天椭住,我揣著相機(jī)與錄音,去河邊找鬼字逗。 笑死京郑,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的葫掉。 我是一名探鬼主播些举,決...
    沈念sama閱讀 40,320評(píng)論 3 418
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼俭厚!你這毒婦竟也來(lái)了金拒?” 一聲冷哼從身側(cè)響起,我...
    開(kāi)封第一講書(shū)人閱讀 39,241評(píng)論 0 276
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤套腹,失蹤者是張志新(化名)和其女友劉穎,沒(méi)想到半個(gè)月后资铡,有當(dāng)?shù)厝嗽跇?shù)林里發(fā)現(xiàn)了一具尸體电禀,經(jīng)...
    沈念sama閱讀 45,686評(píng)論 1 314
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,878評(píng)論 3 336
  • 正文 我和宋清朗相戀三年笤休,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了尖飞。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 39,992評(píng)論 1 348
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡店雅,死狀恐怖政基,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情闹啦,我是刑警寧澤沮明,帶...
    沈念sama閱讀 35,715評(píng)論 5 346
  • 正文 年R本政府宣布,位于F島的核電站窍奋,受9級(jí)特大地震影響荐健,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜琳袄,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,336評(píng)論 3 330
  • 文/蒙蒙 一江场、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧窖逗,春花似錦址否、人聲如沸。這莊子的主人今日做“春日...
    開(kāi)封第一講書(shū)人閱讀 31,912評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)樊诺。三九已至,卻和暖如春帮匾,著一層夾襖步出監(jiān)牢的瞬間啄骇,已是汗流浹背。 一陣腳步聲響...
    開(kāi)封第一講書(shū)人閱讀 33,040評(píng)論 1 270
  • 我被黑心中介騙來(lái)泰國(guó)打工瘟斜, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留缸夹,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 48,173評(píng)論 3 370
  • 正文 我出身青樓螺句,卻偏偏與公主長(zhǎng)得像虽惭,于是被迫代替她去往敵國(guó)和親。 傳聞我的和親對(duì)象是個(gè)殘疾皇子蛇尚,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,947評(píng)論 2 355

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