spring-boot-configuration-processor 如何使用

Spring Boot Configuration Processor 是一个用于生成配置元数据的注解处理器，可以帮助我们在编译时生成配置元数据，方便 IDE 自动生成配置属性的提示和文档，提高开发效率。

下面是使用 Spring Boot Configuration Processor 的步骤：

1. 添加 Maven 依赖：

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

2. 在配置类上添加 `@ConfigurationProperties` 注解，指定配置属性的前缀：

@ConfigurationProperties(prefix = "myconfig")
public class MyConfig {
    private String name;
    private int age;
    // getters and setters
}

3. 在配置属性上添加 `@ConfigurationProperties` 注解，指定属性名和默认值：

public class MyConfig {
    @ConfigurationProperties("name")
    private String name = "default";
    @ConfigurationProperties("age")
    private int age = 18;
    // getters and setters
}

4. 在配置类同级目录下创建 `META-INF/spring-configuration-metadata.json` 文件，配置属性的元数据信息：

{
  "groups": [
    {
      "name": "myconfig",
      "type": "com.example.demo.MyConfig",
      "sourceType": "com.example.demo.MyConfig"
    }
  ],
  "properties": [
    {
      "name": "myconfig.name",
      "type": "java.lang.String",
      "description": "Name of the user",
      "defaultValue": "default"
    },
    {
      "name": "myconfig.age",
      "type": "java.lang.Integer",
      "description": "Age of the user",
      "defaultValue": 18
    }
  ]
}

5. 在 IDE 中使用配置属性时，会自动提示和补全属性名、类型、描述和默认值等信息。

注意：在使用 `@ConfigurationProperties` 注解时，需要在配置类上添加 `@EnableConfigurationProperties` 注解，或者在 Spring Boot 应用程序主类上添加 `@EnableConfigurationProperties(MyConfig.class)` 注解，才能使属性生效。

参考文档：https://docs.spring.io/spring-boot/docs/current/reference/html/appendix-configuration-metadata.html#configuration-metadata-annotation-processor