Spring Boot自定義配置實現IDE自動提示功能

一、背景
官方提供的spring boot starter的配置項,我們用IDE配置的時候一般都有自動提示的,如下圖所示

而我們自己自定義的配置卻沒有,對開發(fā)非常不友好容易打錯配置, 那這個是怎樣實現的呢?
二、提示原理
IDE是通過讀取配置信息的元數據而實現自動提示的,而元數據在目錄 META-INF 中的 spring-configuration-metadata.json 或者 additional-spring-configuration-metadata.json
三、實現自動提示
以我這個自己開發(fā)的starter中的自定義配置文件為例,如果自己手動創(chuàng)建這些元數據的話工作量比較大,使用 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配置已經能自動提示了

參考資料
https://docs.spring.io/spring-boot/docs/current/reference/html/configuration-metadata.html
總結
以上所述是小編給大家介紹的Spring Boot自定義配置實現IDE自動提示功能,希望對大家有所幫助,如果大家有任何疑問歡迎給我留言,小編會及時回復大家的!
相關文章
Java中注解@JsonFormat與@DateTimeFormat的使用
從數據庫獲取時間傳到前端進行展示的時候,我們有時候可能無法得到一個滿意的時間格式的時間日期,本文主要介紹了Java中注解@JsonFormat與@DateTimeFormat的使用,文中通過示例代碼介紹的非常詳細,需要的朋友們下面隨著小編來一起學習學習吧2023-08-08
springboot 實現記錄業(yè)務日志和異常業(yè)務日志的操作
這篇文章主要介紹了springboot 實現記錄業(yè)務日志和異常業(yè)務日志的操作,具有很好的參考價值,希望對大家有所幫助。如有錯誤或未考慮完全的地方,望不吝賜教2021-07-07
如何使用Spring AOP預處理Controller的參數
這篇文章主要介紹了如何使用Spring AOP預處理Controller的參數操作,具有很好的參考價值,希望對大家有所幫助。如有錯誤或未考慮完全的地方,望不吝賜教2021-08-08

