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

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

创新互联建站坚持“要么做到,要么别承诺”的工作理念,服务领域包括:网站制作、成都网站制作、企业官网、英文网站、手机端网站、网站推广等服务,满足客户于互联网时代的抚远网站设计、移动媒体设计的需求,帮助企业找到有效的互联网解决方案。努力成为您成熟可靠的网络建设合作伙伴!

一、背景

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

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

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

二、提示原理

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

三、实现自动提示

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

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

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


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

3.3. 重新编译项目

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

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

四、测试

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

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

参考资料

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

总结

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


网站题目:SpringBoot自定义配置实现IDE自动提示功能
文章转载:http://myzitong.com/article/jdohgc.html