【3】@ConfigurationProperties注入属性

@ConfigurationProperties注入属性

01、概述

获取到了自定义属性还是官方的属性，都通过==@Value(“${key}”)==来获取。除了这种方式外，springboot还提供一种 @ConfigurationProperties 属性注入的机制。这也是如下配置的原理

# 环境激活
spring:
  profiles:
    active: dev

02、分析

@Value(“${key}”) 存在的问题：不具有面向对象的特征。比如：

#自定义属性
ksd:
  weixin:
    appid: 456453sdfsd52342
    mcid: 48878787
    callbackurl: https://www.kuangstudy.com/pay/callback
    apisecret: SDFLKSDJFKLSJKLJ23423423

@ConfigurationProperties ：它就是一种具有面向对象特种的属性注入的方式，如何做到呢？如下：

02-01、定义一个属性配置类，如下：

@ConfigurationProperties(prefix ="ksd.weixin")
public class WeixinPayProperties {
    // appid
    private String appid;
    // 商户号
    private String mcid;
    // 回调地址
    private String callbackurl;
    // api私钥
    private String apisecret;


    public String getAppid() {
        return appid;
    }

    public void setAppid(String appid) {
        this.appid = appid;
    }

    public String getMcid() {
        return mcid;
    }

    public void setMcid(String mcid) {
        this.mcid = mcid;
    }

    public String getCallbackurl() {
        return callbackurl;
    }

    public void setCallbackurl(String callbackurl) {
        this.callbackurl = callbackurl;
    }

    public String getApisecret() {
        return apisecret;
    }

    public void setApisecret(String apisecret) {
        this.apisecret = apisecret;
    }
}

02-02、注册配置类到springboot中

怎么样springboot去加载这个属性配置类以及如何去完成属性注入呢？如下“

@EnableConfigurationProperties(WeixinPayProperties.class)
@Configuration

@ConfigurationProperties(prefix ="ksd.weixin")
@EnableConfigurationProperties(WeixinPayProperties.class)
@Configuration
public class WeixinPayProperties {

    // appid
    private String appid;
    // 商户号
    private String mcid;
    // 回调地址
    private String callbackurl;
    // api私钥
    private String apisecret;


    public String getAppid() {
        return appid;
    }

    public void setAppid(String appid) {
        this.appid = appid;
    }

    public String getMcid() {
        return mcid;
    }

    public void setMcid(String mcid) {
        this.mcid = mcid;
    }

    public String getCallbackurl() {
        return callbackurl;
    }

    public void setCallbackurl(String callbackurl) {
        this.callbackurl = callbackurl;
    }

    public String getApisecret() {
        return apisecret;
    }

    public void setApisecret(String apisecret) {
        this.apisecret = apisecret;
    }
}

02-03、如何属性配置类呢？

@Service
public class WeixinPayService {

    @Autowired
    private WeixinPayProperties weixinPayProperties;

    public void testvalue2() {
        System.out.println(weixinPayProperties.getAppid());
        System.out.println(weixinPayProperties.getApisecret());
        System.out.println(weixinPayProperties.getMcid());
        System.out.println(weixinPayProperties.getCallbackurl());
    }
}

02-04、打印的结果如下

02-05、怎么选择@Value和 @ConfigurationProperties呢？

首先我们作为一个开发者，因为不要纠结到底使用哪种好哪种坏，因为两者实现和最终的目的：都是一样的。

1、在开发中如果你属性很少的情况你可以考虑使用@Value

2、如果你的自定义属性的属性过多或者相关性很强的话，建议大家使用 @ConfigurationProperties

03、关于自定义属性配置类的自动提示的问题？

这个警告是告诉，springboot确实可以去帮你完成属性和配置文件中的属性自动注入的问题？但是不能在配置文件中自动提示，比如：

#自定义属性
ksd:
  weixin:
    appid: 456453sdfsd52342
    mcid: 48878787
    callbackurl: https://www.kuangstudy.com/pay/callback
    apisecret: SDFLKSDJFKLSJKLJ23423423

03-01、如何去解决这个自动提示和警告的问题

参考官网：https://docs.spring.io/spring-boot/docs/2.4.7/reference/html/appendix-configuration-metadata.html#configuration-metadata-annotation-processor

03-01-01、在项目的pom.xml中配置如下：

  <!--把项目中的springboot自定义属性配置类生成一个元素数据文件，这个文件可以生成以后
  在未来的配置文件中，我们就达到和官方一致效果，可以自动提示-->
  <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-configuration-processor</artifactId>
      <optional>true</optional>
  </dependency>

03-01-02、记住一定要重新编译工程(核心步骤)：

注意：一定要把项目打开的配置文件全部关闭。

然后重新编译项目

手动编译：

mvn clean compile

用工具编译

在重新打开application.yml 就可以看见自动提示的效果。