導(dǎo)言

代碼是寫給人看的，不是寫給機(jī)器看的，只是順便計算機(jī)可以執(zhí)行而已 ——《計算機(jī)程序的構(gòu)造和解釋（SICP）》 導(dǎo)言

在我們的項(xiàng)目里經(jīng)常會出現(xiàn)需要添加自定義配置的應(yīng)用場景，例如某個開關(guān)變量，在測試環(huán)境打開，在生產(chǎn)環(huán)境不打開，通常我們都會使用下面的代碼來實(shí)現(xiàn)，然后在Spring Boot配置文件中添加這個key和Value

Application.java:

application.properties

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

application.xml

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

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

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

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

Spring Boot的Jar文件包含元數(shù)據(jù)文件，這些文件提供了我們所需要的配置屬性的詳細(xì)信息。IDE通過讀取這些元數(shù)據(jù)文件，然后在使用application.properties或application.yml的時候提供上下文信息和代碼補(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自動配置的配置項(xiàng)元數(shù)據(jù)存放的位置

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

properties的參數(shù)

名稱 類型 描述 name String 屬性的全名。名稱是小寫字母以句點(diǎn)分割。此屬性是必須的 type String 屬性的數(shù)據(jù)類型的完整簽名（java.lang.String），如果是范型的話還應(yīng)當(dāng)包含完整的范型參數(shù)（java.util.List<java.lang.String>）。為了保證一致性，需要使用包裝類型來替代基本類型。此屬性不是必須的，但是無法得到類型診斷的支持。

hints的參數(shù)

名稱 類型 描述 name String 該提示所引用的屬性的全稱，和properties的name參數(shù)相同。此屬性是必須的 values ValueHint[] ValueHint對象定義的有效值列表。每個條目都定義該值，并且可以具有描述

ValueHint的參數(shù)

名稱 類型 描述 value Object property給定的類型的有效值，如果property的類型是數(shù)組，那么它也可以是值的數(shù)組。此屬性是必須的。如果是Map類型的屬性，可以使用.keys和.values來指定對應(yīng)的有效值。 description String 和properties的description相同，提示給用戶的簡短描述。此屬性不是必須的。

這里只展示了我們常用的參數(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ù)

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

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

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

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

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

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

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

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

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

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

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

雖然這些工作不會增加代碼的運(yùn)行效率，但是讓我們的配置集中起來并有IDE的加成，會讓我們更改配置的時候更加有信心。正如開頭所說的， 代碼是寫給人看的，不是寫給機(jī)器看的，只是順便計算機(jī)可以執(zhí)行而已。

到此這篇關(guān)于詳解如何為SpringBoot項(xiàng)目中的自定義配置添加IDE支持的文章就介紹到這了,更多相關(guān)SpringBoot 添加IDE支持內(nèi)容請搜索好吧啦網(wǎng)以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持好吧啦網(wǎng)！