Spring Boot 2.x基礎(chǔ)教程:配置元數(shù)據(jù)的應(yīng)用

在使用Spring Boot開發(fā)應(yīng)用的時(shí)候,你是否有發(fā)現(xiàn)這樣的情況:自定義屬性是有高量背景的,鼠標(biāo)放上去,有一個(gè)Cannot resolve configuration property的配置警告。

如果不對于這個(gè)警告覺得煩,想要去掉,那么可以通過設(shè)置來去除:

但是,我的建議是不要去掉,因?yàn)檫@個(gè)警告正好可以通過高亮來區(qū)分你的自定義配置以及框架配置,可以讓你快速的分辨哪些是自定義的。
如果你實(shí)在想去掉,那么也不建議用上面說的方法,而是建議通過完善配置元數(shù)據(jù)的方式來完成。所以,今天就來具體說說配置元數(shù)據(jù)的應(yīng)用!
啥是配置元數(shù)據(jù)?
我們不妨打開一個(gè)已經(jīng)創(chuàng)建好的Spring Boot項(xiàng)目,查看一下它的Spring Boot依賴包,可以找到如下圖的一個(gè)json文件:

這里報(bào)錯(cuò)的就是配置的元數(shù)據(jù)信息。有沒有發(fā)現(xiàn)這些name的值都很熟悉?其中description是不是也很熟悉?對,這些就是我們常用的Spring Boot原生配置的元數(shù)據(jù)信息。
這下知道配置元數(shù)據(jù)可以用來做啥了吧?它可以幫助IDE來完成配置聯(lián)想和配置提示的展示。
而我們自定義配置之所以會報(bào)警告,同時(shí)也沒有提示信息,就是因?yàn)闆]有這個(gè)元數(shù)據(jù)的配置文件!
配置元數(shù)據(jù)的自動(dòng)生成
既然知道了原理,那么接下來我們嘗試用一下配置元數(shù)據(jù)試試!
第一步:創(chuàng)建一個(gè)配置類,定義一個(gè)自定義配置
@Data
@Configuration
@ConfigurationProperties(prefix?=?"com.didispace")
public?class?DidiProperties?{
????
????/**
?????*?這是一個(gè)測試配置
?????*/
????private?String?from;
}
第二步:在pom.xml中添加自動(dòng)生成配置元數(shù)據(jù)的依賴
<dependency>
????<groupId>org.springframework.bootgroupId>
????<artifactId>spring-boot-configuration-processorartifactId>
dependency>
第三步:mvn install下這個(gè)項(xiàng)目。
此時(shí)我們可以在工程target目錄下找到元數(shù)據(jù)文件:

同時(shí),我們在配置文件中嘗試編寫這個(gè)自定義的配置項(xiàng)時(shí),可以看到編譯器給出了聯(lián)想和提示:

并且,編寫完配置之后,也沒有高亮警告了!
代碼示例
本文的相關(guān)例子可以查看下面?zhèn)}庫中的chapter1-4目錄:
Github:https://github.com/dyc87112/SpringBoot-Learning/ Gitee:https://gitee.com/didispace/SpringBoot-Learning/
如果您覺得本文不錯(cuò),歡迎Star支持,您的關(guān)注是我堅(jiān)持的動(dòng)力!
往期推薦

