史上最全面的Spring Boot配置文件深入講解
前言
Spring Boot在工作中是用到的越來越廣泛了,簡(jiǎn)單方便,有了它,效率提高不知道多少倍。Spring Boot配置文件對(duì)Spring Boot來說就是入門和基礎(chǔ),經(jīng)常會(huì)用到,所以寫下做個(gè)總結(jié)以便日后查看。
下面話不多說了,來一起看看詳細(xì)的介紹吧
1.配置文件
當(dāng)我們構(gòu)建完Spring Boot項(xiàng)目后,會(huì)在resources目錄下給我們一個(gè)默認(rèn)的全局配置文件 application.properties,這是一個(gè)空文件,因?yàn)镾pring Boot在底層已經(jīng)把配置都給我們自動(dòng)配置好了,當(dāng)在配置文件進(jìn)行配置時(shí),會(huì)修改SpringBoot自動(dòng)配置的默認(rèn)值。
配置文件名是固定的
- application.properties
但我們可以修改為
- application.yml
這兩個(gè)文件本質(zhì)是一樣的,區(qū)別只是其中的語法略微不同。
2.值的寫法
application.properties 配置文件比較簡(jiǎn)單,形式如下
- key = value
application.yml 配置文件使用YMAL語言,YMAL不是如XML般的標(biāo)記語言,更適合作為配置文件。
下面說下對(duì)于不同類型(字符串、數(shù)組)如何去規(guī)范書寫。
2.1 數(shù)字,字符串,布爾
1、直接寫
name=zhangsan
2、雙引號(hào)
不會(huì)轉(zhuǎn)義字符串里面的特殊字符,特殊字符會(huì)作為本身想表示的意思
name: "zhangsan \n lisi"
輸出:
zhangsan
lisi
3、單引號(hào)
會(huì)轉(zhuǎn)義特殊字符,特殊字符最終只是一個(gè)普通的字符串?dāng)?shù)據(jù)
name: ‘zhangsan \n lisi'
輸出:
zhangsan \n lisi
2.2 對(duì)象、Map(屬性和值)(鍵值對(duì))
例如配置類中的字段為
Map<String,String> maps;
在yml配置文件中,行內(nèi)寫法
person.maps: {key1: value1,key2: value2}
需要注意:號(hào)后的空格,或者
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提供自定義配置組件,拿前面舉例的屬性來寫一個(gè)規(guī)范的配置文件
@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聲明該類中的所有屬性和配置文件中相關(guān)的配置進(jìn)行綁定。
- prefix = "person":聲明配置前戳,將該前戳下的所有屬性進(jìn)行映射。
@Component 或者@Configuration:將該組件加入Spring Boot容器,只有這個(gè)組件是容器中的組件,配置才生效。
4.配置自動(dòng)提示
在配置自定義屬性時(shí),如果想要獲得和配置Spring Boot屬性自動(dòng)提示一樣的功能,則需要加入下面的依賴:
<!--導(dǎo)入配置文件處理器,配置文件進(jìn)行綁定就會(huì)有提示--> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-configuration-processor</artifactId> <optional>true</optional> </dependency>
若是依舊無法自動(dòng)提示,可以嘗試開啟IDE的Annonation Processing
5.配置屬性校驗(yàn)
自定義配置文件時(shí),可以使用@Validated注解對(duì)注入的值進(jìn)行一些簡(jiǎn)單的校驗(yàn),示例代碼
@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 注解會(huì)對(duì)mail字段的注入值進(jìn)行檢驗(yàn),如果注入的不是一個(gè)合法的郵件地址則會(huì)拋出異常。
其它常見注解:
- @AssertFalse 校驗(yàn)false
- @AssertTrue 校驗(yàn)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 對(duì)po實(shí)體類進(jìn)行校驗(yàn)
上述的這些注解位于javax.validation.constraints包下,具體用法查看注釋即可了解。
6.自定義配置文件
除了在默認(rèn)的application文件進(jìn)行屬性配置,我們也可以自定義配置文件,例如新建 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; } }
測(cè)試@PropertySource注解不支持注入yml文件。
擴(kuò)展: @ImportResource:該注解導(dǎo)入Spring的xml配置文件,讓配置文件里面的內(nèi)容生效。
例如: @ImportResource(locations = {"classpath:beans.xml"})
7.配置文件占位符
Spring Boot配置文件支持占位符,一些用法如下
7.1 隨機(jī)數(shù)
${random.value} ${random.int} ${random.long} ${random.int(10)} ${random.int[1024,65536]}
7.2 默認(rèn)值
占位符獲取之前配置的值,如果沒有可以是用:指定默認(rèn)值
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文件
我們?cè)谥髋渲梦募帉懙臅r(shí)候,文件名可以是 application-{profile}.properties/yml
默認(rèn)使用application.properties的配置
8.2 yml支持多文檔塊方式
通過---可以把一個(gè)yml文檔分割為多個(gè),并可以通過 spring.profiles.active 屬性指定使用哪個(gè)配置文件
server: port: 8081 spring: profiles: active: prod #指定使用哪個(gè)環(huán)境 --- server: port: 8083 spring: profiles: dev #指定屬于哪個(gè)環(huán)境 --- server: port: 8084 spring: profiles: prod #指定屬于哪個(gè)環(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
可以直接在測(cè)試的時(shí)候,配置傳入命令行參數(shù)
2、虛擬機(jī)參數(shù):
-Dspring.profiles.active=dev
9.配置文件加載位置
springboot 啟動(dòng)會(huì)掃描以下位置的application.properties或者application.yml文件作為Spring boot的默認(rèn)配置文件
- –file:./config/
- –file:./
- –classpath:/config/
- –classpath:/
優(yōu)先級(jí)由高到底,高優(yōu)先級(jí)的配置會(huì)覆蓋低優(yōu)先級(jí)的配置;SpringBoot會(huì)從這四個(gè)位置全部加載主配置文件。
項(xiàng)目打包好以后,我們可以使用命令行參數(shù)的形式,啟動(dòng)項(xiàng)目的時(shí)候來指定配置文件的新位置;指定配置文件和默認(rèn)加載的這些配置文件共同起作用形成互補(bǔ)配置;
我們還可以通過spring.config.location來改變默認(rèn)的配置文件位置,示例:
java -jar spring-boot-demo-0.0.1-SNAPSHOT.jar --spring.config.location=G:/application.properties
10.外部配置加載順序
SpringBoot也可以從以下位置加載配置,優(yōu)先級(jí)從高到低,高優(yōu)先級(jí)的配置覆蓋低優(yōu)先級(jí)的配置,所有的配置會(huì)形成互補(bǔ)配置。
1.命令行參數(shù)
所有的配置都可以在命令行上進(jìn)行指定
java -jar spring-boot-02-config-02-0.0.1-SNAPSHOT.jar --server.port=8087 --server.context-path=/abc
多個(gè)配置用空格分開,形如 --配置項(xiàng)=值
2.來自java:comp/env的JNDI屬性
3.Java系統(tǒng)屬性(System.getProperties())
4.操作系統(tǒng)環(huán)境變量
5.RandomValuePropertySource配置的random.*屬性值
由jar包外向jar包內(nèi)進(jìn)行尋找
優(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指定的默認(rèn)屬性
11.自動(dòng)配置原理
11.1 自動(dòng)配置原理
1.SpringBoot啟動(dòng)的時(shí)候加載主配置類,@EnableAutoConfiguration注解開啟了自動(dòng)配置功能。
2.@EnableAutoConfiguration 作用:
- 利用EnableAutoConfigurationImportSelector給容器中導(dǎo)入一些組件
- 可以查看selectImports()方法的內(nèi)容;
- List<String> configurations = getCandidateConfigurations(annotationMetadata, attributes);獲取候選的配置
- SpringFactoriesLoader.loadFactoryNames()
掃描所有jar包類路徑下 META-INF/spring.factories
把掃描到的這些文件的內(nèi)容包裝成properties對(duì)象
從properties中獲取到EnableAutoConfiguration.class類(類名)對(duì)應(yīng)的值,然后把他們添加在容器中
將類路徑下 META-INF/spring.factories 里面配置的所有EnableAutoConfiguration的值加入到了容器中
每一個(gè)這樣的 xxxAutoConfiguration類都是容器中的一個(gè)組件,都加入到容器中,用他們來做自動(dòng)配置。
# Auto Configure org.springframework.boot.autoconfigure.EnableAutoConfiguration=\ org.springframework.boot.autoconfigure.admin.SpringApplicationAdminJmxAutoConfiguration,\ ......
3.對(duì)每一個(gè)自動(dòng)配置類進(jìn)行自動(dòng)配置功能。
4.以HttpEncodingAutoConfiguration(Http編碼自動(dòng)配置)為例解釋自動(dòng)配置原理;
@Configuration //表示這是一個(gè)配置類,以前編寫的配置文件一樣,也可以給容器中添加組件 @EnableConfigurationProperties(HttpEncodingProperties.class) //啟動(dòng)指定類的ConfigurationProperties功能;將配置文件中對(duì)應(yīng)的值和HttpEncodingProperties綁定起來;并把HttpEncodingProperties加入到ioc容器中 @ConditionalOnWebApplication //Spring底層@Conditional注解(Spring注解版),根據(jù)不同的條件,如果滿足指定的條件,整個(gè)配置類里面的配置就會(huì)生效;判斷當(dāng)前應(yīng)用是否是web應(yīng)用,如果是,當(dāng)前配置類生效 @ConditionalOnClass(CharacterEncodingFilter.class) //判斷當(dāng)前項(xiàng)目有沒有這個(gè)類CharacterEncodingFilter;SpringMVC中進(jìn)行亂碼解決的過濾器; @ConditionalOnProperty(prefix = "spring.http.encoding", value = "enabled", matchIfMissing = true) //判斷配置文件中是否存在某個(gè)配置 spring.http.encoding.enabled;如果不存在,判斷也是成立的 //即使我們配置文件中不配置pring.http.encoding.enabled=true,也是默認(rèn)生效的; public class HttpEncodingAutoConfiguration { //他已經(jīng)和SpringBoot的配置文件映射了 private final HttpEncodingProperties properties; //只有一個(gè)有參構(gòu)造器的情況下,參數(shù)的值就會(huì)從容器中拿 public HttpEncodingAutoConfiguration(HttpEncodingProperties properties) { this.properties = properties; } @Bean //給容器中添加一個(gè)組件,這個(gè)組件的某些值需要從properties中獲取 @ConditionalOnMissingBean(CharacterEncodingFilter.class) //判斷容器沒有這個(gè)組件 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)前不同的條件判斷,決定這個(gè)配置類是否生效。
一但這個(gè)配置類生效,這個(gè)配置類就會(huì)給容器中添加各種組件,這些組件的屬性是從對(duì)應(yīng)的properties類中獲取的,這些類里面的每一個(gè)屬性又是和配置文件綁定的。
5.所有在配置文件中能配置的屬性都是在xxxxProperties類中封裝者,配置文件能配置什么就可以參照某個(gè)功能對(duì)應(yīng)的這個(gè)屬性類
@ConfigurationProperties(prefix = "spring.http.encoding") //從配置文件中獲取指定的值和bean的屬性進(jìn)行綁定 public class HttpEncodingProperties { public static final Charset DEFAULT_CHARSET = Charset.forName("UTF-8");
精髓:
1)、SpringBoot啟動(dòng)會(huì)加載大量的自動(dòng)配置類
2)、先看我們需要的功能有沒有SpringBoot默認(rèn)寫好的自動(dòng)配置類
3)、再來看這個(gè)自動(dòng)配置類中到底配置了哪些組件(只要我們要用的組件有,我們就不需要再來配置了)
4)、給容器中自動(dòng)配置類添加組件的時(shí)候,會(huì)從properties類中獲取某些屬性。我們就可以在配置文件中指定這些屬性的值
xxxxAutoConfigurartion:自動(dòng)配置類;給容器中添加組件;
xxxxProperties:封裝配置文件中相關(guān)屬性;
11.2 @Conditional注解
@Conditional派生注解(Spring注解版原生的@Conditional作用)
作用:必須是@Conditional指定的條件成立,才給容器中添加組件,配置配里面的所有內(nèi)容才生效。
@Conditional擴(kuò)展注解 | 作用(判斷是否滿足當(dāng)前指定條件) |
---|---|
@ConditionalOnJava | 系統(tǒng)的java版本是否符合要求 |
@ConditionalOnBean | 容器中存在指定Bean; |
@ConditionalOnMissingBean | 容器中不存在指定Bean; |
@ConditionalOnExpression | 滿足SpEL表達(dá)式指定 |
@ConditionalOnClass | 系統(tǒng)中有指定的類 |
@ConditionalOnMissingClass | 系統(tǒng)中沒有指定的類 |
@ConditionalOnSingleCandidate | 容器中只有一個(gè)指定的Bean,或者這個(gè)Bean是首選Bean |
@ConditionalOnProperty | 系統(tǒng)中指定的屬性是否有指定的值 |
@ConditionalOnResource | 類路徑下是否存在指定資源文件 |
@ConditionalOnWebApplication | 當(dāng)前是web環(huán)境 |
@ConditionalOnNotWebApplication | 當(dāng)前不是web環(huán)境 |
@ConditionalOnJndi | JNDI存在指定項(xiàng) |
自動(dòng)配置類必須在一定的條件下才能生效。
我們?cè)趺粗滥男┳詣?dòng)配置類生效?
我們可以通過在properties(yml)啟用 debug=true 屬性來讓控制臺(tái)打印自動(dòng)配置報(bào)告,這樣我們就可以很方便的知道哪些自動(dòng)配置類生效。
============================ CONDITIONS EVALUATION REPORT ============================ Positive matches:(自動(dòng)配置類啟用的) ----------------- 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:(沒有啟動(dòng),沒有匹配成功的自動(dòng)配置類) ----------------- 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)
參考
總結(jié)
以上就是這篇文章的全部?jī)?nèi)容了,希望本文的內(nèi)容對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,如果有疑問大家可以留言交流,謝謝大家對(duì)腳本之家的支持。
相關(guān)文章
java ThreadPoolExecutor使用方法簡(jiǎn)單介紹
這篇文章主要介紹了java ThreadPoolExecutor使用方法簡(jiǎn)單介紹的相關(guān)資料,需要的朋友可以參考下2017-02-02SpringCloud中的Eureka注冊(cè)中心詳細(xì)解讀
這篇文章主要介紹了SpringCloud中的Eureka注冊(cè)中心詳細(xì)解讀,想要參與服務(wù)注冊(cè)發(fā)現(xiàn)的實(shí)例首先需要向Eureka服務(wù)器注冊(cè)信息,注冊(cè)在第一次心跳發(fā)生時(shí)提交,需要的朋友可以參考下2023-11-11FluentMybatis實(shí)現(xiàn)mybatis動(dòng)態(tài)sql拼裝和fluent api語法
本文主要介紹了FluentMybatis實(shí)現(xiàn)mybatis動(dòng)態(tài)sql拼裝和fluent api語法,具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2021-08-08使用java + selenium + OpenCV破解網(wǎng)易易盾滑動(dòng)驗(yàn)證碼的示例
這篇文章主要介紹了使用java + selenium + OpenCV破解網(wǎng)易易盾滑動(dòng)驗(yàn)證碼,本文通過實(shí)例代碼給大家介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2021-02-02java實(shí)現(xiàn)自動(dòng)回復(fù)聊天機(jī)器人
這篇文章主要為大家詳細(xì)介紹了java實(shí)現(xiàn)自動(dòng)回復(fù)聊天機(jī)器人,文中示例代碼介紹的非常詳細(xì),具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2018-08-08