一、背景

官方提供的spring boot starter的配置项,我们用IDE配置的时候一般都有自动提示的,如下图所示
file
而我们自己自定义的配置却没有,对开发非常不友好容易打错配置,那这个是怎样实现的呢?

二、提示原理

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

三、实现自动提示

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

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

zlt-swagger2-spring-boot-starter工程中添加以下jar包

1
2
3
4
5
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-configuration-processor</artifactId>
<optional>true</optional>
</dependency>

3.2. 修改IDEA配置

搜索Annotation Processor并设置Enable annotation processing
file

3.3. 重新编译项目

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

四、测试

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

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


评论




博客内容遵循 署名-非商业性使用-相同方式共享 4.0 国际 (CC BY-NC-SA 4.0) 协议

载入天数...载入时分秒... | 总访问量为