Spring Boot自定义配置实现IDE自动提示功能
一、背景
官方提供的spring boot starter的配置项，我们用IDE配置的时候一般都有自动提示的，如下图所示
而我们自己自定义的配置却没有，对开发非常不友好容易打错配置， 那这个是怎样实现的呢？
二、提示原理
IDE是通过读取配置信息的元数据而实现自动提示的，而元数据在目录 META-INF 中的 spring-configuration-metadata.json 或者 additional-spring-configuration-metadata.json
三、实现自动提示
以我这个自己开发的starter中的自定义配置文件为例，如果自己手动创建这些元数据的话工作量比较大，使用 IDEA 的话有自动生成功能
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
3.3. 重新编译项目
项目在重新编译后就会自动生成 spring-configuration-metadata.json 文件
四、测试
自定义的swagger配置已经能自动提示了
参考资料
https://docs.spring.io/spring-boot/docs/current/reference/html/configuration-metadata.html
总结
以上所述是小编给大家介绍的Spring Boot自定义配置实现IDE自动提示功能，希望对大家有所帮助，如果大家有任何疑问欢迎给我留言，小编会及时回复大家的！
相关文章
springboot Quartz动态修改cron表达式的方法
这篇文章主要介绍了springboot Quartz动态修改cron表达式的方法，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧2018-09-09
这篇文章主要介绍了springboot项目整合druid数据库连接池的实现，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧2021-04-04
QueryWrapper是用于查询的Wrapper条件构造器,可以通过它来构建SELECT语句中的WHERE条件,这篇文章主要介绍了MyBatis-Plus数据表操作条件构造器Wrapper,需要的朋友可以参考下2023-09-09
这篇文章主要介绍了Java中的Semaphore信号量使用解析,Semaphore 通常我们叫它信号量,可以用来控制同时访问特定资源的线程数量,通过协调各个线程,以保证合理的使用资源,需要的朋友可以参考下2023-11-11
springboot实现jar运行复制resources文件到指定的目录(思路详解)
这篇文章主要介绍了springboot实现jar运行复制resources文件到指定的目录,本文给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下2023-04-04
这篇文章主要介绍了Spring中的@PostConstruct注解使用详解,该注解被用来修饰一个非静态的void方法,被@PostConstruct修饰的方法会在服务器加载Servlet的时候运行,并且只会被服务器执行一次,需要的朋友可以参考下2023-10-10
本文主要介绍了SpringSpring简介和入门知识。具有一定的参考价值，下面跟着小编一起来看下吧2017-01-01
这篇文章主要为大家详细介绍了Springboot jar包远程调试，具有一定的参考价值，感兴趣的小伙伴们可以参考一下2019-09-09
本篇文章主要介绍了Spring+MyBatis实现数据读写分离的实例代码，具有一定的参考价值，感兴趣的小伙伴们可以参考一下2017-07-07
这篇文章主要为大家介绍了Java8到Java19的一些变化分析详解，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪2023-01-01
最新评论