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

1、背景

官方提供的spring boot starter的配置項，咱們用IDE配置的時候通常都有自動提示的，以下圖所示

而咱們本身自定義的配置卻沒有，對開發很是不友好容易打錯配置，那這個是怎樣實現的呢？

 

2、提示原理

IDE是經過讀取配置信息的元數據而實現自動提示的，而元數據在目錄META-INF中的spring-configuration-metadata.json 或者 additional-spring-configuration-metadata.json

 

3、實現自動提示

以我這個本身開發的starter中的自定義配置文件爲例，若是本身手動建立這些元數據的話工做量比較大，使用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文件

 

4、測試

自定義的swagger配置已經能自動提示了

 
參考資料
https://docs.spring.io/spring-boot/docs/current/reference/html/configuration-metadata.html

 
推薦閱讀

• 日誌排查問題困難？分佈式日誌鏈路跟蹤來幫你
• zuul集成Sentinel最新的網關流控組件
• 阿里註冊中心Nacos生產部署方案