配置基礎
Spring Boot的默認配置文件位置爲: src/main/resources/application.properties
。
關於Spring Boot應用的配置內容都可以集中在該文件中了,根據我們引入的不同Starter模塊,可以在這裏定義諸如:容器端口名、數據庫鏈接信息、日誌級別等各種配置信息。比如,我們需要自定義web模塊的服務端口號,可以在application.properties
中添加server.port=8888
來指定服務端口爲8888。
Spring Boot的配置文件除了可以使用傳統的properties文件之外,還支持現在被廣泛推薦使用的YAML文件。
YAML採用的配置格式不像properties的配置那樣以單純的鍵值對形式來表示,而是以類似大綱的縮進形式來表示。比如:下面的一段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的配置方式,我們可以看到配置信息利用階梯化縮進的方式,其結構顯得更爲清晰易讀,同時配置內容的字符量也得到顯著的減少。除此之外,YAML還可以在一個單個文件中通過使用spring.profiles
屬性來定義多個不同的環境配置。例如下面的內容,在指定爲test環境時,server.port
將使用8882端口;而在prod環境,server.port
將使用8883端口;如果沒有指定環境,server.port
將使用8881端口。
server:
port: 8881
---
spring:
profiles: test
server:
port: 8882
---
spring:
profiles: prod
server:
port: 8883
注意:YAML目前還有一些不足,它無法通過@PropertySource
註解來加載配置。但是,YAML加載屬性到內存中保存的時候是有序的,所以當配置文件中的信息需要具備順序含義時,YAML的配置方式比起properties配置文件更有優勢。
自定義參數
我們除了可以在Spring Boot的配置文件中設置各個Starter模塊中預定義的配置屬性,也可以在配置文件中定義一些我們需要的自定義屬性。比如在application.properties
中添加:
book.name=SpringCloudInAction
book.author=ZhaiYongchao
然後,在應用中我們可以通過@Value
註解來加載這些自定義的參數,比如:
@Component
public class Book {
@Value("${book.name}")
private String name;
@Value("${book.author}")
private String author;
// 省略getter和setter
}
@Value
註解加載屬性值的時候可以支持兩種表達式來進行配置:
- 一種是我們上面介紹的PlaceHolder方式,格式爲
${...}
,大括號內爲PlaceHolder - 另外還可以使用SpEL表達式(Spring Expression Language), 格式爲
#{...}
,大括號內爲SpEL表達式
參數引用
在application.properties
中的各個參數之間,我們也可以直接通過使用PlaceHolder的方式來進行引用,就像下面的設置:
book.name=SpringCloud
book.author=ZhaiYongchao
book.desc=${book.author} is writing《${book.name}》
book.desc
參數引用了上文中定義的book.name
和book.author
屬性,最後該屬性的值就是ZhaiYongchao is writing《SpringCloud》
。
使用隨機數
在一些特殊情況下,有些參數我們希望它每次加載的時候不是一個固定的值,比如:密鑰、服務端口等。在Spring Boot的屬性配置文件中,我們可以通過使用${random}
配置來產生隨機的int值、long值或者string字符串,這樣我們就可以容易的通過配置來屬性的隨機生成,而不是在程序中通過編碼來實現這些邏輯。
${random}
的配置方式主要有一下幾種,讀者可作爲參考使用。
# 隨機字符串
com.didispace.blog.value=${random.value}
# 隨機int
com.didispace.blog.number=${random.int}
# 隨機long
com.didispace.blog.bignumber=${random.long}
# 10以內的隨機數
com.didispace.blog.test1=${random.int(10)}
# 10-20的隨機數
com.didispace.blog.test2=${random.int[10,20]}
該配置方式可以用於設置應用端口等場景,避免在本地調試時出現端口衝突的麻煩.
命令行參數
在命令行方式啓動Spring Boot應用時,連續的兩個減號--
就是對application.properties
中的屬性值進行賦值的標識。所以,java -jar xxx.jar --server.port=8888
命令,等價於我們在application.properties
中添加屬性server.port=8888
。
通過命令行來修改屬性值是Spring Boot非常重要的一個特性,通過此特性,理論上已經使得我們應用的屬性在啓動前是可變的,所以其中端口號也好、數據庫連接也好,都是可以在應用啓動時發生改變,而不同於以往的Spring應用通過Maven的Profile在編譯器進行不同環境的構建。其最大的區別就是,Spring Boot的這種方式,可以讓應用程序的打包內容,貫穿開發、測試以及線上部署,而Maven不同Profile的方案每個環境所構建的包,其內容本質上是不同的。但是,如果每個參數都需要通過命令行來指定,這顯然也不是一個好的方案,所以下面我們看看如果在Spring Boot中實現多環境的配置。
多環境配置
我們在開發任何應用的時候,通常同一套程序會被應用和安裝到幾個不同的環境,比如:開發、測試、生產等。其中每個環境的數據庫地址、服務器端口等等配置都會不同,如果在爲不同環境打包時都要頻繁修改配置文件的話,那必將是個非常繁瑣且容易發生錯誤的事。
對於多環境的配置,各種項目構建工具或是框架的基本思路是一致的,通過配置多份不同環境的配置文件,再通過打包命令指定需要打包的內容之後進行區分打包,Spring Boot也不例外,或者說更加簡單。
在Spring Boot中多環境配置文件名需要滿足application-{profile}.properties
的格式,其中{profile}
對應你的環境標識,比如:
application-dev.properties
:開發環境application-test.properties
:測試環境application-prod.properties
:生產環境
至於哪個具體的配置文件會被加載,需要在application.properties
文件中通過spring.profiles.active
屬性來設置,其值對應配置文件中的{profile}
值。如:spring.profiles.active=test
就會加載application-test.properties
配置文件內容。
下面,以不同環境配置不同的服務端口爲例,進行樣例實驗。
-
針對各環境新建不同的配置文件
application-dev.properties
、application-test.properties
、application-prod.properties
-
在這三個文件均都設置不同的
server.port
屬性,如:dev環境設置爲1111,test環境設置爲2222,prod環境設置爲3333 -
application.properties中設置
spring.profiles.active=dev
,就是說默認以dev環境設置 - 測試不同配置的加載
- 執行
java -jar xxx.jar
,可以觀察到服務端口被設置爲1111
,也就是默認的開發環境(dev) - 執行
java -jar xxx.jar --spring.profiles.active=test
,可以觀察到服務端口被設置爲2222
,也就是測試環境的配置(test) -
執行
java -jar xxx.jar --spring.profiles.active=prod
,可以觀察到服務端口被設置爲3333
,也就是生產環境的配置(prod)
按照上面的實驗,可以如下總結多環境的配置思路:
application.properties
中配置通用內容,並設置spring.profiles.active=dev
,以開發環境爲默認配置application-{profile}.properties
中配置各個環境不同的內容- 通過命令行方式去激活不同環境的配置
加載順序
在上面的例子中,我們將Spring Boot應用需要的配置內容都放在了項目工程中,雖然我們已經能夠通過spring.profiles.active
或是通過Maven來實現多環境的支持。但是,當我們的團隊逐漸壯大,分工越來越細緻之後,往往我們不需要讓開發人員知道測試或是生成環境的細節,而是希望由每個環境各自的負責人(QA或是運維)來集中維護這些信息。那麼如果還是以這樣的方式存儲配置內容,對於不同環境配置的修改就不得不去獲取工程內容來修改這些配置內容,當應用非常多的時候就變得非常不方便。同時,配置內容都對開發人員可見,本身這也是一種安全隱患。對此,現在出現了很多將配置內容外部化的框架和工具,後續將要介紹的Spring Cloud Config就是其中之一,爲了後續能更好的理解Spring Cloud Config的加載機制,我們需要對Spring Boot對數據文件的加載機制有一定的瞭解。
Spring Boot爲了能夠更合理的重寫各屬性的值,使用了下面這種較爲特別的屬性加載順序:
- 命令行中傳入的參數。
SPRING_APPLICATION_JSON
中的屬性。SPRING_APPLICATION_JSON
是以JSON格式配置在系統環境變量中的內容。java:comp/env
中的JNDI
屬性。- Java的系統屬性,可以通過
System.getProperties()
獲得的內容。 - 操作系統的環境變量
- 通過
random.*
配置的隨機屬性 - 位於當前應用jar包之外,針對不同
{profile}
環境的配置文件內容,例如:application-{profile}.properties
或是YAML
定義的配置文件 - 位於當前應用jar包之內,針對不同
{profile}
環境的配置文件內容,例如:application-{profile}.properties
或是YAML
定義的配置文件 - 位於當前應用jar包之外的
application.properties
和YAML
配置內容 - 位於當前應用jar包之內的
application.properties
和YAML
配置內容 - 在
@Configuration
註解修改的類中,通過@PropertySource
註解定義的屬性 - 應用默認屬性,使用
SpringApplication.setDefaultProperties
定義的內容
優先級按上面的順序有高到低,數字越小優先級越高。
可以看到,其中第7項和第9項都是從應用jar包之外讀取配置文件,所以,實現外部化配置的原理就是從此切入,爲其指定外部配置文件的加載位置來取代jar包之內的配置內容。通過這樣的實現,我們的工程在配置中就變的非常乾淨,我們只需要在本地放置開發需要的配置即可,而其他環境的配置就可以不用關心,由其對應環境的負責人去維護即可。
2.x 新特性
在Spring Boot 2.0中推出了Relaxed Binding 2.0,對原有的屬性綁定功能做了非常多的改進以幫助我們更容易的在Spring應用中加載和讀取配置信息。下面本文就來說說Spring Boot 2.0中對配置的改進。
配置文件綁定
簡單類型
在Spring Boot 2.0中對配置屬性加載的時候會除了像1.x版本時候那樣移除特殊字符外,還會將配置均以全小寫的方式進行匹配和加載。所以,下面的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類型的配置必須是連續的,不然會拋出UnboundConfigurationPropertiesException
異常,所以如下配置是不允許的:
foo[0]=a
foo[2]=b
在Spring Boot 1.x中上述配置是可以的,foo[1]
由於沒有配置,它的值會是null
Map類型
Map類型在properties和yaml中的標準配置方式如下:
- properties格式:
spring.my-example.foo=bar
spring.my-example.hello=world
- yaml格式:
spring:
my-example:
foo: bar
hello: world
注意:如果Map類型的key包含非字母數字和-
的字符,需要用[]
括起來,比如:
spring:
my-example:
'[foo.baz]': bar
全新的綁定API
在Spring Boot 2.0中增加了新的綁定API來幫助我們更容易的獲取配置信息。下面舉個例子來幫助大家更容易的理解:
例子一:簡單類型
假設在propertes配置中有這樣一個配置:com.didispace.foo=bar
我們爲它創建對應的配置類:
@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類型
如果配置內容是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!
要獲取這些配置依然很簡單,可以這樣實現:
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);