微信公众号搜"智元新知"关注
微信扫一扫可直接关注哦!

Spring Boot自定义配置实现IDE自动提示

file

一、背景

官方提供的spring boot starter的配置项,我们用IDE配置的时候一般都有自动提示的,如下图所示

file


而我们自己自定义的配置却没有,对开发非常不友好容易打错配置,那这个是怎样实现的呢?

 

二、提示原理

IDE是通过读取配置信息的元数据而实现自动提示的,而元数据在目录meta-inf中的spring-configuration-Metadata.json 或者 additional-spring-configuration-Metadata.json

 

三、实现自动提示

以我这个自己开发的starter中的自定义配置文件为例,如果自己手动创建这些元数据的话工作量比较大,使用IDEA的话有自动生成功能

file

 

3.1. 引入依赖spring-boot-configuration-processor

zlt-swagger2-spring-boot-starter工程中添加以下jar包

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

 

3.2. 修改IDEA配置

搜索Annotation Processor并设置Enable annotation processing

file

 

3.3. 重新编译项目

项目在重新编译后就会自动生成spring-configuration-Metadata.json文件

file

 

四、测试

自定义的swagger配置已经能自动提示

file

 
参考资料
https://docs.spring.io/spring-boot/docs/current/reference/html/configuration-metadata.html

 
推荐阅读

版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 [email protected] 举报,一经查实,本站将立刻删除。

相关推荐