解決SpringBoot使用yaml作為配置文件遇到的坑
SpringBoot yaml作為配置文件遇到的坑
背景
最近搞新項(xiàng)目，重新搭建一套基于SpringBoot的開(kāi)發(fā)框架。
問(wèn)題的由來(lái)是我在進(jìn)行一個(gè)dao單元測(cè)試時(shí)，一直失敗，報(bào)錯(cuò)信息大概是“生成dataSource時(shí)maxActive屬性不能為0”?；谝酝慕?jīng)驗(yàn)，應(yīng)該是配置屬性沒(méi)有成功加載。排查由@ConfigurationProperties注解注釋的配置屬性類(lèi)時(shí)，application.yml中的屬性怎么注入不進(jìn)來(lái)。
查看debug日志，發(fā)現(xiàn)很奇怪的一行日志
Skipped (empty) config file 'file:/E:/workspace/union-service/union-service-dao/target/test-classes/application.yml' (classpath:/application.yml)
明明不是空的！懷疑文件名不對(duì)，確認(rèn)并重試了幾次，仍然不行，只能調(diào)試了。
調(diào)試到了PropertySourcesLoader這個(gè)類(lèi)
public PropertySource<?> load(Resource resource, String group, String name,
String profile) throws IOException {
if (isFile(resource)) {
String sourceName = generatePropertySourceName(name, profile);
for (PropertySourceLoader loader : this.loaders) {
if (canLoadFileExtension(loader, resource)) {
PropertySource<?> specific = loader.load(sourceName, resource,
profile);
addPropertySource(group, specific, profile);
return specific;
}
}
}
return null;
}
YamlPropertySourceLoader類(lèi)的load方法：
@Override
public PropertySource<?> load(String name, Resource resource, String profile)
throws IOException {
if (ClassUtils.isPresent("org.yaml.snakeyaml.Yaml", null)) {
Processor processor = new Processor(resource, profile);
Map<String, Object> source = processor.process();
if (!source.isEmpty()) {
return new MapPropertySource(name, source);
}
}
return null;
}
查找" org.yaml.snakeyaml.Yaml"類(lèi)，如果不存在，就返回null。我的項(xiàng)目代碼修改倒也簡(jiǎn)單，添加snakeyaml的依賴(lài)即可。
但是SpringBoot代碼執(zhí)行到這里，說(shuō)明已經(jīng)存在resource文件，因?yàn)闆](méi)有解析yaml的類(lèi)跳過(guò)去，再去找其他適合的配置文件，也說(shuō)的過(guò)去，可是為啥不能打個(gè)日志提示一下粗心又頑強(qiáng)的碼農(nóng)們呢？
感覺(jué)修改一下比較好，類(lèi)似這樣：
@Override
public PropertySource<?> load(String name, Resource resource, String profile)
throws IOException {
if (ClassUtils.isPresent("org.yaml.snakeyaml.Yaml", null)) {
Processor processor = new Processor(resource, profile);
Map<String, Object> source = processor.process();
if (!source.isEmpty()) {
return new MapPropertySource(name, source);
}
} else {
logger.warn("Found " + name + " while lacking of snakeyaml");
}
return null;
}
相關(guān)issue已在github提交給spring boot。
SpringBoot-yaml配置注入
yaml基礎(chǔ)語(yǔ)法
說(shuō)明：語(yǔ)法要求嚴(yán)格！
1、空格不能省略
2、以縮進(jìn)來(lái)控制層級(jí)關(guān)系，只要是左邊對(duì)齊的一列數(shù)據(jù)都是同一個(gè)層級(jí)的。
3、屬性和值的大小寫(xiě)都是十分敏感的。
字面量：普通的值 [ 數(shù)字，布爾值，字符串 ]
字面量直接寫(xiě)在后面就可以 ， 字符串默認(rèn)不用加上雙引號(hào)或者單引號(hào)；
k: v
注意：
“ ” 雙引號(hào)，不會(huì)轉(zhuǎn)義字符串里面的特殊字符 ， 特殊字符會(huì)作為本身想表示的意思；
比如 ：
yaml name: "kuang \n shen"
輸出 ：
yaml kuang 換行 shen
''單引號(hào)，會(huì)轉(zhuǎn)義特殊字符 ， 特殊字符最終會(huì)變成和普通字符一樣輸出
比如 ：
yaml name: ‘kuang \n shen'
輸出 ：
yaml kuang \n shen
對(duì)象、Map（鍵值對(duì)）
#對(duì)象、Map格式k: v1: v2:
在下一行來(lái)寫(xiě)對(duì)象的屬性和值得關(guān)系，注意縮進(jìn)；比如：
student: name: qinjiang age: 3
行內(nèi)寫(xiě)法
student: {name: qinjiang,age: 3}
數(shù)組（ List、set ）
用 - 值表示數(shù)組中的一個(gè)元素,比如：
pets: - cat - dog - pig
行內(nèi)寫(xiě)法
pets: [cat,dog,pig]
修改SpringBoot的默認(rèn)端口號(hào)
配置文件中添加，端口號(hào)的參數(shù)，就可以切換端口；
server: port: 8082
yaml注入配置文件
原來(lái)的方法
1、在springboot項(xiàng)目中的resources目錄下新建一個(gè)文件 application.yml
2、編寫(xiě)一個(gè)實(shí)體類(lèi) Dog；
package com.kuang.springboot.pojo;
@Component //注冊(cè)bean到容器中
public class Dog {
private String name;
private Integer age;
//有參無(wú)參構(gòu)造、get、set方法、toString()方法
}
3、思考，我們?cè)瓉?lái)是如何給bean注入屬性值的！@Value，給狗狗類(lèi)測(cè)試一下：
@Component //注冊(cè)bean
public class Dog {
@Value("阿黃")
private String name;
@Value("18")
private Integer age;
}
4、在SpringBoot的測(cè)試類(lèi)下注入狗狗輸出一下；
@SpringBootTest
class DemoApplicationTests {
@Autowired //將狗狗自動(dòng)注入進(jìn)來(lái)
Dog dog;
@Test
public void contextLoads() {
System.out.println(dog); //打印看下狗狗對(duì)象
}
}
結(jié)果成功輸出，@Value注入成功，這是原來(lái)的辦法。
Yaml方法
我們?cè)诰帉?xiě)一個(gè)實(shí)體類(lèi)：Person 類(lèi)
@Component //注冊(cè)bean到容器中
public class Person {
private String name;
private Integer age;
private Boolean happy;
private Date birth;
private Map<String,Object> maps;
private List<Object> lists;
private Dog dog;
//有參無(wú)參構(gòu)造、get、set方法、toString()方法
}
使用yaml配置的方式進(jìn)行注入，寫(xiě)的時(shí)候注意區(qū)別和優(yōu)勢(shì)，我們編寫(xiě)一個(gè)yaml配置！
person:
name: qinjiang
age: 3
happy: false
birth: 2000/01/01
maps: {k1: v1,k2: v2}
lists:
- code
- girl
- music
dog:
name: 旺財(cái)
age: 1
把person這個(gè)對(duì)象的所有值都寫(xiě)好了，現(xiàn)在來(lái)注入到類(lèi)中
/*
@ConfigurationProperties作用：
將配置文件中配置的每一個(gè)屬性的值，映射到這個(gè)組件中；
告訴SpringBoot將本類(lèi)中的所有屬性和配置文件中相關(guān)的配置進(jìn)行綁定
參數(shù) prefix = “person” : 將配置文件中的person下面的所有屬性一一對(duì)應(yīng)
*/
@Component //注冊(cè)bean
@ConfigurationProperties(prefix = "person")
public class Person {
private String name;
private Integer age;
private Boolean happy;
private Date birth;
private Map<String,Object> maps;
private List<Object> lists;
private Dog dog;
}
確認(rèn)以上配置之后，測(cè)試類(lèi)中測(cè)試一下
@SpringBootTest
class DemoApplicationTests {
@Autowired
Person person; //將person自動(dòng)注入進(jìn)來(lái)
@Test
public void contextLoads() {
System.out.println(person); //打印person信息
}
}
結(jié)果：所有值全部注入成功
加載指定的配置文件
@PropertySource ：加載指定的配置文件；
@configurationProperties：默認(rèn)從全局配置文件中獲取值；
@PropertySource的使用
1、在resources目錄下新建一個(gè)person.properties文件
name=kuangshen
2、然后在代碼中指定加載person.properties文件
@PropertySource(value = "classpath:person.properties")
@Component //注冊(cè)bean
public class Person {
@Value("${name}")
private String name;
......
}
3、再次輸出測(cè)試一下：指定配置文件綁定成功
@configurationProperties的使用
配合yaml文件使用，具體看上邊的程序理解。
結(jié)論
配置yml和配置properties都可以獲取到值 ， 強(qiáng)烈推薦 yml；
如果我們?cè)谀硞€(gè)業(yè)務(wù)中，只需要獲取配置文件中的某個(gè)值，可以使用一下 @value；
如果說(shuō)，我們專(zhuān)門(mén)編寫(xiě)了一個(gè)JavaBean來(lái)和配置文件進(jìn)行一一映射，就直接@configurationProperties，不要猶豫！
以上為個(gè)人經(jīng)驗(yàn)，希望能給大家一個(gè)參考，也希望大家多多支持腳本之家。
相關(guān)文章
IDEA個(gè)性化設(shè)置注釋模板詳細(xì)講解版
IDEA自帶的注釋模板不是太好用,我本人到網(wǎng)上搜集了很多資料系統(tǒng)的整理了一下制作了一份比較完整的模板來(lái)分享給大家,下面這篇文章主要給大家介紹了IDEA個(gè)性化設(shè)置注釋模板的相關(guān)資料,需要的朋友可以參考下2024-01-01
SpringBoot實(shí)現(xiàn)支付寶沙箱支付的完整步驟
沙箱支付是一種用于模擬真實(shí)支付環(huán)境的測(cè)試工具,它提供了一個(gè)安全的測(cè)試環(huán)境,供開(kāi)發(fā)者在不影響真實(shí)交易的情況下進(jìn)行支付功能的開(kāi)發(fā)和測(cè)試,這篇文章給大家介紹了SpringBoot實(shí)現(xiàn)支付寶沙箱支付的完整步驟,需要的朋友可以參考下2024-04-04
SpringMVC 方法四種類(lèi)型返回值總結(jié)(你用過(guò)幾種)
這篇文章主要介紹了SpringMVC 方法四種類(lèi)型返回值總結(jié)(你用過(guò)幾種)，小編覺(jué)得挺不錯(cuò)的，現(xiàn)在分享給大家，也給大家做個(gè)參考。一起跟隨小編過(guò)來(lái)看看吧2019-05-05
Windows下使用IDEA搭建Hadoop開(kāi)發(fā)環(huán)境的詳細(xì)方法
這篇文章主要介紹了Windows下使用IDEA搭建Hadoop開(kāi)發(fā)環(huán)境,本文通過(guò)圖文并茂的形式給大家介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值，需要的朋友可以參考下2020-12-12
spring boot 開(kāi)發(fā)soap webservice的實(shí)現(xiàn)代碼
這篇文章主要介紹了spring boot 開(kāi)發(fā)soap webservice的實(shí)現(xiàn)代碼，小編覺(jué)得挺不錯(cuò)的，現(xiàn)在分享給大家，也給大家做個(gè)參考。一起跟隨小編過(guò)來(lái)看看吧2019-01-01
圖解Java經(jīng)典算法折半查找的原理與實(shí)現(xiàn)
折半查找法也叫做?分查找,顧名思義就是把數(shù)據(jù)分成兩半,再判斷所查找的key在哪?半中,再重復(fù)上述步驟知道找到?標(biāo)key,下面這篇文章主要介紹了圖解Java經(jīng)典算法折半查找的原理與實(shí)現(xiàn)2022-09-09
java 遞歸查詢(xún)所有子節(jié)點(diǎn)id的方法實(shí)現(xiàn)
在多層次的數(shù)據(jù)結(jié)構(gòu)中,經(jīng)常需要查詢(xún)一個(gè)節(jié)點(diǎn)下的所有子節(jié)點(diǎn),本文主要介紹了java 遞歸查詢(xún)所有子節(jié)點(diǎn)id的方法實(shí)現(xiàn),具有一定的參考價(jià)值,感興趣的可以了解一下2024-03-03
這篇文章主要介紹了SpringMVC請(qǐng)求參數(shù)接收的相關(guān)操作,本文通過(guò)示例代碼給大家介紹的非常詳細(xì),感興趣的朋友跟隨小編一起看看吧2024-07-07
這篇文章主要介紹了Jmeter工作原理及常見(jiàn)錯(cuò)誤解析,文中通過(guò)示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下2020-09-09
這篇文章主要介紹了idea導(dǎo)入maven工程的三種方法，文中通過(guò)示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2021-04-04