如何通过Spring Boot自定义配置实现集成开发环境（IDE）自动提示功能？

本文共计674个文字，预计阅读时间需要3分钟。

一、背景及官方提供的Spring Boot Starter配置项在配置Spring Boot项目时，IDE通常会自动提示官方提供的Spring Boot Starter的配置项，如图所示。而我们所自定义的配置项则没有自动提示，这对开发来说非非常不便，容易出错。

二、如何自定义配置项为了解决自定义配置项没有自动提示的问题，我们可以采取以下方法：

1. 在IDE中创建自定义配置类，例如`MyConfig.java`，并使用`@Configuration`注解标记该类。

2. 在自定义配置类中，使用`@Bean`注解定义配置项，如下所示：

java@Configurationpublic class MyConfig {

@Bean public SomeBean someBean() { // 配置项的初始化代码 return new SomeBean(); }}

3. 在Spring Boot主类或启动类中，引入自定义配置类：

java@SpringBootApplicationpublic class Application {

public static void main(String[] args) { SpringApplication.run(Application.class, args); }

@Bean public MyConfig myConfig() { return new MyConfig(); }}

这样，在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配置已经能自动提示了

参考资料

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

总结

以上所述是小编给大家介绍的Spring Boot自定义配置实现IDE自动提示功能，希望对大家有所帮助，如果大家有任何疑问欢迎给我留言，小编会及时回复大家的！