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自動提示功能，希望對大家有所幫助，如果大家有任何疑問歡迎給我留言，小編會及時回復大家的！
相關(guān)文章
Java中注解@JsonFormat與@DateTimeFormat的使用
從數(shù)據(jù)庫獲取時間傳到前端進行展示的時候,我們有時候可能無法得到一個滿意的時間格式的時間日期,本文主要介紹了Java中注解@JsonFormat與@DateTimeFormat的使用,文中通過示例代碼介紹的非常詳細,需要的朋友們下面隨著小編來一起學習學習吧2023-08-08
springboot 實現(xiàn)記錄業(yè)務日志和異常業(yè)務日志的操作
這篇文章主要介紹了springboot 實現(xiàn)記錄業(yè)務日志和異常業(yè)務日志的操作，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2021-07-07
在面向?qū)ο蟮某绦蛟O計中，里氏替換原則（Liskov Substitution principle）是對子類型的特別定義。本文將為大家詳細介紹Java設計模式七大原則之一的里氏替換原則，需要的可以參考一下2022-02-02
這篇文章主要介紹了從匯編碼分析java對象的創(chuàng)建過程,本文給大家介紹的非常詳細，對大家的學習或工作具有一定的參考借鑒價值，需要的朋友可以參考下2020-03-03
本文是《Java Web開發(fā)教程——入門與提高篇（JSP+Servlet）》一書《第9章 JDBC技術(shù)》的補充內(nèi)容。2009-06-06
SpringBoot實現(xiàn)無感刷新Token的項目實踐
token刷新是前端安全中必要的一部分,本文就來介紹一下SpringBoot實現(xiàn)無感刷新Token的項目實踐,具有一定的參考價值,感興趣的可以了解一下2024-03-03
這篇文章主要介紹了Java設計模式中的策略(Strategy)模式解讀,對象的某個行為,在不同場景有不同實現(xiàn)方式,可以將這些行為的具體實現(xiàn)定義為一組策略,每個實現(xiàn)類實現(xiàn)一種策略,在不同場景使用不同的實現(xiàn),并且可以自由切換策略,需要的朋友可以參考下2023-10-10
本文會基于實際場景介紹ThreadLocal如何使用以及內(nèi)部實現(xiàn)機制。 具有很好的參考價值，下面跟著小編一起來看下吧2017-02-02
如何使用Spring AOP預處理Controller的參數(shù)
這篇文章主要介紹了如何使用Spring AOP預處理Controller的參數(shù)操作，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2021-08-08
這篇文章主要介紹了SpringBoot Bean花式注解方法，很多時候我們需要根據(jù)不同的條件在容器中加載不同的Bean，或者根據(jù)不同的條件來選擇是否在容器中加載某個Bean2023-02-02