springboot如何使得自定义的配置application.yml或application.properties有提示

当我们在配置一下自定义的属性时，IDEA总会有如下提示：

讨厌的提示

这是因为IDEA不认识这个开发者自己“瞎编”的自定义配置项，那到底有没有什么办法可以消除这个提示呢？或者从本质上解决——让IDEA认可我们“瞎编”的配置项呢？

答案当然是有的，强迫症患者的福音来了！

1. 引入依赖

    org.springframework.boot
    spring-boot-configuration-processor
    true

2. 配置文件

（1） 在配置类上添加注解ConfigurationProperties和前缀prefix。
（2） 给配置类添加属性，并且添加getter和setter方法。

下面举例说明

@Getter  // 使用了lombok添加getter方法
@Setter  // 使用lombok框架添加setter方法
@Configuration  //这个注解表明这个是一个配置类
@EnableSwagger2  //这个注解是Swagger2的注解，与本例无关
@ConfigurationProperties(prefix = "swagger")
public class SwaggerConfig {
    private boolean enabled;  //将会自动从application.yml中读取swaager.enabled的值
    ... // 其他内容省略
}

注：这种写法和@Value有相同的效果。虽然看似麻烦，但是会有意想不到的好处，请往下看。

3. 配置项代码补全提示

当完成上面的步骤后，写配置文件（application.yml或application.properties）时，就会出现自动补全提示了。妈妈再也不担心我敲错单词了呢~

输入swagger时，将会出现自动补全提示，非常方便，非常银杏。

自动补全提示

4.其他问题

当添加了注解@ConfigurationProperties后，IDEA会有一段提示：Re-run Spring Boot Configuration Annotation Processor to update generated metadata。

这是在提示你重新编译后，会在target/classes/META-INF目录下自动生成一个spring-configuration-metadata.json的文件，通过这个文件IDEA才能知道如何提示配置的自动补全。

如果不想看这个提示，直接点后面的Hide notification即可，或者到设置（Setting - Languages&Frameworks - Spring - Spring Boot - Show notification panel）中关闭。

讨厌的提示