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

Spring Boot自定义配置实现IDE自动提示_第1张图片

一、背景

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

Spring Boot自定义配置实现IDE自动提示_第2张图片

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

 

二、提示原理

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

 

三、实现自动提示

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

Spring Boot自定义配置实现IDE自动提示_第3张图片

 

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自动提示_第4张图片

 

3.3. 重新编译项目

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

file

 

四、测试

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

Spring Boot自定义配置实现IDE自动提示_第5张图片

 

参考资料

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

 

推荐阅读

  • 日志排查问题困难?分布式日志链路跟踪来帮你
  • zuul集成Sentinel最新的网关流控组件
  • 阿里注册中心Nacos生产部署方案

 

Spring Boot自定义配置实现IDE自动提示_第6张图片

你可能感兴趣的:(分布式)