Spring Boot 配置檔案中的花樣

在快速入門一節中，我們輕松的實作了一個簡單的RESTful API應用，體驗了一下Spring Boot給我們帶來的諸多優點，我們用非常少的代碼量就成功的實作了一個Web應用，這是傳統的Spring應用無法辦到的，雖然我們在實作Controller時用到的代碼是一樣的，但是在配置方面，相信大家也注意到了，在上面的例子中，除了Maven的配置之後，就沒有引入任何的配置。

這就是之前我們所提到的，Spring Boot針對我們常用的開發場景提供了一系列自動化配置來減少原本複雜而又幾乎很少改動的模闆化配置内容。但是，我們還是需要去了解如何在Spring Boot中修改這些自動化的配置内容，以應對一些特殊的場景需求，比如：我們在同一台主機上需要啟動多個基于Spring Boot的web應用，若我們不為每個應用指定特别的端口号，那麼預設的8080端口必将導緻沖突。

如果您還有在讀我的Spring Cloud系列教程，其實有大量的工作都會是針對配置檔案的。是以我們有必要深入的了解一些關于Spring Boot中的配置檔案的知識，比如：它的配置方式、如何實作多環境配置，配置資訊的加載順序等。

配置基礎

在快速入門示例中，我們介紹Spring Boot的工程結構時，有提到過

src/main/resources

目錄是Spring Boot的配置目錄，是以我們要為應用建立配置個性化配置時，就是在該目錄之下。

Spring Boot的預設配置檔案位置為：

src/main/resources/application.properties

。關于Spring Boot應用的配置内容都可以集中在該檔案中了，根據我們引入的不同Starter子產品，可以在這裡定義諸如：容器端口名、資料庫連結資訊、日志級别等各種配置資訊。比如，我們需要自定義web子產品的服務端口号，可以在

application.properties

中添加

server.port=8888

來指定服務端口為8888，也可以通過

spring.application.name=hello

來指定應用名（該名字在Spring Cloud應用中會被注冊為服務名）。

Spring Boot的配置檔案除了可以使用傳統的properties檔案之外，還支援現在被廣泛推薦使用的YAML檔案。

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

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應用，其中提到了使用指令

java -jar

指令來啟動的方式。該指令除了啟動應用之外，還可以在指令行中來指定應用的參數，比如：

java -jar xxx.jar --server.port=8888

，直接以指令行的方式，來設定server.port屬性，另啟動應用的端口設為8888。

在指令行方式啟動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中的标準配置方式如下：

spring.my-example.foo=bar
spring.my-example.hello=world

spring:
  my-example:
    foo: bar
    hello: world

注意：如果Map類型的key包含非字母數字和

的字元，需要用

[]

括起來，比如：

spring:
  my-example:
    '[foo.baz]': bar

環境屬性綁定

在環境變量中通過小寫轉換與

替換

來映射配置檔案中的内容，比如：環境變量

SPRING_JPA_DATABASEPLATFORM=mysql

的配置會産生與在配置檔案中設定

spring.jpa.databaseplatform=mysql

一樣的效果。

由于環境變量中無法使用

符号，是以使用

來替代。任何由下劃線包圍的數字都會被認為是

[]

的數組形式。比如：

MY_FOO_1_ = my.foo[1]
MY_FOO_1_BAR = my.foo[1].bar
MY_FOO_1_2_ = my.foo[1][2]

另外，最後環境變量最後是以數字和下劃線結尾的話，最後的下劃線可以省略，比如上面例子中的第一條和第三條等價于下面的配置：

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

系統屬性綁定

系統屬性與檔案配置中的類似，都以移除特殊字元并轉化小寫後實作綁定，比如下面的指令行參數都會實作配置

spring.jpa.databaseplatform=mysql

的效果：

-Dspring.jpa.database-platform=mysql
-Dspring.jpa.databasePlatform=mysql
-Dspring.JPA.database_platform=mysql

系統屬性的綁定也與檔案屬性的綁定類似，通過

[]

來标示，比如：

-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中對屬性綁定的内容，可以看到對于一個屬性我們可以有多種不同的表達，但是如果我們要在Spring應用程式的environment中讀取屬性的時候，每個屬性的唯一名稱符合如下規則：

. 分離各個元素
最後一個 . 将字首與屬性名稱分開
必須是字母（a-z）和數字(0-9)
必須是小寫字母
用連字元 - 來分隔單詞
唯一允許的其他字元是 [ ] ，用于List的索引
不能以數字開頭

是以，如果我們要讀取配置檔案中

spring.jpa.database-platform

的配置，可以這樣寫：

this.environment.containsProperty("spring.jpa.database-platform")

而下面的方式是無法擷取到

spring.jpa.database-platform

配置内容的：

this.environment.containsProperty("spring.jpa.databasePlatform")

注意：使用

@Value

擷取配置内容的時候也需要這樣的特點

全新的綁定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);

代碼示例

本教程配套倉庫：

Github：https://github.com/dyc87112/SpringBoot-Learning/tree/2.x
Gitee：https://gitee.com/didispace/SpringBoot-Learning/tree/2.x

Spring Boot 配置檔案中的花樣

配置基礎

自定義參數

參數引用

使用随機數

指令行參數

多環境配置

加載順序

2.x 新特性

配置檔案綁定

簡單類型

List類型

Map類型

環境屬性綁定

系統屬性綁定

屬性的讀取

全新的綁定API

代碼示例

繼續閱讀

Spring資料和Redis

redis叢集資料一緻性_RedisRaft為Redis叢集帶來強大的資料一緻性

寶塔面闆mysql恢複2018.1.8更新

SpringMVC的啟動過程源碼分析1 SpringMVC 配置XML的方式啟動2 SpringMVC純注解模式啟動

Java Spring 架構

Centos7 MySQL 5.7 安裝MySQL 5.7 安裝

查找入職員工時間排名倒數第三的員工所有資訊

Hibernate使用Hibernate的“3個準備，7個步驟”Hibernate API簡介操作實體對象對象識别

雲計算面試題——mysql/存儲引擎/備份

SQL語言基礎：常用的資料查詢語句

debian9更新4.9.0核心到4.19.2核心過程

SpringCloud微服務（四）之ribbon筆記ribbon是什麼？入門案例自定義均衡負載算法

Ubuntu16.04安裝Apache+MySQL+PHP1. 安裝Apache2. 安裝MySQL3. 安裝PHP4. 安裝phpMyAdmin

MySQL的4種隔離級别？出現問題

neo4j之cypher使用文檔

mysql使用source指令導入.sql檔案