要让自定义配置在 application.yml 或 application.properties 中获得 IDE 自动提示,关键在于使用 spring-boot-configuration-processor 在编译时生成 spring-configuration-metadata.json 元数据文件,需满足三个条件:配置类标注 @ConfigurationProperties(prefix="xxx")、被 Spring 容器管理(如加 @Component)、属性具备标准 getter/setter;同时需添加 optional=true 的 processor 依赖,并在 IDEA 中启用注解处理并执行 Rebuild Project。

要让自定义配置在 application.yml 或 application.properties 里获得 IDE 自动提示,关键不是手动写 JSON,而是靠 spring-boot-configuration-processor 在编译时自动生成元数据文件。
确保配置类正确声明
必须满足三个条件,IDE 才能识别并参与元数据生成:
- 类上标注
@ConfigurationProperties(prefix = "xxx"),前缀不能为空 - 类被 Spring 容器管理:加
@Component,或通过@EnableConfigurationProperties+@Bean显式注册 - 每个属性必须有标准 getter/setter(Lombok 的
@Data或@Setter+@Getter可用)
添加 processor 依赖
这个依赖只在编译期起作用,不进最终包,所以务必设为 optional=true:
Java项目代码review工具。分析Git变更+完整调用链路上下文,推断业务需求,进行多维度评分和分类汇总,生成完整PRD文档。包含细粒度Java代码审查清单(Null安全、异常处理、Streams、并发、equals/hashCode、资源管理、API设计、性能、MyBatis/ORM、事务边界、SQL/DD...
- Maven:
<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-configuration-processor</artifactId><optional>true</optional></dependency> - Gradle(4.6+):
annotationProcessor 'org.springframework.boot:spring-boot-configuration-processor'
启用注解处理器并触发编译
IDEA 默认可能关闭注解处理,需手动开启:
- Settings → Build → Compiler → Annotation Processors → 勾选 Enable annotation processing
- 执行 Build → Rebuild Project(不是 Build Project),确保完整编译
- 成功后,会在
target/classes/META-INF/下生成spring-configuration-metadata.json
验证提示是否生效
打开 application.yml,输入你配置类的前缀(如 myapp:),按 Ctrl+Space:
- 能看到字段名(如
port、debug)自动补全 - 悬停可显示 Javadoc 注释作为描述
- 类型和默认值也会出现在提示框中(前提是字段有 JavaDoc 和初始值)

















