前言

成都創(chuàng)新互聯(lián)公司是一家專注于成都網(wǎng)站設(shè)計、成都網(wǎng)站制作與策劃設(shè)計,龍里網(wǎng)站建設(shè)哪家好?成都創(chuàng)新互聯(lián)公司做網(wǎng)站,專注于網(wǎng)站建設(shè)十余年,網(wǎng)設(shè)計領(lǐng)域的專業(yè)建站公司;建站業(yè)務(wù)涵蓋:龍里等地區(qū)。龍里做網(wǎng)站價格咨詢:18980820575

Spring Boot在工作中是用到的越來越廣泛了，簡單方便，有了它，效率提高不知道多少倍。Spring Boot配置文件對Spring Boot來說就是入門和基礎(chǔ)，經(jīng)常會用到，所以寫下做個總結(jié)以便日后查看。

下面話不多說了，來一起看看詳細的介紹吧

1.配置文件

當(dāng)我們構(gòu)建完Spring Boot項目后，會在resources目錄下給我們一個默認的全局配置文件 application.properties，這是一個空文件，因為Spring Boot在底層已經(jīng)把配置都給我們自動配置好了，當(dāng)在配置文件進行配置時，會修改SpringBoot自動配置的默認值。

配置文件名是固定的

• application.properties

但我們可以修改為

• application.yml

這兩個文件本質(zhì)是一樣的，區(qū)別只是其中的語法略微不同。

2.值的寫法

application.properties 配置文件比較簡單，形式如下

• key = value

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

下面說下對于不同類型（字符串、數(shù)組）如何去規(guī)范書寫。

2.1 數(shù)字，字符串，布爾

1、直接寫

name=zhangsan

2、雙引號

不會轉(zhuǎn)義字符串里面的特殊字符，特殊字符會作為本身想表示的意思

name: "zhangsan \n lisi"

輸出：

zhangsan
lisi

3、單引號

會轉(zhuǎn)義特殊字符，特殊字符最終只是一個普通的字符串?dāng)?shù)據(jù)

name: ‘zhangsan \n lisi'

輸出：

zhangsan \n lisi

2.2 對象、Map（屬性和值）（鍵值對）

例如配置類中的字段為

Map maps;

在yml配置文件中，行內(nèi)寫法

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

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

person:
 maps:
 key: value

在properties配置文件中

person.maps.key=value

2.3 數(shù)組（List、Set）

在yml配置文件中

person:
 list:
 - 1
 - 2
 - 3

行內(nèi)寫法

person:
 list: [1,2,3]

在properties配置文件中

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

3.自定義配置屬性

Spring Boot提供自定義配置組件，拿前面舉例的屬性來寫一個規(guī)范的配置文件

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

 public Map getMaps() {
 return maps;
 }

 public void setMaps(Map maps) {
 this.maps = maps;
 }

 public List getList() {
 return list;
 }

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

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

@ConfigurationProperties 注解向Spring Boot聲明該類中的所有屬性和配置文件中相關(guān)的配置進行綁定。

• prefix = "person"：聲明配置前戳，將該前戳下的所有屬性進行映射。

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

4.配置自動提示

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

 org.springframework.boot
 spring-boot-configuration-processor
 true

若是依舊無法自動提示，可以嘗試開啟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 ，配置內(nèi)容如下

person.mail=yster@foxmail.com

然后在配置類中使用@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：該注解導(dǎo)入Spring的xml配置文件，讓配置文件里面的內(nèi)容生效。

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

7.配置文件占位符

Spring Boot配置文件支持占位符，一些用法如下

7.1 隨機數(shù)

${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 #指定使用哪個環(huán)境

---
server:
 port: 8083
spring:
 profiles: dev #指定屬于哪個環(huán)境


---

server:
 port: 8084
spring:
 profiles: prod #指定屬于哪個環(huán)境

8.3 激活指定profile

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

1、使用命令行：

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

可以直接在測試的時候，配置傳入命令行參數(shù)

2、虛擬機參數(shù)：

-Dspring.profiles.active=dev

9.配置文件加載位置

springboot 啟動會掃描以下位置的application.properties或者application.yml文件作為Spring boot的默認配置文件

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

優(yōu)先級由高到底，高優(yōu)先級的配置會覆蓋低優(yōu)先級的配置；SpringBoot會從這四個位置全部加載主配置文件。

項目打包好以后，我們可以使用命令行參數(shù)的形式，啟動項目的時候來指定配置文件的新位置；指定配置文件和默認加載的這些配置文件共同起作用形成互補配置；

我們還可以通過spring.config.location來改變默認的配置文件位置，示例：

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

10.外部配置加載順序

SpringBoot也可以從以下位置加載配置，優(yōu)先級從高到低，高優(yōu)先級的配置覆蓋低優(yōu)先級的配置，所有的配置會形成互補配置。

1.命令行參數(shù)

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

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系統(tǒng)屬性（System.getProperties()）

4.操作系統(tǒng)環(huán)境變量

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

由jar包外向jar包內(nèi)進行尋找

優(yōu)先加載帶{profile}

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

7.jar包內(nèi)部的application-{profile}.properties或application.yml(帶spring.profile)配置文件

再來加載不帶profile

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

9.jar包內(nèi)部的application.properties或application.yml(不帶spring.profile)配置文件

10.@Configuration注解類上的@PropertySource

11.通過SpringApplication.setDefaultProperties指定的默認屬性

11.自動配置原理

11.1 自動配置原理

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

2.@EnableAutoConfiguration 作用：

• 利用EnableAutoConfigurationImportSelector給容器中導(dǎo)入一些組件
• 可以查看selectImports()方法的內(nèi)容；
• List configurations = getCandidateConfigurations(annotationMetadata, attributes);獲取候選的配置
• SpringFactoriesLoader.loadFactoryNames()

     掃描所有jar包類路徑下 META-INF/spring.factories

     把掃描到的這些文件的內(nèi)容包裝成properties對象

     從properties中獲取到EnableAutoConfiguration.class類（類名）對應(yīng)的值，然后把他們添加在容器中

     將類路徑下 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功能；將配置文件中對應(yīng)的值和HttpEncodingProperties綁定起來；并把HttpEncodingProperties加入到ioc容器中

@ConditionalOnWebApplication 
//Spring底層@Conditional注解（Spring注解版），根據(jù)不同的條件，如果滿足指定的條件，整個配置類里面的配置就會生效；判斷當(dāng)前應(yīng)用是否是web應(yīng)用，如果是，當(dāng)前配置類生效

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

@ConditionalOnProperty(prefix = "spring.http.encoding", value = "enabled", matchIfMissing = true) 
//判斷配置文件中是否存在某個配置 spring.http.encoding.enabled；如果不存在，判斷也是成立的
//即使我們配置文件中不配置pring.http.encoding.enabled=true，也是默認生效的；
public class HttpEncodingAutoConfiguration {
 
 //他已經(jīng)和SpringBoot的配置文件映射了
 private final HttpEncodingProperties properties;
 
 //只有一個有參構(gòu)造器的情況下，參數(shù)的值就會從容器中拿
 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;
 }

根據(jù)當(dāng)前不同的條件判斷，決定這個配置類是否生效。

一但這個配置類生效，這個配置類就會給容器中添加各種組件，這些組件的屬性是從對應(yīng)的properties類中獲取的，這些類里面的每一個屬性又是和配置文件綁定的。

5.所有在配置文件中能配置的屬性都是在xxxxProperties類中封裝者，配置文件能配置什么就可以參照某個功能對應(yīng)的這個屬性類

@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:封裝配置文件中相關(guān)屬性；

11.2 @Conditional注解

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

作用：必須是@Conditional指定的條件成立，才給容器中添加組件，配置配里面的所有內(nèi)容才生效。

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

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

我們可以通過在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)

參考

docs.spring.io官方文檔

總結(jié)

以上就是這篇文章的全部內(nèi)容了，希望本文的內(nèi)容對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值，如果有疑問大家可以留言交流，謝謝大家對創(chuàng)新互聯(lián)的支持。