深入理解Spring Boot屬性配置文件
前言
相信很多人選擇Spring Boot主要是考慮到它既能兼顧Spring的強(qiáng)大功能,還能實(shí)現(xiàn)快速開(kāi)發(fā)的便捷。我們?cè)赟pring Boot使用過(guò)程中,最直觀的感受就是沒(méi)有了原來(lái)自己整合Spring應(yīng)用時(shí)繁多的XML配置內(nèi)容,替代它的是在pom.xml
中引入模塊化的Starter POMs
,其中各個(gè)模塊都有自己的默認(rèn)配置,所以如果不是特殊應(yīng)用場(chǎng)景,就只需要在application.properties
中完成一些屬性配置就能開(kāi)啟各模塊的應(yīng)用。
在之前的各篇文章中都有提及關(guān)于application.properties
的使用,主要用來(lái)配置數(shù)據(jù)庫(kù)連接、日志相關(guān)配置等。除了這些配置內(nèi)容之外,本文將具體介紹一些在application.properties
配置中的其他特性和使用方法。
自定義屬性與加載
我們?cè)谑褂肧pring Boot的時(shí)候,通常也需要定義一些自己使用的屬性,我們可以如下方式直接定義:
com.didispace.blog.name=程序猿DD com.didispace.blog.title=Spring Boot教程
然后通過(guò)@Value("${屬性名}")
注解來(lái)加載對(duì)應(yīng)的配置屬性,具體如下:
@Component public class BlogProperties { @Value("${com.didispace.blog.name}") private String name; @Value("${com.didispace.blog.title}") private String title; // 省略getter和setter }
按照慣例,通過(guò)單元測(cè)試來(lái)驗(yàn)證BlogProperties中的屬性是否已經(jīng)根據(jù)配置文件加載了。
@RunWith(SpringJUnit4ClassRunner.class) @SpringApplicationConfiguration(Application.class) public class ApplicationTests { @Autowired private BlogProperties blogProperties; @Test public void getHello() throws Exception { Assert.assertEquals(blogProperties.getName(), "程序猿DD"); Assert.assertEquals(blogProperties.getTitle(), "Spring Boot教程"); } }
參數(shù)間的引用
在application.properties
中的各個(gè)參數(shù)之間也可以直接引用來(lái)使用,就像下面的設(shè)置:
com.didispace.blog.name=程序猿DD com.didispace.blog.title=Spring Boot教程 com.didispace.blog.desc=${com.didispace.blog.name}正在努力寫(xiě)《${com.didispace.blog.title}》
com.didispace.blog.desc
參數(shù)引用了上文中定義的name
和title
屬性,最后該屬性的值就是程序猿DD正在努力寫(xiě)《Spring Boot教程》
。
使用隨機(jī)數(shù)
在一些情況下,有些參數(shù)我們需要希望它不是一個(gè)固定的值,比如密鑰、服務(wù)端口等。Spring Boot的屬性配置文件中可以通過(guò)${random}
來(lái)產(chǎn)生int值、long值或者string字符串,來(lái)支持屬性的隨機(jī)值。
# 隨機(jī)字符串 com.didispace.blog.value=${random.value} # 隨機(jī)int com.didispace.blog.number=${random.int} # 隨機(jī)long com.didispace.blog.bignumber=${random.long} # 10以內(nèi)的隨機(jī)數(shù) com.didispace.blog.test1=${random.int(10)} # 10-20的隨機(jī)數(shù) com.didispace.blog.test2=${random.int[10,20]}
通過(guò)命令行設(shè)置屬性值
相信使用過(guò)一段時(shí)間Spring Boot的用戶,一定知道這條命令: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è)?code>application.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)境配置
我們?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í)都要頻繁修改配置文件的話,那必將是個(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)境配置文件名需要滿足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è)置為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
,可以觀察到服務(wù)端口被設(shè)置為1111,也就是默認(rèn)的開(kāi)發(fā)環(huán)境(dev)
執(zhí)行java -jar xxx.jar --spring.profiles.active=test
,可以觀察到服務(wù)端口被設(shè)置為2222,也就是測(cè)試環(huán)境的配置(test)
執(zhí)行java -jar xxx.jar --spring.profiles.active=prod
,可以觀察到服務(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ò)命令行方式去激活不同環(huán)境的配置
示例代碼:chapter2-1-1
總結(jié)
以上就是這篇文章的全部?jī)?nèi)容了,希望本文的內(nèi)容對(duì)大家的學(xué)習(xí)或者工作能帶來(lái)一定的幫助,如果有疑問(wèn)大家可以留言交流。
相關(guān)文章
深入理解Java虛擬機(jī) JVM 內(nèi)存結(jié)構(gòu)
本節(jié)將會(huì)介紹一下JVM的內(nèi)存結(jié)構(gòu),JVM運(yùn)行時(shí)數(shù)據(jù)區(qū)的各個(gè)組成部分:堆,方法區(qū),程序計(jì)數(shù)器,Java虛擬機(jī)棧,本地方法棧,還會(huì)對(duì)Java堆的分代劃分做個(gè)簡(jiǎn)單的介紹2021-09-09SpringBoot配置logback.xml 多環(huán)境的操作步驟
最近在研究springboot的日志,所以記錄一下,做一下總結(jié),今天重點(diǎn)給大家介紹SpringBoot配置logback.xml 多環(huán)境的操作步驟,要實(shí)現(xiàn)多環(huán)境的配置,主要是依賴于springboot的application.yml文件去實(shí)現(xiàn),感興趣的朋友跟隨小編一起看看吧2021-05-05Springboot+Spring Security實(shí)現(xiàn)前后端分離登錄認(rèn)證及權(quán)限控制的示例代碼
本文主要介紹了Springboot+Spring Security實(shí)現(xiàn)前后端分離登錄認(rèn)證及權(quán)限控制的示例代碼,文中通過(guò)示例代碼介紹的非常詳細(xì),具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2021-11-11Spring Boot中的@ConfigurationProperties注解解讀
在SpringBoot框架中,@ConfigurationProperties注解是處理外部配置的強(qiáng)大工具,它允許開(kāi)發(fā)者將配置文件中的屬性自動(dòng)映射到Java類的字段上,實(shí)現(xiàn)配置的集中管理和類型安全,通過(guò)定義配置類并指定前綴,可以將配置文件中的屬性綁定到Java對(duì)象2024-10-10java HashMap內(nèi)部實(shí)現(xiàn)原理詳解
這篇文章主要介紹了java HashMap內(nèi)部實(shí)現(xiàn)原理詳解的相關(guān)資料,需要的朋友可以參考下2017-02-02springboot實(shí)現(xiàn)用戶名查找用戶功能
本文主要介紹了springboot實(shí)現(xiàn)用戶名查找用戶功能,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2023-04-04Spring + mybatis + mysql使用事物的幾種方法總結(jié)
這篇文章主要給大家總結(jié)介紹了關(guān)于Spring + mybatis + mysql使用事物的幾種方法,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2018-05-05JAVA設(shè)計(jì)模式之備忘錄模式原理與用法詳解
這篇文章主要介紹了JAVA設(shè)計(jì)模式之備忘錄模式,簡(jiǎn)單說(shuō)明了備忘錄模式的概念、原理并結(jié)合實(shí)例形式分析了java備忘錄模式的具體定義及使用方法,需要的朋友可以參考下2017-08-08