史上最全面的Spring Boot配置檔案詳解

阿新 • • 發佈：2019-02-02

Spring Boot在工作中是用到的越來越廣泛了，簡單方便，有了它，效率提高不知道多少倍。Spring Boot配置檔案對Spring Boot來說就是入門和基礎，經常經常會用到，所以寫下做個總結以便日後檢視。

1.配置檔案

當我們構建完Spring Boot專案後，會在resources目錄下給我們一個預設的全域性配置檔案 application.properties，這是一個空檔案，因為Spring Boot在底層已經把配置都給我們自動配置好了，當在配置檔案進行配置時，會修改SpringBoot自動配置的預設值。

配置檔名是固定的

application.properties

但我們可以修改為

application.yml

這兩個檔案本質是一樣的，區別只是其中的語法略微不同。

2.值的寫法

application.properties 配置檔案比較簡單，形式如下

key = value

application.yml 配置檔案使用YMAL語言，YMAL不是如XML般的標記語言，更適合作為配置檔案。

下面說下對於不同型別（字串、陣列）如何去規範書寫。

2.1 數字，字串，布林

直接寫
```
name=zhangsan
```
雙引號

不會轉義字串裡面的特殊字元，特殊字元會作為本身想表示的意思
```
name: "zhangsan \n lisi"

輸出：

zhangsan

lisi
```
單引號

會轉義特殊字元，特殊字元最終只是一個普通的字串資料
```
name: ‘zhangsan \n lisi’

輸出：

zhangsan \n lisi
```

2.2 物件、Map（屬性和值）（鍵值對）

例如配置類中的欄位為

Map<String,String> maps;

在yml配置檔案中，行內寫法

person.maps: {key1: value1,key2: value2}

需要注意:號後的空格，或者

person:
  maps:
   key: value

在properties配置檔案中

person.maps.key=value

2.3 陣列（List、Set）

在yml

配置檔案中

person:
  list:
   - 1
   - 2
   - 3

行內寫法

person:
  list: [1,2,3]

在properties配置檔案中

person.list[0]=1
person.list[1]=2
person.list[2]=3

3.自定義配置屬性

Spring Boot提供自定義配置元件，拿前面舉例的屬性來寫一個規範的配置檔案

@Component // 或者@Configuration
@ConfigurationProperties(prefix = "person")
public class Person {
    private Map<String,String> maps;
    private List<String> list;
    private String name;

    public Map<String, String> getMaps() {
        return maps;
    }

    public void setMaps(Map<String, String> maps) {
        this.maps = maps;
    }

    public List<String> getList() {
        return list;
    }

    public void setList(List<String> list) {
        this.list = list;
    }
    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }
}

@ConfigurationProperties 註解向Spring Boot宣告該類中的所有屬性和配置檔案中相關的配置進行繫結。

prefix = "person"：宣告配置前戳，將該前戳下的所有屬性進行對映。

@Component 或者@Configuration：將該元件加入Spring Boot容器，只有這個元件是容器中的元件，配置才生效。

4.配置自動提示

在配置自定義屬性時，如果想要獲得和配置Spring Boot屬性自動提示一樣的功能，則需要加入下面的依賴：

<!--匯入配置檔案處理器，配置檔案進行繫結就會有提示-->
<dependency>
   <groupId>org.springframework.boot</groupId>
   <artifactId>spring-boot-configuration-processor</artifactId>
   <optional>true</optional>
</dependency>

若是依舊無法自動提示，可以嘗試開啟IDE的Annonation Processing

5.配置屬性校驗

自定義配置檔案時，可以使用@Validated註解對注入的值進行一些簡單的校驗，示例程式碼

@Validated
@Configuration
@ConfigurationProperties(prefix = "person")
public class Person {
    @Email
    private String mail;

    public String getMail() {
        return mail;
    }

    public void setMail(String mail) {
        this.mail = mail;
    }
}

@Email 註解會對mail欄位的注入值進行檢驗，如果注入的不是一個合法的郵件地址則會丟擲異常。

其它常見註解：

@AssertFalse 校驗false
@AssertTrue 校驗true
@DecimalMax(value=,inclusive=) 小於等於value，inclusive=true，是小於等於
@DecimalMin(value=,inclusive=) 與上類似
@Max(value=) 小於等於value
@Min(value=) 大於等於value
@NotNull 檢查Null
@Past 檢查日期
@Pattern(regex=,flag=) 正則
@Size(min=, max=) 字串，集合，map限制大小
@Validate 對po實體類進行校驗

上述的這些註解位於javax.validation.constraints包下，具體用法檢視註釋即可瞭解。

6.自定義配置檔案

除了在預設的application檔案進行屬性配置，我們也可以自定義配置檔案，例如新建 peoson.properties ，配置內容如下

[email protected]

然後在配置類中使用@PropertySource註解注入該配置檔案

@Configuration
@ConfigurationProperties(prefix = "person")
@PropertySource(value = "classpath:person.properties")
public class Person {
    private String mail;
    
    public String getMail() {
        return mail;
    }

    public void setMail(String mail) {
        this.mail = mail;
    }
}

測試@PropertySource註解不支援注入yml檔案。

擴充套件：

@ImportResource：該註解匯入Spring的xml配置檔案，讓配置檔案裡面的內容生效。

例如：

@ImportResource(locations = {"classpath:beans.xml"})

7.配置檔案佔位符

Spring Boot配置檔案支援佔位符，一些用法如下

7.1 隨機數

${random.value}
${random.int}
${random.long}
${random.int(10)}
${random.int[1024,65536]}

7.2 預設值

佔位符獲取之前配置的值，如果沒有可以是用:指定預設值

person.last-name=張三${random.uuid}
person.age=${random.int}
person.birth=2017/12/15
person.boss=false
person.maps.k1=v1
person.maps.k2=14
person.lists=a,b,c
person.dog.name=${person.hello:hello}_dog
person.dog.age=15

8.多配置檔案

8.1 多Profile檔案

我們在主配置檔案編寫的時候，檔名可以是 application-{profile}.properties/yml

預設使用application.properties的配置

8.2 yml支援多文件塊方式

通過---可以把一個yml文件分割為多個，並可以通過 spring.profiles.active 屬性指定使用哪個配置檔案


server:
  port: 8081
spring:
  profiles:
    active: prod #指定使用哪個環境

---
server:
  port: 8083
spring:
  profiles: dev  #指定屬於哪個環境


---

server:
  port: 8084
spring:
  profiles: prod  #指定屬於哪個環境

8.3 啟用指定profile

無論是使用上述多文件塊的方式，還是新建application-dev.yml檔案，都可以在配置檔案中指定 spring.profiles.active=dev 啟用指定的profile，或者

使用命令列：

java -jar spring-boot-02-config-0.0.1-SNAPSHOT.jar --spring.profiles.active=dev

可以直接在測試的時候，配置傳入命令列引數

虛擬機器引數：
-Dspring.profiles.active=dev

9.配置檔案載入位置

springboot 啟動會掃描以下位置的application.properties或者application.yml檔案作為Spring boot的預設配置檔案

–file:./config/
–file:./
–classpath:/config/
–classpath:/

優先順序由高到底，高優先順序的配置會覆蓋低優先順序的配置；SpringBoot會從這四個位置全部載入主配置檔案。

專案打包好以後，我們可以使用命令列引數的形式，啟動專案的時候來指定配置檔案的新位置；指定配置檔案和預設載入的這些配置檔案共同起作用形成互補配置；

我們還可以通過spring.config.location來改變預設的配置檔案位置，示例：

java -jar spring-boot-demo-0.0.1-SNAPSHOT.jar --spring.config.location=G:/application.properties

10.外部配置載入順序

SpringBoot也可以從以下位置載入配置，優先順序從高到低，高優先順序的配置覆蓋低優先順序的配置，所有的配置會形成互補配置。

1.命令列引數

所有的配置都可以在命令列上進行指定

java -jar spring-boot-02-config-02-0.0.1-SNAPSHOT.jar --server.port=8087  --server.context-path=/abc

多個配置用空格分開，形如 --配置項=值

2.來自java:comp/env的JNDI屬性

3.Java系統屬性（System.getProperties()）

4.作業系統環境變數

5.RandomValuePropertySource配置的random.*屬性值

由jar包外向jar包內進行尋找

優先載入帶{profile}

6.jar包外部的application-{profile}.properties或application.yml(帶spring.profile)配置檔案

7.jar包內部的application-{profile}.properties或application.yml(帶spring.profile)配置檔案

再來載入不帶profile

8.jar包外部的application.properties或application.yml(不帶spring.profile)配置檔案

9.jar包內部的application.properties或application.yml(不帶spring.profile)配置檔案

[email protected]註解類上的@PropertySource

11.通過SpringApplication.setDefaultProperties指定的預設屬性

11.自動配置原理

11.1 自動配置原理

1.SpringBoot啟動的時候載入主配置類，@EnableAutoConfiguration註解開啟了自動配置功能。

[email protected] 作用：

利用EnableAutoConfigurationImportSelector給容器中匯入一些元件
可以檢視selectImports()方法的內容；
List<String> configurations = getCandidateConfigurations(annotationMetadata, attributes);獲取候選的配置

  SpringFactoriesLoader.loadFactoryNames()
  掃描所有jar包類路徑下  META-INF/spring.factories
  把掃描到的這些檔案的內容包裝成properties物件
  從properties中獲取到EnableAutoConfiguration.class類（類名）對應的值，然後把他們新增在容器中

將類路徑下 META-INF/spring.factories 裡面配置的所有EnableAutoConfiguration的值加入到了容器中

每一個這樣的 xxxAutoConfiguration類都是容器中的一個元件，都加入到容器中,用他們來做自動配置。

# Auto Configure
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
org.springframework.boot.autoconfigure.admin.SpringApplicationAdminJmxAutoConfiguration,\
......

3.對每一個自動配置類進行自動配置功能。

4.以HttpEncodingAutoConfiguration（Http編碼自動配置）為例解釋自動配置原理；

@Configuration   //表示這是一個配置類，以前編寫的配置檔案一樣，也可以給容器中新增元件
@EnableConfigurationProperties(HttpEncodingProperties.class) //啟動指定類的ConfigurationProperties功能；將配置檔案中對應的值和HttpEncodingProperties繫結起來；並把HttpEncodingProperties加入到ioc容器中

@ConditionalOnWebApplication 
//Spring底層@Conditional註解（Spring註解版），根據不同的條件，如果滿足指定的條件，整個配置類裡面的配置就會生效；判斷當前應用是否是web應用，如果是，當前配置類生效

@ConditionalOnClass(CharacterEncodingFilter.class)  
//判斷當前專案有沒有這個類CharacterEncodingFilter；SpringMVC中進行亂碼解決的過濾器；

@ConditionalOnProperty(prefix = "spring.http.encoding", value = "enabled", matchIfMissing = true)  
//判斷配置檔案中是否存在某個配置  spring.http.encoding.enabled；如果不存在，判斷也是成立的
//即使我們配置檔案中不配置pring.http.encoding.enabled=true，也是預設生效的；
public class HttpEncodingAutoConfiguration {
  
    //他已經和SpringBoot的配置檔案映射了
    private final HttpEncodingProperties properties;
  
   //只有一個有參構造器的情況下，引數的值就會從容器中拿
    public HttpEncodingAutoConfiguration(HttpEncodingProperties properties) {
        this.properties = properties;
    }
  
    @Bean   //給容器中新增一個元件，這個元件的某些值需要從properties中獲取
    @ConditionalOnMissingBean(CharacterEncodingFilter.class) //判斷容器沒有這個元件
    public CharacterEncodingFilter characterEncodingFilter() {
        CharacterEncodingFilter filter = new OrderedCharacterEncodingFilter();
        filter.setEncoding(this.properties.getCharset().name());
        filter.setForceRequestEncoding(this.properties.shouldForce(Type.REQUEST));
        filter.setForceResponseEncoding(this.properties.shouldForce(Type.RESPONSE));
        return filter;
    }

根據當前不同的條件判斷，決定這個配置類是否生效。

一但這個配置類生效，這個配置類就會給容器中新增各種元件，這些元件的屬性是從對應的properties類中獲取的，這些類裡面的每一個屬性又是和配置檔案繫結的。

5.所有在配置檔案中能配置的屬性都是在xxxxProperties類中封裝者，配置檔案能配置什麼就可以參照某個功能對應的這個屬性類

@ConfigurationProperties(prefix = "spring.http.encoding")  //從配置檔案中獲取指定的值和bean的屬性進行繫結
public class HttpEncodingProperties {

   public static final Charset DEFAULT_CHARSET = Charset.forName("UTF-8");

精髓：

1）、SpringBoot啟動會載入大量的自動配置類

2）、先看我們需要的功能有沒有SpringBoot預設寫好的自動配置類

3）、再來看這個自動配置類中到底配置了哪些元件（只要我們要用的元件有，我們就不需要再來配置了）

4）、給容器中自動配置類新增元件的時候，會從properties類中獲取某些屬性。我們就可以在配置檔案中指定這些屬性的值

xxxxAutoConfigurartion：自動配置類；給容器中新增元件；

xxxxProperties:封裝配置檔案中相關屬性；

11.2 @Conditional註解

@Conditional派生註解（Spring註解版原生的@Conditional作用）

作用：必須是@Conditional指定的條件成立，才給容器中新增元件，配置配裡面的所有內容才生效。

@Conditional擴充套件註解	作用（判斷是否滿足當前指定條件）
@ConditionalOnJava	系統的java版本是否符合要求
@ConditionalOnBean	容器中存在指定Bean；
@ConditionalOnMissingBean	容器中不存在指定Bean；
@ConditionalOnExpression	滿足SpEL表示式指定
@ConditionalOnClass	系統中有指定的類
@ConditionalOnMissingClass	系統中沒有指定的類
@ConditionalOnSingleCandidate	容器中只有一個指定的Bean，或者這個Bean是首選Bean
@ConditionalOnProperty	系統中指定的屬性是否有指定的值
@ConditionalOnResource	類路徑下是否存在指定資原始檔
@ConditionalOnWebApplication	當前是web環境
@ConditionalOnNotWebApplication	當前不是web環境
@ConditionalOnJndi	JNDI存在指定項

自動配置類必須在一定的條件下才能生效。

我們怎麼知道哪些自動配置類生效？

我們可以通過在properties（yml）啟用 debug=true 屬性來讓控制檯列印自動配置報告，這樣我們就可以很方便的知道哪些自動配置類生效。

============================
CONDITIONS EVALUATION REPORT
============================


Positive matches:（自動配置類啟用的）
-----------------

   CodecsAutoConfiguration matched:
      - @ConditionalOnClass found required class 'org.springframework.http.codec.CodecConfigurer'; @ConditionalOnMissingClass did not find unwanted class (OnClassCondition)

   CodecsAutoConfiguration.JacksonCodecConfiguration matched:
      - @ConditionalOnClass found required class 'com.fasterxml.jackson.databind.ObjectMapper'; @ConditionalOnMissingClass did not find unwanted class (OnClassCondition)
.......
Negative matches:（沒有啟動，沒有匹配成功的自動配置類）
-----------------

   ActiveMQAutoConfiguration:
      Did not match:
         - @ConditionalOnClass did not find required classes 'javax.jms.ConnectionFactory', 'org.apache.activemq.ActiveMQConnectionFactory' (OnClassCondition)

   AopAutoConfiguration:
      Did not match:
         - @ConditionalOnClass did not find required classes 'org.aspectj.lang.annotation.Aspect', 'org.aspectj.lang.reflect.Advice', 'org.aspectj.weaver.AnnotatedElement' (OnClassCondition)