Spring Boot自定義配置實(shí)現(xiàn)IDE自動(dòng)提示功能
一、背景
官方提供的spring boot starter的配置項(xiàng),我們用IDE配置的時(shí)候一般都有自動(dòng)提示的,如下圖所示
而我們自己自定義的配置卻沒(méi)有,對(duì)開(kāi)發(fā)非常不友好容易打錯(cuò)配置, 那這個(gè)是怎樣實(shí)現(xiàn)的呢?
二、提示原理
IDE是通過(guò)讀取配置信息的元數(shù)據(jù)而實(shí)現(xiàn)自動(dòng)提示的,而元數(shù)據(jù)在目錄 META-INF
中的 spring-configuration-metadata.json
或者 additional-spring-configuration-metadata.json
三、實(shí)現(xiàn)自動(dòng)提示
以我這個(gè)自己開(kāi)發(fā)的starter中的自定義配置文件為例,如果自己手動(dòng)創(chuàng)建這些元數(shù)據(jù)的話工作量比較大,使用 IDEA
的話有自動(dòng)生成功能
3.1. 引入依賴spring-boot-configuration-processor
在 zlt-swagger2-spring-boot-starter
工程中添加以下jar包
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-configuration-processor</artifactId> <optional>true</optional> </dependency>
3.2. 修改IDEA配置
搜索 Annotation Processor
并設(shè)置 Enable annotation processing
3.3. 重新編譯項(xiàng)目
項(xiàng)目在重新編譯后就會(huì)自動(dòng)生成 spring-configuration-metadata.json
文件
四、測(cè)試
自定義的swagger配置已經(jīng)能自動(dòng)提示了
參考資料
https://docs.spring.io/spring-boot/docs/current/reference/html/configuration-metadata.html
總結(jié)
以上所述是小編給大家介紹的Spring Boot自定義配置實(shí)現(xiàn)IDE自動(dòng)提示功能,希望對(duì)大家有所幫助,如果大家有任何疑問(wèn)歡迎給我留言,小編會(huì)及時(shí)回復(fù)大家的!
相關(guān)文章
springboot Quartz動(dòng)態(tài)修改cron表達(dá)式的方法
這篇文章主要介紹了springboot Quartz動(dòng)態(tài)修改cron表達(dá)式的方法,小編覺(jué)得挺不錯(cuò)的,現(xiàn)在分享給大家,也給大家做個(gè)參考。一起跟隨小編過(guò)來(lái)看看吧2018-09-09springboot項(xiàng)目整合druid數(shù)據(jù)庫(kù)連接池的實(shí)現(xiàn)
這篇文章主要介紹了springboot項(xiàng)目整合druid數(shù)據(jù)庫(kù)連接池的實(shí)現(xiàn),文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2021-04-04MyBatis-Plus條件構(gòu)造器Wrapper應(yīng)用實(shí)例
QueryWrapper是用于查詢的Wrapper條件構(gòu)造器,可以通過(guò)它來(lái)構(gòu)建SELECT語(yǔ)句中的WHERE條件,這篇文章主要介紹了MyBatis-Plus數(shù)據(jù)表操作條件構(gòu)造器Wrapper,需要的朋友可以參考下2023-09-09springboot實(shí)現(xiàn)jar運(yùn)行復(fù)制resources文件到指定的目錄(思路詳解)
這篇文章主要介紹了springboot實(shí)現(xiàn)jar運(yùn)行復(fù)制resources文件到指定的目錄,本文給大家介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2023-04-04Springboot jar包遠(yuǎn)程調(diào)試詳解
這篇文章主要為大家詳細(xì)介紹了Springboot jar包遠(yuǎn)程調(diào)試,具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2019-09-09Spring+MyBatis實(shí)現(xiàn)數(shù)據(jù)讀寫(xiě)分離的實(shí)例代碼
本篇文章主要介紹了Spring+MyBatis實(shí)現(xiàn)數(shù)據(jù)讀寫(xiě)分離的實(shí)例代碼,具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2017-07-07