如何在SpringBoot項(xiàng)目中的自定義配置添加IDE支持

這篇文章將為大家詳細(xì)講解有關(guān)如何在SpringBoot項(xiàng)目中的自定義配置添加IDE支持，文章內(nèi)容質(zhì)量較高，因此小編分享給大家做個(gè)參考，希望大家閱讀完這篇文章后對(duì)相關(guān)知識(shí)有一定的了解。

Application.java:

application.properties

或者是沒有使用@Value而直接在XML中使用我們配置的屬性值

application.xml

這樣的代碼和配置在Spring Boot項(xiàng)目中可以正常啟動(dòng)并讀取配置，但是在我們的IDE中卻不會(huì)為我們提示配置的類型和代碼補(bǔ)全。當(dāng)我們有新同事到來，或者是需要為配置文件添加新的環(huán)境的支持的時(shí)候，我們很容易會(huì)把配置文件的Key拼錯(cuò)，或者Value的值與我們的變量類型并不兼容（實(shí)際上真的發(fā)生過這樣的問題導(dǎo)致項(xiàng)目啟動(dòng)失?。?。

但是在我們使用Spring Boot提供的配置的時(shí)候，IDE總是能為我們自動(dòng)補(bǔ)全，告訴我們這個(gè)配置的變量類型，甚至是給我們把這個(gè)配置的描述顯示出來。

我們是否也可以為我們自己寫的配置添加這樣的IDE支持呢？

配置項(xiàng)元數(shù)據(jù)（Configuration Metadata）

Spring Boot的Jar文件包含元數(shù)據(jù)文件，這些文件提供了我們所需要的配置屬性的詳細(xì)信息。IDE通過讀取這些元數(shù)據(jù)文件，然后在使用application.properties或application.yml的時(shí)候提供上下文信息和代碼補(bǔ)全。 那么只要知道如何編寫并存放配置項(xiàng)元數(shù)據(jù)信息文件，我們也可以讓IDE知道如何為我們的自定義配置提供上下文信息。

元數(shù)據(jù)格式

Spring Boot項(xiàng)目的配置項(xiàng)元數(shù)據(jù)文件都放在META-INF/spring-configuration-metadata.json中。下圖是當(dāng)我們配置好Spring Boot項(xiàng)目后默認(rèn)使用的Spring Boot自動(dòng)配置的配置項(xiàng)元數(shù)據(jù)存放的位置

配置項(xiàng)元數(shù)據(jù)文件按照groups, properties和hints組織。properties下的每個(gè)property都是程序中需要使用的配置項(xiàng)的key值，比如server.port是服務(wù)啟動(dòng)后的端口號(hào)。而我們可以將一些property按照某些規(guī)則組合起來，這個(gè)組合就是group（通常我們并不需要為properties組織對(duì)應(yīng)的group）。而hints是為我們的配置項(xiàng)提供額外的信息，比如時(shí)區(qū)time.zone支持Asia/Shanghai，我們可以為它提供"Asia/Shanghai"的hint。

properties的參數(shù)

hints的參數(shù)

ValueHint的參數(shù)

這里只展示了我們常用的參數(shù)，關(guān)于配置項(xiàng)元數(shù)據(jù)文件格式的詳細(xì)信息可以看Spring Boot的官方文檔 （https://docs.spring.io/spring-boot/docs/current/reference/html/appendix-configuration-metadata.html#configuration-metadata-format）

為自定義配置編寫配置項(xiàng)元數(shù)據(jù)

接下來我們將對(duì)值、數(shù)組場(chǎng)景編寫對(duì)應(yīng)的配置項(xiàng)元數(shù)據(jù)，并為這些配置項(xiàng)添加提示（Talk is cheap，show me the code）

在IDE中實(shí)際使用的效果

不過這種方式雖然好，但是需要我們寫很多的JSON配置來告訴IDE該如何進(jìn)行代碼補(bǔ)全和附加上下文信息，配置和代碼還是處于分離的狀態(tài)， 如果能通過寫一個(gè)配置類，直接通過這個(gè)類和它的注釋 就能為我們做到IDE支持就好了——Spring Boot開發(fā)者也是這么想的。

為代碼自動(dòng)生成配置項(xiàng)元數(shù)據(jù)

首先我們要改掉隨處使用@Value的習(xí)慣，使用專門的數(shù)據(jù)類來存放我們的配置項(xiàng)

接下來我們創(chuàng)建一個(gè)Bean，讓Spring Boot容器來接管這個(gè)類的實(shí)例

通過@ConfigurationProperties注解，Spring就會(huì)自動(dòng)將配置注入到我們的配置Bean中，但是此時(shí)IDE還無法識(shí)別我們添加的自動(dòng)配置，我們需要添加Spring Boot的注解處理器（annotation processor，從Java 1.6開始支持的特性）

添加注解處理器后重新編譯，我們就會(huì)在target目錄下看到自動(dòng)生成的META-INF/spring-configuration-metadata.json

里面的內(nèi)容基本就是我們之前自己手動(dòng)輸入的內(nèi)容，只是受于Java代碼表達(dá)信息的局限性，沒有辦法生成hints信息。其中sourceType和sourceMethod屬性還可以幫助IDE跳轉(zhuǎn)到我們聲明這個(gè)配置的類和方法

如果我們想要讓我們使用代碼生成的配置類也能添加提示的話，可以在我們的META-INF目錄下添加additional-spring-configuration-metadata.json文件，將hints寫到這個(gè)文件里面

這樣Spring Boot在編譯的時(shí)候就會(huì)將我們的提示信息合并到配置信息元數(shù)據(jù)文件里面了

關(guān)于如何在SpringBoot項(xiàng)目中的自定義配置添加IDE支持就分享到這里了，希望以上內(nèi)容可以對(duì)大家有一定的幫助，可以學(xué)到更多知識(shí)。如果覺得文章不錯(cuò)，可以把它分享出去讓更多的人看到。