SpringBoot实现自定义配置属性提示

前言

我们在使用SpringBoot开发项目时，常常需要编写一些属性配置类，用来完成自定义或特定的属性配置。在配置文件application.yml中，IDEA会自动提示官方默认的相关配置且可以点击属性自动跳转到属性对应的配置类中，实现快速查看属性的描述信息，但是我们自己编写的属性配置却不会自动提示。本文介绍如何实现自定义配置文件的属性提示。

解决方案

① 引入依赖

<!--生成自定义配置的元数据信息-->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-configuration-processor</artifactId>
    <optional>true</optional>
</dependency>

该组件可以实现将我们自己的配置文件识别为SpringBoot的配置文件。
② 重新编译
执行一下maven的重新编译命令：mvn clean compile，或者如下，直接使用idea自带的maven工具，重新编译一下代码即可生效。

③ 配置验证
1）配置类如下：

@Component
@ConfigurationProperties(prefix = UmcHttpConfig.UMC_HTTP_PREFIX)
public class UmcHttpConfig {

    public static final String UMC_HTTP_PREFIX = "umc.http";

    private long readTimeoutInSeconds = 60;
    private long writeTimeoutInSeconds = 60;
    private long connectTimeoutInSeconds = 60;

    // setter & getter
}

2）配置SpringBoot配置注解处理器

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

3）打开配置文件application.yml，配置自定义属性，idea会自动提示我们相关的属性配置：