脚本之家 服务器常用软件
快捷导航
您的位置：首页 → 软件编程 → java → Spring Boot自定义配置实现IDE自动提示

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中注解@JsonFormat与@DateTimeFormat的使用

    Java中注解@JsonFormat与@DateTimeFormat的使用

    从数据库获取时间传到前端进行展示的时候,我们有时候可能无法得到一个满意的时间格式的时间日期,本文主要介绍了Java中注解@JsonFormat与@DateTimeFormat的使用,文中通过示例代码介绍的非常详细,需要的朋友们下面随着小编来一起学习学习吧
    2023-08-08
  • springboot 实现记录业务日志和异常业务日志的操作

    springboot 实现记录业务日志和异常业务日志的操作

    这篇文章主要介绍了springboot 实现记录业务日志和异常业务日志的操作，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
    2021-07-07
  • Java设计模式七大原则之里氏替换原则详解

    Java设计模式七大原则之里氏替换原则详解

    在面向对象的程序设计中，里氏替换原则（Liskov Substitution principle）是对子类型的特别定义。本文将为大家详细介绍Java设计模式七大原则之一的里氏替换原则，需要的可以参考一下
    2022-02-02
  • 从汇编码分析java对象的创建过程(推荐)

    从汇编码分析java对象的创建过程(推荐)

    这篇文章主要介绍了从汇编码分析java对象的创建过程,本文给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
    2020-03-03
  • JDBC 程序的常见错误及调试方法

    JDBC 程序的常见错误及调试方法

    本文是《Java Web开发教程——入门与提高篇（JSP+Servlet）》一书《第9章 JDBC技术》的补充内容。
    2009-06-06
  • SpringBoot实现无感刷新Token的项目实践

    SpringBoot实现无感刷新Token的项目实践

    token刷新是前端安全中必要的一部分,本文就来介绍一下SpringBoot实现无感刷新Token的项目实践,具有一定的参考价值,感兴趣的可以了解一下
    2024-03-03
  • Java设计模式中的策略(Strategy)模式解读

    Java设计模式中的策略(Strategy)模式解读

    这篇文章主要介绍了Java设计模式中的策略(Strategy)模式解读,对象的某个行为,在不同场景有不同实现方式,可以将这些行为的具体实现定义为一组策略,每个实现类实现一种策略,在不同场景使用不同的实现,并且可以自由切换策略,需要的朋友可以参考下
    2023-10-10
  • 深入浅出的学习Java ThreadLocal

    深入浅出的学习Java ThreadLocal

    本文会基于实际场景介绍ThreadLocal如何使用以及内部实现机制。 具有很好的参考价值，下面跟着小编一起来看下吧
    2017-02-02
  • 如何使用Spring AOP预处理Controller的参数

    如何使用Spring AOP预处理Controller的参数

    这篇文章主要介绍了如何使用Spring AOP预处理Controller的参数操作，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
    2021-08-08
  • SpringBoot Bean花式注解方法示例下篇

    SpringBoot Bean花式注解方法示例下篇

    这篇文章主要介绍了SpringBoot Bean花式注解方法，很多时候我们需要根据不同的条件在容器中加载不同的Bean，或者根据不同的条件来选择是否在容器中加载某个Bean
    2023-02-02

最新评论