解决 IDEA:Spring Boot Configuration Annotation Proessor not configured 问题

IDEA 打开使用了 @ConfigurationProperties 注解的文件时可能会提示:Spring Boot Configuration Annotation Proessor not configured。

这是因为你的项目缺少了 spring-boot-configuration-processor 依赖(当然不添加也是不影响正常打包的)

1
2
3
4
5
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-configuration-processor</artifactId>
<optional>true</optional>
</dependency>

1614850454328

添加 spring-boot-configuration-processor 依赖后,IDEA 就不会再有这个提示了。同时打出的包里 META-INF 目录下会多出个 spring-configuration-metadata.json 文件。

1614850327982

该文件里面描述了上面 Java 代码定义的配置项,以及配置项对应的类型和类。

1614850172198

我们在配置 spring-boot 的配置项时,IDEA 能够支持点击配置项就直接跳转到对应的属性就是基于这个原理。

如果你开发的是个 SDK,其它项目会依赖的,建议还是把这个功能打开,这样对其他开发者更友好些。

参考资料

https://docs.spring.io/spring-boot/docs/1.5.8.RELEASE/reference/html/configuration-metadata.html#configuration-metadata-annotation-processor