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