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

本文共计1508个文字，预计阅读时间需要7分钟。

导语+代码是写给人看的，不是写给机器看的，只是方便计算机可以执行而已————《计算机程序的构造和解释》（SICP）+ 导语+在我们的项目中，经常会遇到需要添加自定义配置的应用场景。

导言

代码是写给人看的，不是写给机器看的，只是顺便计算机可以执行而已 ——《计算机程序的构造和解释（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文件包含元数据文件，这些文件提供了我们所需要的配置属性的详细信息。