Application.yml的自定義屬性的讀取方式

更新時(shí)間：2024年08月23日 10:25:02 作者：LC超人在良家

這篇文章主要介紹了Application.yml的自定義屬性的讀取方式,具有很好的參考價(jià)值,希望對(duì)大家有所幫助,如有錯(cuò)誤或未考慮完全的地方,望不吝賜教

Application.yml的自定義屬性的讀取

以前我們會(huì)把一些常量，放在接口中，因?yàn)榻涌谀J(rèn)屬性就是靜態(tài)的，缺省了public static final

注意：既可以讀取自定義的屬性，也可以讀取官方封裝好的屬性。

以前，接口定義常量

public interface WeixinPayConstants { // 接口里面默認(rèn)屬性就是靜態(tài)常量，可以缺深public static fianl

    // APID
    String APPID = "45645xxx2";
    // 商戶號(hào)
    String MCID = "48xxxxx787";
    // 回調(diào)地址
    String CALLBACK_URL = "https://wxxxxxlback";
    // 私key
    String APISECRET = "SDFLKxxxxx23423423";

}

方式1：@Value
方式2：@ConfigurationProperties

spring中在application.yml中管理常量

方式1：@Value

第一步：在application.yml中自定義屬性

# 環(huán)境激活
spring:
  profiles:
    active: dev


#自定義屬性，把上面接口的常量放這，冒號(hào)后面至少要有一個(gè)空格
ksd:
  weixin:
    appid: 456453sdfsd52342
    mcid: 48878787
    callbackurl: https://www.kuangstudy.com/pay/callback
    apiscret: SDFLKSDJFKLSJKLJ23423423

第二步：使用@Value(“${}”)來(lái)注入使用

前提：注入的地方一定要已近交給了IOC容器管理

@Service
public class WeixinPayService {

    @Value("${ksd.weixin.appid}")
    private String appid;
    @Value("${ksd.weixin.mcid}")
    private String mcid;
    @Value("${ksd.weixin.callbackurl}")
    private String callbackurl;
    @Value("${ksd.weixin.apisecret}")
    private String apisecret;


    public void testvalue(){
        System.out.println(appid);
        System.out.println(mcid);
        System.out.println(callbackurl);
        System.out.println(apisecret);
    }
}

方式2：@ConfigurationProperties

這種方式具有面向?qū)ο蟮奶匦?，把屬性注入道屬性類中，而不是上面@Value注入道某一個(gè)屬性中。

第一步：@ConfigurationProperties(prefix =“路徑前綴”)定義一個(gè)配屬性類，且屬性一定要生成getter，setter方法

@ConfigurationProperties(prefix ="ksd.weixin")
public class WeixinPayProperties {
    // appid
    private String appid;
    // 商戶號(hào)
    private String mcid;
    // 回調(diào)地址
    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;
    }
}

第二步：在啟動(dòng)類上或者屬性類上加上注解@EnableConfigurationProperties(WeixinPayProperties.class)

@Configuration

這兩個(gè)注解告訴springboot去加載這個(gè)屬性配置類以及去完成屬性注入

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

第三步：注入.get方法使用

@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());
    }
}

創(chuàng)建屬性類的時(shí)候會(huì)有一個(gè)提示

這個(gè)警告是告訴，springboot確實(shí)可以去幫你完成屬性和配置文件中的屬性自動(dòng)注入，但是不能在配置文件中自動(dòng)提示

解決：

添加依賴

 <!--把項(xiàng)目中的springboot自定義屬性配置類生成一個(gè)元素?cái)?shù)據(jù)文件，這個(gè)文件可以生成以后
  在未來(lái)的配置文件中，我們就達(dá)到和官方一致效果，可以自動(dòng)提示-->
  <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-configuration-processor</artifactId>
      <optional>true</optional>
  </dependency>

然后關(guān)掉配置文件，再重寫(xiě)編譯

手動(dòng)編譯：