欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页

Spring Boot【】application文件自定义配置添加提示功能

程序员文章站 2022-05-01 11:29:50
...

前言

在使用@ConfigurationProperties@EnableConfigurationProperties注解通过配置类获取application.yml中的配置时,是没有提示功能的,而且是灰色,使用非常不便。
Spring Boot【】application文件自定义配置添加提示功能
在Spring Boot源码中,大量使用了这些注解进行自动配置,是有提示的,而且可以直接点击配置跳转到对应的配置类中。
Spring Boot【】application文件自定义配置添加提示功能
在源码中,META-INF文件夹下,有个additional-spring-configuration-metadata.json文件,翻译过来是spring配置元数据Json文件,正是这个文件实现了配置提示功能,那么我们只要也生成一个这样的文件,在YML配置文件中就可以实现提示功能了。
Spring Boot【】application文件自定义配置添加提示功能

实现步骤

  1. 引入配置生成依赖包
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-configuration-processor</artifactId>
        </dependency>
  1. 添加自定义配置类
@ConfigurationProperties(prefix = "spring.my")
@Data
public class MyConfig {

    String ip;
    Integer port;
}

@Configuration
@EnableConfigurationProperties(MyConfig.class)
public class Config {
}
  1. 执行编译,就生成配置提示的文件了
    Spring Boot【】application文件自定义配置添加提示功能

  2. 将此文件移到项目中
    Spring Boot【】application文件自定义配置添加提示功能

  3. 添加配置,发现可以自动提示了
    Spring Boot【】application文件自定义配置添加提示功能