一、背景说明

spring默认使用yml中的配置，但有时候要用传统的xml或properties配置，就需要使用spring-boot-configuration-processor了

二、spring-boot-configuration-processor 介绍

Spring Boot Configuration Processor是一个用于生成配置元数据的注解处理器。
它可以帮助您生成有关Spring Boot应用程序中可用配置属性的元数据，以及这些属性的默认值和描述。
spring-boot-configuration-processor是一个用于生成Spring Boot配置元数据的注解处理器。
它可以自动扫描项目中的@ConfigurationProperties和@EnableConfigurationProperties注解，生成相应的元数据文件，使得IDEA能够提供代码补全、参数校验等功能。
通过使用spring-boot-configuration-processor，可以方便地使用IDE提供的代码补全、参数校验等功能，增强了代码可读性和可维护性，在开发过程中更加高效和便捷。

三、使用说明

使用spring-boot-configuration-processor需要遵循以下步骤：
要使用Spring Boot Configuration Processor，您需要将以下依赖项添加到pom.xml文件中：
在pom.xml中添加依赖：

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

添加依赖项后，在@ConfigurationProperties或@EnableConfigurationProperties注解所在的类上，加上@ConfigurationPropertiesScan注解：

import org.springframework.boot.context.properties.ConfigurationPropertiesScan;

@ConfigurationPropertiesScan
@SpringBootApplication
public class MyApplication {
    // ...
}

您可以在您的Spring Boot应用程序中使用@ConfigurationProperties注解来定义配置属性。
在@ConfigurationProperties或@EnableConfigurationProperties注解所在的类中，定义属性：

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

@Component
@ConfigurationProperties(prefix = "myapp")
public class MyAppProperties {
    private String name;
    private int port;
    private List<String> servers;
    private String description;
    // getters and setters
}

按下Ctrl + Shift + O组合键，导入相关的包，然后就可以在代码中使用自定义属性了。
然后，您可以使用mvn compile命令来生成配置元数据。
生成的元数据将位于target/classes/META-INF/spring-configuration-metadata.json文件中。
例如，对于上面的示例，生成的元数据可能如下所示：

{
  "groups": [
    {
      "name": "myapp",
      "type": "com.example.MyAppProperties",
      "sourceType": "com.example.MyAppProperties",
      "description": "MyApp properties"
    }
  ],
  "properties": [
    {
      "name": "myapp.name",
      "type": "java.lang.String",
      "sourceType": "com.example.MyAppProperties",
      "defaultValue": "",
      "description": "MyApp name"
    },
    {
      "name": "myapp.description",
      "type": "java.lang.String",
      "sourceType": "com.example.MyAppProperties",
      "defaultValue": "",
      "description": "MyApp description"
    }
  ]
}

您可以使用这些元数据来生成文档或IDE提示，以帮助用户了解可用的配置属性和它们的含义。

四、参考文章

https://blog.csdn.net/yuhan_0590/article/details/85100246