2. 程式人生 > 程式設計 >Spring Boot自定義配置實現IDE自動提示

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

阿新 • • 發佈：2019-12-31

file

一、背景

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

file
而我們自己自定義的配置卻沒有，對開發非常不友好容易打錯配置，那這個是怎樣實現的呢？

 

二、提示原理

IDE是通過讀取配置資訊的元資料而實現自動提示的，而元資料在目錄META-INF中的spring-configuration-metadata.json 或者 additional-spring-configuration-metadata.json

 

三、實現自動提示

以我這個自己開發的starter中的自定義配置檔案為例，如果自己手動建立這些元資料的話工作量比較大，使用IDEA

的話有自動生成功能

file

 

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

file

 

3.3. 重新編譯專案

專案在重新編譯後就會自動生成spring-configuration-metadata.json檔案

file

 

四、測試

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

file

  參考資料 docs.spring.io/spring-boot…

  推薦閱讀

相關推薦

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

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

Spring Boot自定義Banner實現程式碼

這篇文章主要介紹了Spring Boot自定義Banner實現程式碼,文中通過示例程式碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值,需要的朋友可以參考下

Spring Boot自定義favicon實現方法例項解析

自定義歡迎頁 Spring Boot 專案在啟動後，首先會去靜態資源路徑下查詢index.html作為首頁檔案，若查詢不到，則會去查詢動態的index檔案作為首頁檔案。例如，如果想使用靜態的index.html作為首頁，那麼只需在resource

Spring Boot 自定義配置檔案異常"expected single matching bean but found 2"

執行環境：Spring Boot 2.5.0, IDEA 2020.3.2 異常詳細資訊： Injection of resource dependencies failed; nested exception is org.springframework.beans.factory.NoUniqueBeanDefinitionException: No qualifyin

Spring-boot自定義配置類

把yml檔案屬性注入到物件中 不用在@value(${}) @data生成get/set方法 @Component生成物件到spring容器中使用的時候可以直接使用 @resource注入該物件

Spring Boot 自定義執行緒池使用@Async實現非同步呼叫任務

定義執行緒池 第一步，先在Spring Boot主類中定義一個執行緒池，比如： @SpringBootApplication

Spring Boot自定義starter配置提示

在使用Spring Boot官方提供的starter時候發現，每一個配置項都有提示資訊，使用起來很方便，但是自定義的starter卻沒有提示，其實這裡可以引入一個依賴來處理提示問題。

Spring Boot 自定義資料來源DruidDataSource程式碼

這篇文章主要介紹了Spring Boot 自定義資料來源DruidDataSource程式碼,文中通過示例程式碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值,需要的朋友可以參考下

Spring Boot自定義錯誤檢視

Spring Boot預設錯誤檢視解析器　　Web應用在處理請求的過程中發生錯誤是非常常見的情況，SpringBoot中為我們實現了一個錯誤檢視解析器（DefaultErrorViewResolver）。它基於一些常見的約定，嘗試根據HTTP錯誤狀態碼

Spring Boot自定義錯誤檢視的方法詳解

Spring Boot預設錯誤檢視解析器 　　Web應用在處理請求的過程中發生錯誤是非常常見的情況，SpringBoot中為我們實現了一個錯誤檢視解析器（DefaultErrorViewResolver）。它基於一些常見的約定，嘗試根據HTTP錯誤狀態碼

Docker 自定義配置執行redis自動退出

檢查配置檔案是否設定了daemonize yes，如果是，就要改為daemonize no 因為該選項讓redis成為在後臺執行的守護程序而docker容器必須要有一個前臺程序才能留存否則容器會自動退出

Spring boot 自定義註解，Java通過反射獲取註解，及註解的說明，附原始碼下載！

內容簡介 　　本文介紹在Java中 Spring 框架下自定義註解的宣告和使用，並利用反射來獲取到自定義註解及註解的屬性和值。

Spring boot 自定義banner的線上製作

那該如何給開源專案新增自定義的banner，提升逼格呢？比如以下自定義的banner

spring aop + 自定義註解實現本地快取

1.首先加入本地快取依賴這裡用到的是caffine <!--本地快取 --><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-cache</artifactId>&

spring-boot自定義start

技術標籤：spring boot （我們以redis為例，我們自己製作一個starter） 1、首先建立一個專案； 2、加入依賴

Spring Boot 自定義Controller切面日記攔截

技術標籤：springbootjavaThreadjava反射 @Retention(RetentionPolicy.RUNTIME)//註解會在class中存在，執行時可通過反射獲取

Spring security 自定義過濾器實現Json引數傳遞併兼容表單引數(例項程式碼)

依賴 <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-security</artifactId>

springboot yml中不寫會從環境變數取值嗎_Spring Boot從入門到實戰：Spring Boot自定義屬性...

技術標籤：springboot yml中不寫會從環境變數取值嗎 Web專案開發中，經常需要自定義一些屬性，如資料庫連線，第三方服務介面地址，第三方服務的appKey、appSecret等，以及針對不同環境，這些屬性的值還需要有

Spring 使用自定義類實現AOP

技術標籤：JavaWebSpringjavaspringaop 文章目錄 一、搭建環境二、自定義類三、配置xml檔案四、測試

Spring Boot自定義Starter編寫Demo

Spring Boot的自定義Starter ​ 一般建立自定義Starter時，會分為兩個專案：xxx-spring-boot-starter, xxx-spring-boot-autoconfigure。starter模組不寫任何業務程式碼，只用來引入autoconfigure模組的依賴，而在其