详解如何为SpringBoot项目中的自定义配置添加IDE支持

Z时代
2024-01-10
分类：综合

导言

代码是写给人看的，不是写给机器看的，只是顺便计算机可以执行而已 ——《计算机程序的构造和解释（SICP）》导言

在我们的项目里经常会出现需要添加自定义配置的应用场景，例如某个开关变量，在测试环境打开，在生产环境不打开，通常我们都会使用下面的代码来实现，然后在Spring Boot配置文件中添加这个key和Value

Application.java:

application.properties

或者是没有使用@Value而直接在XML中使用我们配置的属性值

application.xml

这样的代码和配置在Spring Boot项目中可以正常启动并读取配置，但是在我们的IDE中却不会为我们提示配置的类型和代码补全。当我们有新同事到来，或者是需要为配置文件添加新的环境的支持的时候，我们很容易会把配置文件的Key拼错，或者Value的值与我们的变量类型并不兼容（实际上真的发生过这样的问题导致项目启动失败）。

但是在我们使用Spring Boot提供的配置的时候，IDE总是能为我们自动补全，告诉我们这个配置的变量类型，甚至是给我们把这个配置的描述显示出来。

我们是否也可以为我们自己写的配置添加这样的IDE支持呢？

配置项元数据（Configuration Metadata）

Spring Boot的Jar文件包含元数据文件，这些文件提供了我们所需要的配置属性的详细信息。IDE通过读取这些元数据文件，然后在使用application.properties或application.yml的时候提供上下文信息和代码补全。那么只要知道如何编写并存放配置项元数据信息文件，我们也可以让IDE知道如何为我们的自定义配置提供上下文信息。

元数据格式

Spring Boot项目的配置项元数据文件都放在META-INF/spring-configuration-metadata.json中。下图是当我们配置好Spring Boot项目后默认使用的Spring Boot自动配置的配置项元数据存放的位置

配置项元数据文件按照groups, properties和hints组织。properties下的每个property都是程序中需要使用的配置项的key值，比如server.port是服务启动后的端口号。而我们可以将一些property按照某些规则组合起来，这个组合就是group（通常我们并不需要为properties组织对应的group）。而hints是为我们的配置项提供额外的信息，比如时区time.zone支持Asia/Shanghai，我们可以为它提供"Asia/Shanghai"的hint。

properties的参数

名称	类型	描述
name	String	属性的全名。名称是小写字母以句点分割。此属性是必须的
type	String	属性的数据类型的完整签名（java.lang.String），如果是范型的话还应当包含完整的范型参数（java.util.List<java.lang.String>）。为了保证一致性，需要使用包装类型来替代基本类型。此属性不是必须的，但是无法得到类型诊断的支持。

hints的参数

名称	类型	描述
name	String	该提示所引用的属性的全称，和properties的name参数相同。此属性是必须的
values	ValueHint[]	ValueHint对象定义的有效值列表。每个条目都定义该值，并且可以具有描述

ValueHint的参数

名称	类型	描述
value	Object	property给定的类型的有效值，如果property的类型是数组，那么它也可以是值的数组。此属性是必须的。如果是Map类型的属性，可以使用.keys和.values来指定对应的有效值。
description	String	和properties的description相同，提示给用户的简短描述。此属性不是必须的。

这里只展示了我们常用的参数，关于配置项元数据文件格式的详细信息可以看Spring Boot的官方文档（https://docs.spring.io/spring-boot/docs/current/reference/html/appendix-configuration-metadata.html#configuration-metadata-format）