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

 

推荐阅读

 

  • 1
    点赞
  • 3
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值