【Spring Boot】Spring Boot之使用 Spring Boot Configuration Processor 完成設置自定義項目屬性自動補全

一、引入Maven坐標

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

二、定義自定義屬性

/**
 * @author zhangboqing
 * @date 2019-11-20
 */
@Component
@ConfigurationProperties(prefix = "my.custom.property")
public class MyCustomProperties {

    private String name;

    private String username;

    private String age;

    @DeprecatedConfigurationProperty(reason = "換名稱了",replacement = "username")
    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getUsername() {
        return username;
    }

    public void setUsername(String username) {
        this.username = username;
    }

    public String getAge() {
        return age;
    }

    public void setAge(String age) {
        this.age = age;
    }
}

三、重新 compile 編譯項目之后，configuration processor 會為我們創建一個 JSON 文件:spring-configuration-metadata.json

 

 

 四、然后當我們在 application.properties 和 application.yml 中寫配置的時候就會有自動提醒了

 

 

注意：只有先編譯后生成spring-configuration-metadata.json文件后，提示功能才生效