如何使用Spring Boot配置处理器为Record生成配置字段描述

首先确认核心前提：

• Java版本至少为16（Record是Java 16引入的特性）
• Spring Boot版本建议升级到2.6及以上（后续版本对Record的配置元数据生成支持更完善）

下面提供两种可行的解决方法：

方法1：规范Record的Javadoc写法 #

在Record类的Javadoc中，通过@param明确标注每个参数的描述，配置处理器会自动识别这些内容并同步到spring-configuration-metadata.json中。示例代码：

/**
 * 应用核心配置
 * @param appName 应用的显示名称，会在日志和监控中展示
 * @param appPort 应用监听的HTTP端口，默认值为8080
 */
@ConfigurationProperties(prefix = "app")
public record AppConfig(String appName, int appPort) {
}

注意：这种写法需要Spring Boot 2.6+版本支持，旧版本可能无法识别Record类Javadoc中的@param描述。

方法2：使用@Description注解显式指定描述 #

如果方法1不生效（比如使用的Spring Boot版本较低），可以直接给Record的每个参数添加@org.springframework.boot.context.properties.Description注解，强制指定描述内容。示例代码：

@ConfigurationProperties(prefix = "app")
public record AppConfig(
        @Description("应用的显示名称，会在日志和监控中展示")
        String appName,
        @Description("应用监听的HTTP端口，默认值为8080")
        int appPort
) {
}

额外检查项 #

1. 确认spring-boot-configuration-processor依赖已正确引入：
   • Maven依赖配置：

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

   • Gradle配置：

     annotationProcessor 'org.springframework.boot:spring-boot-configuration-processor'
     

2. 重新编译项目：修改配置类/Record后，执行一次完整编译（比如Maven的mvn compile，Gradle的gradle compileJava），确保配置处理器重新生成元数据文件。
3. 检查IDE配置：如果使用IDEA等IDE，确保开启注解处理器支持（Settings -> Build, Execution, Deployment -> Compiler -> Annotation Processors）。

内容的提问来源于stack exchange，提问作者mydeveloperplanet