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

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

一、背景

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

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

二、提示原理

IDE是通过读取配置信息的元数据而实现自动提示的，而元数据在目录 META-INF 中的DEvsLbLD spring-configuration-metadata.json 或者 additional-spring-configuration-metadata.json

三、实现自动提示

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

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

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

org.springframework.boot

spring-boot-configuration-processor

true

3.2. 修改IDEA配置

搜索 Annotation Processor 并设置 Enable annotation processing

3.3. 重新编译项目

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

四、测试

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

DEvsLbLD

参考资料

https://docs.spring.io/spring-boot/docs/current/reference/html/configurathttp://ion-metadata.html

总结

以上所述是给大家介绍的Spring Boot自定义配置实现IDE自动提示功能，希望对大家有所帮助，如果大家有任何疑问欢迎给我留言，会及时回复大家的！

版权声明：本文内容由网络用户投稿，版权归原作者所有，本站不拥有其著作权，亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容，请联系我们jiasou666@gmail.com 处理，核实后本网站将在24小时内删除侵权内容。