本篇內(nèi)容主要講解“Spring Boot配置文件的知識點有哪些”,感興趣的朋友不妨來看看。本文介紹的方法操作簡單快捷,實用性強。下面就讓小編來帶大家學(xué)習(xí)“Spring Boot配置文件的知識點有哪些”吧!
目前創(chuàng)新互聯(lián)已為1000多家的企業(yè)提供了網(wǎng)站建設(shè)、域名、雅安服務(wù)器托管、網(wǎng)站托管運營、企業(yè)網(wǎng)站設(shè)計、三門峽網(wǎng)站維護(hù)等服務(wù),公司將堅持客戶導(dǎo)向、應(yīng)用為本的策略,正道將秉承"和諧、參與、激情"的文化,與客戶和合作伙伴齊心協(xié)力一起成長,共同發(fā)展。
配置基礎(chǔ)
Spring Boot的默認(rèn)配置文件位置為: src/main/resources/application.properties。關(guān)于Spring Boot應(yīng)用的配置內(nèi)容都可以集中在該文件中了,根據(jù)我們引入的不同Starter模塊,可以在這里定義諸如:容器端口名、數(shù)據(jù)庫鏈接信息、日志級別等各種配置信息。比如,我們需要自定義web模塊的服務(wù)端口號,可以在application.properties中添加server.port=8888來指定服務(wù)端口為8888,也可以通過spring.application.name=hello來指定應(yīng)用名(該名字在Spring Cloud應(yīng)用中會被注冊為服務(wù)名)。
Spring Boot的配置文件除了可以使用傳統(tǒng)的properties文件之外,還支持現(xiàn)在被廣泛推薦使用的YAML文件。
YAML(英語發(fā)音:/?j?m?l/,尾音類似camel駱駝)是一個可讀性高,用來表達(dá)資料序列的格式。YAML參考了其他多種語言,包括:C語言、Python、Perl,并從XML、電子郵件的數(shù)據(jù)格式(RFC 2822)中獲得靈感。Clark Evans在2001年首次發(fā)表了這種語言,另外Ingy d?t Net與Oren Ben-Kiki也是這語言的共同設(shè)計者。目前已經(jīng)有數(shù)種編程語言或腳本語言支援(或者說解析)這種語言。YAML是"YAML Ain't a Markup Language"(YAML不是一種標(biāo)記語言)的遞回縮寫。在開發(fā)的這種語言時,YAML 的意思其實是:"Yet Another Markup Language"(仍是一種標(biāo)記語言),但為了強調(diào)這種語言以數(shù)據(jù)做為中心,而不是以標(biāo)記語言為重點,而用反向縮略語重新命名。AML的語法和其他高階語言類似,并且可以簡單表達(dá)清單、散列表,標(biāo)量等資料形態(tài)。它使用空白符號縮排和大量依賴外觀的特色,特別適合用來表達(dá)或編輯數(shù)據(jù)結(jié)構(gòu)、各種設(shè)定檔、傾印除錯內(nèi)容、文件大綱(例如:許多電子郵件標(biāo)題格式和YAML非常接近)。盡管它比較適合用來表達(dá)階層式(hierarchical model)的數(shù)據(jù)結(jié)構(gòu),不過也有精致的語法可以表示關(guān)聯(lián)性(relational model)的資料。由于YAML使用空白字元和分行來分隔資料,使得它特別適合用grep/Python/Perl/Ruby操作。其讓人最容易上手的特色是巧妙避開各種封閉符號,如:引號、各種括號等,這些符號在巢狀結(jié)構(gòu)時會變得復(fù)雜而難以辨認(rèn)?!?維基百科
YAML采用的配置格式不像properties的配置那樣以單純的鍵值對形式來表示,而是以類似大綱的縮進(jìn)形式來表示。比如:下面的一段YAML配置信息
environments:
dev:
url: http://dev.bar.com
name: Developer Setup
prod:
url: http://foo.bar.com
name: My Cool App
與其等價的properties配置如下。
environments.dev.url=http://dev.bar.com
environments.dev.name=Developer Setup
environments.prod.url=http://foo.bar.com
environments.prod.name=My Cool App
通過YAML的配置方式,我們可以看到配置信息利用階梯化縮進(jìn)的方式,其結(jié)構(gòu)顯得更為清晰易讀,同時配置內(nèi)容的字符量也得到顯著的減少。除此之外,YAML還可以在一個單個文件中通過使用spring.profiles屬性來定義多個不同的環(huán)境配置。例如下面的內(nèi)容,在指定為test環(huán)境時,server.port將使用8882端口;而在prod環(huán)境,server.port將使用8883端口;如果沒有指定環(huán)境,server.port將使用8881端口。
server:
port: 8881
---
spring:
profiles: test
server:
port: 8882
---
spring:
profiles: prod
server:
port: 8883
注意:YAML目前還有一些不足,它無法通過@PropertySource注解來加載配置。但是,YAML加載屬性到內(nèi)存中保存的時候是有序的,所以當(dāng)配置文件中的信息需要具備順序含義時,YAML的配置方式比起properties配置文件更有優(yōu)勢。
自定義參數(shù)
我們除了可以在Spring Boot的配置文件中設(shè)置各個Starter模塊中預(yù)定義的配置屬性,也可以在配置文件中定義一些我們需要的自定義屬性。比如在application.properties中添加:
book.name=SpringCloudInAction
book.author=ZhaiYongchao
然后,在應(yīng)用中我們可以通過@Value注解來加載這些自定義的參數(shù),比如:
@Component
public class Book {
@Value("${book.name}")
private String name;
@Value("${book.author}")
private String author;
// 省略getter和setter
}
@Value注解加載屬性值的時候可以支持兩種表達(dá)式來進(jìn)行配置:
一種是我們上面介紹的PlaceHolder方式,格式為 ${...} ,大括號內(nèi)為PlaceHolder
另外還可以使用SpEL表達(dá)式(Spring Expression Language), 格式為 #{...} ,大括號內(nèi)為SpEL表達(dá)式
參數(shù)引用
在application.properties中的各個參數(shù)之間,我們也可以直接通過使用PlaceHolder的方式來進(jìn)行引用,就像下面的設(shè)置:
book.name=SpringCloud
book.author=ZhaiYongchao
book.desc=${book.author} is writing《${book.name}》
book.desc參數(shù)引用了上文中定義的book.name和book.author屬性,最后該屬性的值就是ZhaiYongchao is writing《SpringCloud》。
使用隨機數(shù)
在一些特殊情況下,有些參數(shù)我們希望它每次加載的時候不是一個固定的值,比如:密鑰、服務(wù)端口等。在Spring Boot的屬性配置文件中,我們可以通過使用${random}配置來產(chǎn)生隨機的int值、long值或者string字符串,這樣我們就可以容易的通過配置來屬性的隨機生成,而不是在程序中通過編碼來實現(xiàn)這些邏輯。
${random}的配置方式主要有一下幾種,讀者可作為參考使用。
# 隨機字符串
com.didispace.blog.value=${random.value}
# 隨機int
com.didispace.blog.number=${random.int}
# 隨機long
com.didispace.blog.bignumber=${random.long}
# 10以內(nèi)的隨機數(shù)
com.didispace.blog.test1=${random.int(10)}
# 10-20的隨機數(shù)
com.didispace.blog.test2=${random.int[10,20]}
該配置方式可以用于設(shè)置應(yīng)用端口等場景,避免在本地調(diào)試時出現(xiàn)端口沖突的麻煩
命令行參數(shù)
回顧一下在本章的快速入門中,我們還介紹了如何啟動Spring Boot應(yīng)用,其中提到了使用命令java -jar命令來啟動的方式。該命令除了啟動應(yīng)用之外,還可以在命令行中來指定應(yīng)用的參數(shù),比如:java -jar xxx.jar --server.port=8888,直接以命令行的方式,來設(shè)置server.port屬性,另啟動應(yīng)用的端口設(shè)為8888。
在命令行方式啟動Spring Boot應(yīng)用時,連續(xù)的兩個減號--就是對application.properties中的屬性值進(jìn)行賦值的標(biāo)識。所以,java -jar xxx.jar --server.port=8888命令,等價于我們在application.properties中添加屬性server.port=8888。
通過命令行來修改屬性值是Spring Boot非常重要的一個特性,通過此特性,理論上已經(jīng)使得我們應(yīng)用的屬性在啟動前是可變的,所以其中端口號也好、數(shù)據(jù)庫連接也好,都是可以在應(yīng)用啟動時發(fā)生改變,而不同于以往的Spring應(yīng)用通過Maven的Profile在編譯器進(jìn)行不同環(huán)境的構(gòu)建。其最大的區(qū)別就是,Spring Boot的這種方式,可以讓應(yīng)用程序的打包內(nèi)容,貫穿開發(fā)、測試以及線上部署,而Maven不同Profile的方案每個環(huán)境所構(gòu)建的包,其內(nèi)容本質(zhì)上是不同的。但是,如果每個參數(shù)都需要通過命令行來指定,這顯然也不是一個好的方案,所以下面我們看看如果在Spring Boot中實現(xiàn)多環(huán)境的配置。
多環(huán)境配置
我們在開發(fā)任何應(yīng)用的時候,通常同一套程序會被應(yīng)用和安裝到幾個不同的環(huán)境,比如:開發(fā)、測試、生產(chǎn)等。其中每個環(huán)境的數(shù)據(jù)庫地址、服務(wù)器端口等等配置都會不同,如果在為不同環(huán)境打包時都要頻繁修改配置文件的話,那必將是個非常繁瑣且容易發(fā)生錯誤的事。
對于多環(huán)境的配置,各種項目構(gòu)建工具或是框架的基本思路是一致的,通過配置多份不同環(huán)境的配置文件,再通過打包命令指定需要打包的內(nèi)容之后進(jìn)行區(qū)分打包,Spring Boot也不例外,或者說更加簡單。
在Spring Boot中多環(huán)境配置文件名需要滿足application-{profile}.properties的格式,其中{profile}對應(yīng)你的環(huán)境標(biāo)識,比如:
application-dev.properties:開發(fā)環(huán)境
application-test.properties:測試環(huán)境
application-prod.properties:生產(chǎn)環(huán)境
至于哪個具體的配置文件會被加載,需要在application.properties文件中通過spring.profiles.active屬性來設(shè)置,其值對應(yīng)配置文件中的{profile}值。如:spring.profiles.active=test就會加載application-test.properties配置文件內(nèi)容。
下面,以不同環(huán)境配置不同的服務(wù)端口為例,進(jìn)行樣例實驗。
針對各環(huán)境新建不同的配置文件application-dev.properties、application-test.properties、application-prod.properties
在這三個文件均都設(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,就是說默認(rèn)以dev環(huán)境設(shè)置
測試不同配置的加載
執(zhí)行java -jar xxx.jar,可以觀察到服務(wù)端口被設(shè)置為1111,也就是默認(rèn)的開發(fā)環(huán)境(dev)
執(zhí)行java -jar xxx.jar --spring.profiles.active=test,可以觀察到服務(wù)端口被設(shè)置為2222,也就是測試環(huán)境的配置(test)
執(zhí)行java -jar xxx.jar --spring.profiles.active=prod,可以觀察到服務(wù)端口被設(shè)置為3333,也就是生產(chǎn)環(huán)境的配置(prod)
按照上面的實驗,可以如下總結(jié)多環(huán)境的配置思路:
application.properties中配置通用內(nèi)容,并設(shè)置spring.profiles.active=dev,以開發(fā)環(huán)境為默認(rèn)配置
application-{profile}.properties中配置各個環(huán)境不同的內(nèi)容
通過命令行方式去激活不同環(huán)境的配置
加載順序
在上面的例子中,我們將Spring Boot應(yīng)用需要的配置內(nèi)容都放在了項目工程中,雖然我們已經(jīng)能夠通過spring.profiles.active或是通過Maven來實現(xiàn)多環(huán)境的支持。但是,當(dāng)我們的團(tuán)隊逐漸壯大,分工越來越細(xì)致之后,往往我們不需要讓開發(fā)人員知道測試或是生成環(huán)境的細(xì)節(jié),而是希望由每個環(huán)境各自的負(fù)責(zé)人(QA或是運維)來集中維護(hù)這些信息。那么如果還是以這樣的方式存儲配置內(nèi)容,對于不同環(huán)境配置的修改就不得不去獲取工程內(nèi)容來修改這些配置內(nèi)容,當(dāng)應(yīng)用非常多的時候就變得非常不方便。同時,配置內(nèi)容都對開發(fā)人員可見,本身這也是一種安全隱患。對此,現(xiàn)在出現(xiàn)了很多將配置內(nèi)容外部化的框架和工具,后續(xù)將要介紹的Spring Cloud Config就是其中之一,為了后續(xù)能更好的理解Spring Cloud Config的加載機制,我們需要對Spring Boot對數(shù)據(jù)文件的加載機制有一定的了解。
Spring Boot為了能夠更合理的重寫各屬性的值,使用了下面這種較為特別的屬性加載順序:
命令行中傳入的參數(shù)。
SPRING_APPLICATION_JSON中的屬性。SPRING_APPLICATION_JSON是以JSON格式配置在系統(tǒng)環(huán)境變量中的內(nèi)容。
java:comp/env中的JNDI屬性。
Java的系統(tǒng)屬性,可以通過System.getProperties()獲得的內(nèi)容。
操作系統(tǒng)的環(huán)境變量
通過random.*配置的隨機屬性
位于當(dāng)前應(yīng)用jar包之外,針對不同{profile}環(huán)境的配置文件內(nèi)容,例如:application-{profile}.properties或是YAML定義的配置文件
位于當(dāng)前應(yīng)用jar包之內(nèi),針對不同{profile}環(huán)境的配置文件內(nèi)容,例如:application-{profile}.properties或是YAML定義的配置文件
位于當(dāng)前應(yīng)用jar包之外的application.properties和YAML配置內(nèi)容
位于當(dāng)前應(yīng)用jar包之內(nèi)的application.properties和YAML配置內(nèi)容
在@Configuration注解修改的類中,通過@PropertySource注解定義的屬性
應(yīng)用默認(rèn)屬性,使用SpringApplication.setDefaultProperties定義的內(nèi)容
優(yōu)先級按上面的順序有高到低,數(shù)字越小優(yōu)先級越高。
可以看到,其中第7項和第9項都是從應(yīng)用jar包之外讀取配置文件,所以,實現(xiàn)外部化配置的原理就是從此切入,為其指定外部配置文件的加載位置來取代jar包之內(nèi)的配置內(nèi)容。通過這樣的實現(xiàn),我們的工程在配置中就變的非常干凈,我們只需要在本地放置開發(fā)需要的配置即可,而其他環(huán)境的配置就可以不用關(guān)心,由其對應(yīng)環(huán)境的負(fù)責(zé)人去維護(hù)即可。
2.x 新特性
在Spring Boot 2.0中推出了Relaxed Binding 2.0,對原有的屬性綁定功能做了非常多的改進(jìn)以幫助我們更容易的在Spring應(yīng)用中加載和讀取配置信息。下面本文就來說說Spring Boot 2.0中對配置的改進(jìn)。
配置文件綁定
簡單類型
在Spring Boot 2.0中對配置屬性加載的時候會除了像1.x版本時候那樣移除特殊字符外,還會將配置均以全小寫的方式進(jìn)行匹配和加載。所以,下面的4種配置方式都是等價的:
properties格式:
spring.jpa.databaseplatform=MySQL
spring.jpa.database-platform=mysql
spring.jpa.databasePlatform=mysql
spring.JPA.database_platform=mysql
yaml格式:
spring:
jpa:
databaseplatform: mysql
database-platform: mysql
databasePlatform: mysql
database_platform: mysql
Tips:推薦使用全小寫配合-分隔符的方式來配置,比如:spring.jpa.database-platform=mysql
List類型
在properties文件中使用[]來定位列表類型,比如:
spring.my-example.url[0]=http://example.com
spring.my-example.url[1]=http://spring.io
也支持使用逗號分割的配置方式,上面與下面的配置是等價的:
spring.my-example.url=http://example.com,http://spring.io
而在yaml文件中使用可以使用如下配置:
spring:
my-example:
url:
- http://example.com
- http://spring.io
也支持逗號分割的方式:
spring:
my-example:
url: http://example.com, http://spring.io
注意:在Spring Boot 2.0中對于List類型的配置必須是連續(xù)的,不然會拋出UnboundConfigurationPropertiesException異常,所以如下配置是不允許的:
foo[0]=a
foo[2]=b
在Spring Boot 1.x中上述配置是可以的,foo[1]由于沒有配置,它的值會是null
Map類型
Map類型在properties和yaml中的標(biāo)準(zhǔn)配置方式如下:
properties格式:
spring.my-example.foo=bar
spring.my-example.hello=world
yaml格式:
spring:
my-example:
foo: bar
hello: world
注意:如果Map類型的key包含非字母數(shù)字和-的字符,需要用[]括起來,比如:
spring:
my-example:
'[foo.baz]': bar
環(huán)境屬性綁定
簡單類型
在環(huán)境變量中通過小寫轉(zhuǎn)換與.替換_來映射配置文件中的內(nèi)容,比如:環(huán)境變量SPRING_JPA_DATABASEPLATFORM=mysql的配置會產(chǎn)生與在配置文件中設(shè)置spring.jpa.databaseplatform=mysql一樣的效果。
List類型
由于環(huán)境變量中無法使用[和]符號,所以使用_來替代。任何由下劃線包圍的數(shù)字都會被認(rèn)為是[]的數(shù)組形式。比如:
MY_FOO_1_ = my.foo[1]
MY_FOO_1_BAR = my.foo[1].bar
MY_FOO_1_2_ = my.foo[1][2]
另外,最后環(huán)境變量最后是以數(shù)字和下劃線結(jié)尾的話,最后的下劃線可以省略,比如上面例子中的第一條和第三條等價于下面的配置:
MY_FOO_1 = my.foo[1]
MY_FOO_1_2 = my.foo[1][2]
系統(tǒng)屬性綁定
簡單類型
系統(tǒng)屬性與文件配置中的類似,都以移除特殊字符并轉(zhuǎn)化小寫后實現(xiàn)綁定,比如下面的命令行參數(shù)都會實現(xiàn)配置spring.jpa.databaseplatform=mysql的效果:
-Dspring.jpa.database-platform=mysql
-Dspring.jpa.databasePlatform=mysql
-Dspring.JPA.database_platform=mysql
List類型
系統(tǒng)屬性的綁定也與文件屬性的綁定類似,通過[]來標(biāo)示,比如:
-D"spring.my-example.url[0]=http://example.com"
-D"spring.my-example.url[1]=http://spring.io"
同樣的,他也支持逗號分割的方式,比如:
-Dspring.my-example.url=http://example.com,http://spring.io
屬性的讀取
上文介紹了Spring Boot 2.0中對屬性綁定的內(nèi)容,可以看到對于一個屬性我們可以有多種不同的表達(dá),但是如果我們要在Spring應(yīng)用程序的environment中讀取屬性的時候,每個屬性的唯一名稱符合如下規(guī)則:
通過.分離各個元素
最后一個.將前綴與屬性名稱分開
必須是字母(a-z)和數(shù)字(0-9)
必須是小寫字母
用連字符-來分隔單詞
唯一允許的其他字符是[和],用于List的索引
不能以數(shù)字開頭
所以,如果我們要讀取配置文件中spring.jpa.database-platform的配置,可以這樣寫:
this.environment.containsProperty("spring.jpa.database-platform")
而下面的方式是無法獲取到spring.jpa.database-platform配置內(nèi)容的:
this.environment.containsProperty("spring.jpa.databasePlatform")
注意:使用@Value獲取配置內(nèi)容的時候也需要這樣的特點
全新的綁定API
在Spring Boot 2.0中增加了新的綁定API來幫助我們更容易的獲取配置信息。下面舉個例子來幫助大家更容易的理解:
例子一:簡單類型
假設(shè)在propertes配置中有這樣一個配置:com.didispace.foo=bar
我們?yōu)樗鼊?chuàng)建對應(yīng)的配置類:
@Data
@ConfigurationProperties(prefix = "com.didispace")
public class FooProperties {
private String foo;
}
接下來,通過最新的Binder就可以這樣來拿配置信息了:
@SpringBootApplication
public class Application {
public static void main(String[] args) {
ApplicationContext context = SpringApplication.run(Application.class, args);
Binder binder = Binder.get(context.getEnvironment());
// 綁定簡單配置
FooProperties foo = binder.bind("com.didispace", Bindable.of(FooProperties.class)).get();
System.out.println(foo.getFoo());
}
}
例子二:List類型
如果配置內(nèi)容是List類型呢?比如:
com.didispace.post[0]=Why Spring Boot
com.didispace.post[1]=Why Spring Cloud
com.didispace.posts[0].title=Why Spring Boot
com.didispace.posts[0].content=It is perfect!
com.didispace.posts[1].title=Why Spring Cloud
com.didispace.posts[1].content=It is perfect too!
要獲取這些配置依然很簡單,可以這樣實現(xiàn):
ApplicationContext context = SpringApplication.run(Application.class, args);
Binder binder = Binder.get(context.getEnvironment());
// 綁定List配置
List<String> post = binder.bind("com.didispace.post", Bindable.listOf(String.class)).get();
System.out.println(post);
List<PostInfo> posts = binder.bind("com.didispace.posts", Bindable.listOf(PostInfo.class)).get();
System.out.println(posts);
到此,相信大家對“Spring Boot配置文件的知識點有哪些”有了更深的了解,不妨來實際操作一番吧!這里是創(chuàng)新互聯(lián)網(wǎng)站,更多相關(guān)內(nèi)容可以進(jìn)入相關(guān)頻道進(jìn)行查詢,關(guān)注我們,繼續(xù)學(xué)習(xí)!
新聞名稱:SpringBoot配置文件的知識點有哪些
瀏覽地址:http://bm7419.com/article4/pdhioe.html
成都網(wǎng)站建設(shè)公司_創(chuàng)新互聯(lián),為您提供靜態(tài)網(wǎng)站、網(wǎng)站改版、Google、云服務(wù)器、虛擬主機、域名注冊
聲明:本網(wǎng)站發(fā)布的內(nèi)容(圖片、視頻和文字)以用戶投稿、用戶轉(zhuǎn)載內(nèi)容為主,如果涉及侵權(quán)請盡快告知,我們將會在第一時間刪除。文章觀點不代表本網(wǎng)站立場,如需處理請聯(lián)系客服。電話:028-86922220;郵箱:631063699@qq.com。內(nèi)容未經(jīng)允許不得轉(zhuǎn)載,或轉(zhuǎn)載時需注明來源: 創(chuàng)新互聯(lián)