摘要：的默認(rèn)配置文件位置為。比如，我們需要自定義模塊的服務(wù)端口號(hào)，可以在中添加來指定服務(wù)端口為，也可以通過來指定應(yīng)用名該名字在應(yīng)用中會(huì)被注冊為服務(wù)名。同時(shí)，配置內(nèi)容都對(duì)開發(fā)人員可見，本身這也是一種安全隱患。

在快速入門一節(jié)中，我們輕松的實(shí)現(xiàn)了一個(gè)簡單的RESTful API應(yīng)用，體驗(yàn)了一下Spring Boot給我們帶來的諸多優(yōu)點(diǎn)，我們用非常少的代碼量就成功的實(shí)現(xiàn)了一個(gè)Web應(yīng)用，這是傳統(tǒng)的Spring應(yīng)用無法辦到的，雖然我們在實(shí)現(xiàn)Controller時(shí)用到的代碼是一樣的，但是在配置方面，相信大家也注意到了，在上面的例子中，除了Maven的配置之后，就沒有引入任何的配置。

這就是之前我們所提到的，Spring Boot針對(duì)我們常用的開發(fā)場景提供了一系列自動(dòng)化配置來減少原本復(fù)雜而又幾乎很少改動(dòng)的模板化配置內(nèi)容。但是，我們還是需要去了解如何在Spring Boot中修改這些自動(dòng)化的配置內(nèi)容，以應(yīng)對(duì)一些特殊的場景需求，比如：我們在同一臺(tái)主機(jī)上需要啟動(dòng)多個(gè)基于Spring Boot的web應(yīng)用，若我們不為每個(gè)應(yīng)用指定特別的端口號(hào)，那么默認(rèn)的8080端口必將導(dǎo)致沖突。

如果您還有在讀我的Spring Cloud系列教程，其實(shí)有大量的工作都會(huì)是針對(duì)配置文件的。所以我們有必要深入的了解一些關(guān)于Spring Boot中的配置文件的知識(shí)，比如：它的配置方式、如何實(shí)現(xiàn)多環(huán)境配置，配置信息的加載順序等。

在快速入門示例中，我們介紹Spring Boot的工程結(jié)構(gòu)時(shí)，有提到過 src/main/resources目錄是Spring Boot的配置目錄，所以我們要為應(yīng)用創(chuàng)建配置個(gè)性化配置時(shí)，就是在該目錄之下。

Spring Boot的默認(rèn)配置文件位置為： src/main/resources/application.properties。關(guān)于Spring Boot應(yīng)用的配置內(nèi)容都可以集中在該文件中了，根據(jù)我們引入的不同Starter模塊，可以在這里定義諸如：容器端口名、數(shù)據(jù)庫鏈接信息、日志級(jí)別等各種配置信息。比如，我們需要自定義web模塊的服務(wù)端口號(hào)，可以在application.properties中添加server.port=8888來指定服務(wù)端口為8888，也可以通過spring.application.name=hello來指定應(yīng)用名（該名字在Spring Cloud應(yīng)用中會(huì)被注冊為服務(wù)名）。

Spring Boot的配置文件除了可以使用傳統(tǒng)的properties文件之外，還支持現(xiàn)在被廣泛推薦使用的YAML文件。

YAML（英語發(fā)音：/?j?m?l/，尾音類似camel駱駝）是一個(gè)可讀性高，用來表達(dá)資料序列的格式。YAML參考了其他多種語言，包括：C語言、Python、Perl，并從XML、電子郵件的數(shù)據(jù)格式（RFC 2822）中獲得靈感。Clark Evans在2001年首次發(fā)表了這種語言，另外Ingy d?t Net與Oren Ben-Kiki也是這語言的共同設(shè)計(jì)者。目前已經(jīng)有數(shù)種編程語言或腳本語言支援（或者說解析）這種語言。YAML是"YAML Ain"t a Markup Language"（YAML不是一種標(biāo)記語言）的遞回縮寫。在開發(fā)的這種語言時(shí)，YAML 的意思其實(shí)是："Yet Another Markup Language"（仍是一種標(biāo)記語言），但為了強(qiáng)調(diào)這種語言以數(shù)據(jù)做為中心，而不是以標(biāo)記語言為重點(diǎn)，而用反向縮略語重新命名。AML的語法和其他高階語言類似，并且可以簡單表達(dá)清單、散列表，標(biāo)量等資料形態(tài)。它使用空白符號(hào)縮排和大量依賴外觀的特色，特別適合用來表達(dá)或編輯數(shù)據(jù)結(jié)構(gòu)、各種設(shè)定檔、傾印除錯(cuò)內(nèi)容、文件大綱（例如：許多電子郵件標(biāo)題格式和YAML非常接近）。盡管它比較適合用來表達(dá)階層式（hierarchical model）的數(shù)據(jù)結(jié)構(gòu)，不過也有精致的語法可以表示關(guān)聯(lián)性（relational model）的資料。由于YAML使用空白字元和分行來分隔資料，使得它特別適合用grep／Python／Perl／Ruby操作。其讓人最容易上手的特色是巧妙避開各種封閉符號(hào)，如：引號(hào)、各種括號(hào)等，這些符號(hào)在巢狀結(jié)構(gòu)時(shí)會(huì)變得復(fù)雜而難以辨認(rèn)。    —— 維基百科

YAML采用的配置格式不像properties的配置那樣以單純的鍵值對(duì)形式來表示，而是以類似大綱的縮進(jìn)形式來表示。比如：下面的一段YAML配置信息

environments:
    dev:
        url: http://dev.bar.com
        name: Developer Setup
    prod:
        url: http://foo.bar.com
        name: My Cool App

與其等價(jià)的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)顯得更為清晰易讀，同時(shí)配置內(nèi)容的字符量也得到顯著的減少。除此之外，YAML還可以在一個(gè)單個(gè)文件中通過使用spring.profiles屬性來定義多個(gè)不同的環(huán)境配置。例如下面的內(nèi)容，在指定為test環(huán)境時(shí)，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)存中保存的時(shí)候是有序的，所以當(dāng)配置文件中的信息需要具備順序含義時(shí)，YAML的配置方式比起properties配置文件更有優(yōu)勢。

我們除了可以在Spring Boot的配置文件中設(shè)置各個(gè)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注解加載屬性值的時(shí)候可以支持兩種表達(dá)式來進(jìn)行配置：

一種是我們上面介紹的PlaceHolder方式，格式為?${...}?，大括號(hào)內(nèi)為PlaceHolder

另外還可以使用SpEL表達(dá)式（Spring Expression Language），?格式為?#{...}?，大括號(hào)內(nèi)為SpEL表達(dá)式

在application.properties中的各個(gè)參數(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í)候不是一個(gè)固定的值，比如：密鑰、服務(wù)端口等。在Spring Boot的屬性配置文件中，我們可以通過使用${random}配置來產(chǎn)生隨機(jī)的int值、long值或者string字符串，這樣我們就可以容易的通過配置來屬性的隨機(jī)生成，而不是在程序中通過編碼來實(shí)現(xiàn)這些邏輯。

${random}的配置方式主要有一下幾種，讀者可作為參考使用。

# 隨機(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]}

該配置方式可以用于設(shè)置應(yīng)用端口等場景，避免在本地調(diào)試時(shí)出現(xiàn)端口沖突的麻煩

回顧一下在本章的快速入門中，我們還介紹了如何啟動(dòng)Spring Boot應(yīng)用，其中提到了使用命令java -jar命令來啟動(dòng)的方式。該命令除了啟動(dòng)應(yīng)用之外，還可以在命令行中來指定應(yīng)用的參數(shù)，比如：java -jar xxx.jar --server.port=8888，直接以命令行的方式，來設(shè)置server.port屬性，另啟動(dòng)應(yīng)用的端口設(shè)為8888。

在命令行方式啟動(dòng)Spring Boot應(yīng)用時(shí)，連續(xù)的兩個(gè)減號(hào)--就是對(duì)application.properties中的屬性值進(jìn)行賦值的標(biāo)識(shí)。所以，java -jar xxx.jar --server.port=8888命令，等價(jià)于我們在application.properties中添加屬性server.port=8888。

通過命令行來修改屬性值是Spring Boot非常重要的一個(gè)特性，通過此特性，理論上已經(jīng)使得我們應(yīng)用的屬性在啟動(dòng)前是可變的，所以其中端口號(hào)也好、數(shù)據(jù)庫連接也好，都是可以在應(yīng)用啟動(dòng)時(shí)發(fā)生改變，而不同于以往的Spring應(yīng)用通過Maven的Profile在編譯器進(jìn)行不同環(huán)境的構(gòu)建。其最大的區(qū)別就是，Spring Boot的這種方式，可以讓應(yīng)用程序的打包內(nèi)容，貫穿開發(fā)、測試以及線上部署，而Maven不同Profile的方案每個(gè)環(huán)境所構(gòu)建的包，其內(nèi)容本質(zhì)上是不同的。但是，如果每個(gè)參數(shù)都需要通過命令行來指定，這顯然也不是一個(gè)好的方案，所以下面我們看看如果在Spring Boot中實(shí)現(xiàn)多環(huán)境的配置。

我們在開發(fā)任何應(yīng)用的時(shí)候，通常同一套程序會(huì)被應(yīng)用和安裝到幾個(gè)不同的環(huán)境，比如：開發(fā)、測試、生產(chǎn)等。其中每個(gè)環(huán)境的數(shù)據(jù)庫地址、服務(wù)器端口等等配置都會(huì)不同，如果在為不同環(huán)境打包時(shí)都要頻繁修改配置文件的話，那必將是個(gè)非常繁瑣且容易發(fā)生錯(cuò)誤的事。

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

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

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

application-test.properties：測試環(huán)境

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

至于哪個(gè)具體的配置文件會(huì)被加載，需要在application.properties文件中通過spring.profiles.active屬性來設(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，就是說默認(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）

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

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

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

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

在上面的例子中，我們將Spring Boot應(yīng)用需要的配置內(nèi)容都放在了項(xiàng)目工程中，雖然我們已經(jīng)能夠通過spring.profiles.active或是通過Maven來實(shí)現(xiàn)多環(huán)境的支持。但是，當(dāng)我們的團(tuán)隊(duì)逐漸壯大，分工越來越細(xì)致之后，往往我們不需要讓開發(fā)人員知道測試或是生成環(huán)境的細(xì)節(jié)，而是希望由每個(gè)環(huán)境各自的負(fù)責(zé)人（QA或是運(yùn)維）來集中維護(hù)這些信息。那么如果還是以這樣的方式存儲(chǔ)配置內(nèi)容，對(duì)于不同環(huán)境配置的修改就不得不去獲取工程內(nèi)容來修改這些配置內(nèi)容，當(dāng)應(yīng)用非常多的時(shí)候就變得非常不方便。同時(shí)，配置內(nèi)容都對(duì)開發(fā)人員可見，本身這也是一種安全隱患。對(duì)此，現(xiàn)在出現(xiàn)了很多將配置內(nèi)容外部化的框架和工具，后續(xù)將要介紹的Spring Cloud Config就是其中之一，為了后續(xù)能更好的理解Spring Cloud Config的加載機(jī)制，我們需要對(duì)Spring Boot對(duì)數(shù)據(jù)文件的加載機(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.*配置的隨機(jī)屬性

位于當(dāng)前應(yīng)用jar包之外，針對(duì)不同{profile}環(huán)境的配置文件內(nèi)容，例如：application-{profile}.properties或是YAML定義的配置文件

位于當(dāng)前應(yīng)用jar包之內(nèi)，針對(duì)不同{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)先級(jí)按上面的順序有高到低，數(shù)字越小優(yōu)先級(jí)越高。

可以看到，其中第7項(xiàng)和第9項(xiàng)都是從應(yīng)用jar包之外讀取配置文件，所以，實(shí)現(xiàn)外部化配置的原理就是從此切入，為其指定外部配置文件的加載位置來取代jar包之內(nèi)的配置內(nèi)容。通過這樣的實(shí)現(xiàn)，我們的工程在配置中就變的非常干凈，我們只需要在本地放置開發(fā)需要的配置即可，而其他環(huán)境的配置就可以不用關(guān)心，由其對(duì)應(yīng)環(huán)境的負(fù)責(zé)人去維護(hù)即可。

在Spring Boot 2.0中推出了Relaxed Binding 2.0，對(duì)原有的屬性綁定功能做了非常多的改進(jìn)以幫助我們更容易的在Spring應(yīng)用中加載和讀取配置信息。下面本文就來說說Spring Boot 2.0中對(duì)配置的改進(jìn)。

在Spring Boot 2.0中對(duì)配置屬性加載的時(shí)候會(huì)除了像1.x版本時(shí)候那樣移除特殊字符外，還會(huì)將配置均以全小寫的方式進(jìn)行匹配和加載。所以，下面的4種配置方式都是等價(jià)的：

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

在properties文件中使用[]來定位列表類型，比如：

spring.my-example.url[0]=http://example.com
spring.my-example.url[1]=http://spring.io

也支持使用逗號(hào)分割的配置方式，上面與下面的配置是等價(jià)的：

spring.my-example.url=http://example.com,http://spring.io

而在yaml文件中使用可以使用如下配置：

spring:
  my-example:
    url:
      - http://example.com
      - http://spring.io

也支持逗號(hào)分割的方式：

spring:
  my-example:
    url: http://example.com, http://spring.io

注意：在Spring Boot 2.0中對(duì)于List類型的配置必須是連續(xù)的，不然會(huì)拋出UnboundConfigurationPropertiesException異常，所以如下配置是不允許的：

foo[0]=a
foo[2]=b

在Spring Boot 1.x中上述配置是可以的，foo[1]由于沒有配置，它的值會(huì)是null

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)境變量中通過小寫轉(zhuǎn)換與.替換_來映射配置文件中的內(nèi)容，比如：環(huán)境變量SPRING_JPA_DATABASEPLATFORM=mysql的配置會(huì)產(chǎn)生與在配置文件中設(shè)置spring.jpa.databaseplatform=mysql一樣的效果。

List類型

由于環(huán)境變量中無法使用[和]符號(hào)，所以使用_來替代。任何由下劃線包圍的數(shù)字都會(huì)被認(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é)尾的話，最后的下劃線可以省略，比如上面例子中的第一條和第三條等價(jià)于下面的配置：

MY_FOO_1 = my.foo[1]
MY_FOO_1_2 = my.foo[1][2]

簡單類型

系統(tǒng)屬性與文件配置中的類似，都以移除特殊字符并轉(zhuǎn)化小寫后實(shí)現(xiàn)綁定，比如下面的命令行參數(shù)都會(huì)實(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"

同樣的，他也支持逗號(hào)分割的方式，比如：

-Dspring.my-example.url=http://example.com,http://spring.io

上文介紹了Spring Boot 2.0中對(duì)屬性綁定的內(nèi)容，可以看到對(duì)于一個(gè)屬性我們可以有多種不同的表達(dá)，但是如果我們要在Spring應(yīng)用程序的environment中讀取屬性的時(shí)候，每個(gè)屬性的唯一名稱符合如下規(guī)則：

通過.分離各個(gè)元素

最后一個(gè).將前綴與屬性名稱分開

必須是字母（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)容的時(shí)候也需要這樣的特點(diǎn)

在Spring Boot 2.0中增加了新的綁定API來幫助我們更容易的獲取配置信息。下面舉個(gè)例子來幫助大家更容易的理解：

例子一：簡單類型

假設(shè)在propertes配置中有這樣一個(gè)配置：com.didispace.foo=bar

我們?yōu)樗鼊?chuàng)建對(duì)應(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!

要獲取這些配置依然很簡單，可以這樣實(shí)現(xiàn)：

ApplicationContext context = SpringApplication.run(Application.class, args);

Binder binder = Binder.get(context.getEnvironment());

// 綁定List配置
List post = binder.bind("com.didispace.post", Bindable.listOf(String.class)).get();
System.out.println(post);

List posts = binder.bind("com.didispace.posts", Bindable.listOf(PostInfo.class)).get();
System.out.println(posts);

本教程配套倉庫：

Github：https://github.com/dyc87112/S...

Gitee：https://gitee.com/didispace/S...

如果您覺得本文不錯(cuò)，歡迎Star、Follow支持！您的關(guān)注是我堅(jiān)持的動(dòng)力！

Spring Boot 1.x：屬性配置文件詳解

Spring Boot 2.0：配置綁定 2.0 全解析