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

代码是写给人看的,不是写给机器看的,只是顺便计算机可以执行而已

——《计算机程序的构造和解释(SICP)》

导言

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

Application.java:

为SpringBoot项目中的自定义配置添加IDE支持_第1张图片

application.properties

为SpringBoot项目中的自定义配置添加IDE支持_第2张图片

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

application.xml

为SpringBoot项目中的自定义配置添加IDE支持_第3张图片

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

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

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

为SpringBoot项目中的自定义配置添加IDE支持_第4张图片

配置项元数据(Configuration Metadata)

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

元数据格式

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

为SpringBoot项目中的自定义配置添加IDE支持_第5张图片

配置项元数据文件按照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)。为了保证一致性,需要使用包装类型来替代基本类型。此属性不是必须的,但是无法得到类型诊断的支持。

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)

为自定义配置编写配置项元数据

接下来我们将对值、数组场景编写对应的配置项元数据,并为这些配置项添加提示(Talk is cheap,show me the code)

为SpringBoot项目中的自定义配置添加IDE支持_第6张图片

为SpringBoot项目中的自定义配置添加IDE支持_第7张图片

在IDE中实际使用的效果

为SpringBoot项目中的自定义配置添加IDE支持_第8张图片

为SpringBoot项目中的自定义配置添加IDE支持_第9张图片

为SpringBoot项目中的自定义配置添加IDE支持_第10张图片

不过这种方式虽然好,但是需要我们写很多的JSON配置来告诉IDE该如何进行代码补全和附加上下文信息,配置和代码还是处于分离的状态,如果能通过写一个配置类,直接通过这个类和它的注释就能为我们做到IDE支持就好了——Spring Boot开发者也是这么想的。

为代码自动生成配置项元数据

首先我们要改掉随处使用@Value的习惯,使用专门的数据类来存放我们的配置项

为SpringBoot项目中的自定义配置添加IDE支持_第11张图片

接下来我们创建一个Bean,让Spring Boot容器来接管这个类的实例

为SpringBoot项目中的自定义配置添加IDE支持_第12张图片

通过@ConfigurationProperties注解,Spring就会自动将配置注入到我们的配置Bean中,但是此时IDE还无法识别我们添加的自动配置,我们需要添加Spring Boot的注解处理器(annotation processor,从Java 1.6开始支持的特性)

为SpringBoot项目中的自定义配置添加IDE支持_第13张图片

添加注解处理器后重新编译,我们就会在target目录下看到自动生成的META-INF/spring-configuration-metadata.json

为SpringBoot项目中的自定义配置添加IDE支持_第14张图片

里面的内容基本就是我们之前自己手动输入的内容,只是受于Java代码表达信息的局限性,没有办法生成hints信息。其中sourceType和sourceMethod属性还可以帮助IDE跳转到我们声明这个配置的类和方法

为SpringBoot项目中的自定义配置添加IDE支持_第15张图片

如果我们想要让我们使用代码生成的配置类也能添加提示的话,可以在我们的META-INF目录下添加additional-spring-configuration-metadata.json文件,将hints写到这个文件里面

为SpringBoot项目中的自定义配置添加IDE支持_第16张图片

这样Spring Boot在编译的时候就会将我们的提示信息合并到配置信息元数据文件里面了

为SpringBoot项目中的自定义配置添加IDE支持_第17张图片

虽然这些工作不会增加代码的运行效率,但是让我们的配置集中起来并有IDE的加成,会让我们更改配置的时候更加有信心。正如开头所说的,代码是写给人看的,不是写给机器看的,只是顺便计算机可以执行而已。

你可能感兴趣的