转载

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

一、背景

官方提供的spring boot starter的配置项，我们用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包

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-configuration-processor</artifactId>
    <optional>true</optional>
</dependency>

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自动提示

一、背景

二、提示原理

三、实现自动提示

3.1. 引入依赖spring-boot-configuration-processor

3.2. 修改IDEA配置

3.3. 重新编译项目

四、测试

热门推荐

相关文章

说给你听

本文目录

随机标签

书籍教程

近期评论

网站信息

其他链接

关于本站

问题交流