SpringBoot 自定义配置添加元数据提示

1. 自定义配置警告

有时候我们需要在配置文件中添加一些我们自定义的内容，比如下面图片中的data.analysis.kafka.address。这时会显示黄色的警告信息，鼠标放到黄色警告上，会提示无法解析该配置属性。

如果不管这个警告，也没事，项目也可以正常跑起来，该属性也能正常读取到，但是强迫症就是受不了这种警告，所以必须消除它。

2. 生成元数据配置

点击上图中的定义配置键'xxx'，会自动发生成下图的元数据文件：

打开该文件，内容如下：

3. 配置注解处理器

上图中提示未配置 Spring Boot 配置注解处理器，这时我们需要在项目的 pom 文件中添加依赖：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-configuration-processor</artifactId>
    <optional>true</optional>
</dependency>

注：pom.xml 中添加后，2.5.3 版本没生效，2.6.2 版本生效了。

此时发现配置文件中的自定义配置还是黄色的：

再看元数据文件，上方提示重新运行 Spring Boot 配置注解处理器以更新生成的元数据：

也就是说需要重新编译一下项目：

编译完毕后会发现自定义配置项不显示黄色警告了，并且还能自动提示了。

注：有时候不生效，可能和 IDEA 有关，重启 IDEA 就好了。

4. 元数据配置属性

下面是从 mybatis-spring-boot-starter 中复制出来的一部分：

{
  "properties": [
    {
      "sourceType": "org.apache.ibatis.session.Configuration",
      "defaultValue": "org.apache.ibatis.scripting.xmltags.XMLLanguageDriver",
      "name": "mybatis.configuration.default-scripting-language",
      "description": "A default LanguageDriver class.",
      "type": "java.lang.Class<? extends org.apache.ibatis.scripting.LanguageDriver>",
      "deprecation": {
        "reason": "Because when this configuration property is used, there is case that custom language driver cannot be registered correctly.",
        "replacement": "mybatis.default-scripting-language-driver"
      }
    }
  ]
}

文件中的属性值介绍

sourceType | String：贡献此属性的源的类名称。例如，如果属性来自带注解 @ConfigurationProperties 的类，则此属性将包含该类的完全限定名称。如果源类型未知，则可以省略。

defaultValue | Object：默认值，如果未指定属性，则使用该值。如果属性的类型是数组，则它可以是值数组。如果默认值未知，则可以省略。

name | String：属性的全名。名称采用小写的周期分隔形式（例如 server.address）。此属性是强制性的。

description | String：可以向用户显示的组的简短描述。如果没有可用的描述，则可以省略。建议描述为简短段落，第一行提供简明摘要。描述中的最后一行应以句点（.）结尾。

type | String：属性的数据类型的完整签名（例如 java.lang.String），但也是完整的泛型类型（例如 java.util.Map）。您可以使用此属性来指导用户可以输入的值的类型。为了保持一致性，通过使用其包装对应项（例如，boolean 变为 java.lang.Boolean）来指定基元的类型。请注意，此类可能是一个复杂类型，它从 String 绑定的值转换而来。如果类型未知，则可以省略。

deprecation | Object：

• level | String：弃用级别，可以是 warning（默认）或 error。当属性具有 warning 弃用级别时，它仍应绑定在环境中。但是，当它具有 error 弃用级别时，该属性不再受管理且不受约束。

• reason | String：该属性被弃用的原因的简短描述。如果没有可用的原因，可以省略。建议描述为简短段落，第一行提供简明摘要。描述中的最后一行应以句点（.）结尾。

• replacement | String：替换此不推荐使用的属性的属性的全名。如果此属性没有替换，则可以省略。