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

 更新时间:2019年08月21日 09:18:23   转载 作者:zlt2000  
这篇文章主要介绍了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自动提示功能,希望对大家有所帮助,如果大家有任何疑问欢迎给我留言,小编会及时回复大家的!

相关文章

  • Java 获取Html文本中的img标签下src中的内容方法

    Java 获取Html文本中的img标签下src中的内容方法

    今天小编就为大家分享一篇Java 获取Html文本中的img标签下src中的内容方法,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2018-06-06
  • 详解Mybatis的二级缓存配置

    详解Mybatis的二级缓存配置

    这篇文章主要介绍了Mybatis的二级缓存配置的相关资料,需要的朋友可以参考下
    2017-05-05
  • 详解Spring中的FactoryBean

    详解Spring中的FactoryBean

    本篇文章主要介绍了Spring中的FactoryBean,如果一个bean的创建过程中涉及到很多其他的bean 和复杂的逻辑,用xml配置比较困难,这时可以考虑用FactoryBean
    2017-04-04
  • 利用Kotlin + Spring Boot实现后端开发

    利用Kotlin + Spring Boot实现后端开发

    这篇文章主要给大家介绍了关于利用Kotlin + Spring Boot实现后端开发的相关资料,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2018-11-11
  • 简单了解java自定义和自然排序

    简单了解java自定义和自然排序

    这篇文章主要介绍了简单了解java自定义和自然排序,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2019-07-07
  • Java Calendar类常用示例_动力节点Java学院整理

    Java Calendar类常用示例_动力节点Java学院整理

    从JDK1.1版本开始,在处理日期和时间时,系统推荐使用Calendar类进行实现。接下来通过实例代码给大家详细介绍Java Calendar类相关知识,需要的朋友参考下吧
    2017-04-04
  • java两种单例模式用法分析

    java两种单例模式用法分析

    这篇文章主要介绍了java两种单例模式用法,结合实例形式对比分析了java实现单例模式的两种常见技巧,需要的朋友可以参考下
    2016-08-08
  • Spring中WebDataBinder使用详解

    Spring中WebDataBinder使用详解

    这篇文章主要为大家详细介绍了Spring中WebDataBinder的使用,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2017-07-07
  • 通过dom4j解析xml字符串(示例代码)

    通过dom4j解析xml字符串(示例代码)

    本篇文章主要是对通过dom4j解析xml字符串的示例代码进行了介绍,需要的朋友可以过来参考下,希望对大家有所帮助
    2013-12-12
  • Java等待唤醒机制原理实例解析

    Java等待唤醒机制原理实例解析

    这篇文章主要介绍了Java等待唤醒机制原理实例解析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-01-01

最新评论