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

1、背景

官方提供的spring boot starter的配置项，咱们用IDE配置的时候通常都有自动提示的，以下图所示

而咱们本身自定义的配置却没有，对开发很是不友好容易打错配置，那这个是怎样实现的呢？

 

2、提示原理

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

 

3、实现自动提示

以我这个本身开发的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文件

 

4、测试

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

 
参考资料
https://docs.spring.io/spring-boot/docs/current/reference/html/configuration-metadata.html

 
推荐阅读

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