Java如何使用ConfigurationProperties獲取yml中的配置

更新時(shí)間：2022年02月17日 09:46:43 作者：風(fēng)雪留客

這篇文章主要介紹了Java如何使用ConfigurationProperties獲取yml中的配置，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教

使用ConfigurationProperties獲取yml的配置

我們在開發(fā)過程中，會(huì)經(jīng)常遇到需要自定義配置的場景，比如配置一個(gè)ip，一個(gè)地址等，并將其寫入到y(tǒng)ml文件中，在項(xiàng)目中使用@Value("${xxxx.xxxx}")來獲取自定義的配置，其實(shí)是這樣是有些笨重的，每定義一個(gè)配置，都需要寫一個(gè)@Value來獲取，那為啥不使用一個(gè)java config來統(tǒng)一獲取配置呢？

使用方法

編寫yml配置文件

user:
  config:
    # user_name user-name userName這三種配置方式都可以被識(shí)別到
    user_name: "zhangsan"
    age: "20"
    exmail: "123@123.com"
    address: "火星"

編寫Java config類

// 需要重寫get與set方法,此處使用lombok注解來代替
@Data
// 實(shí)例化到spring容器中
@Component
// 獲取前綴為user.config的配置信息,與該類下的屬性對(duì)比,進(jìn)行綁定
@ConfigurationProperties(prefix = "user.config")
public class UserConfig {
    private String userName;
    private String age;
    private String exmail;
    private String address;
}

在需要使用的地方注入

    @Resource
    private UserConfig userConfig;

測試

@ConfigurationProperties獲取不到配置文件屬性值問題

application.yml

配置類

@Component
@ConfigurationProperties(prefix = "system")
public class SystemConfig {
    /**
     * 項(xiàng)目名稱
     */
    private static String name;
    /**
     * 版本
     */
    private String version;
    /**
     * 版權(quán)年份
     */
    private String copyrightYear;
    /**
     * 實(shí)例演示開關(guān)
     */
    private boolean demoEnabled;
    /**
     * windows環(huán)境下,文件上傳路徑(本地上傳)
     */
    private static String winUploadPath;
    /**
     * 其他系統(tǒng)環(huán)境(linux、Mac...)環(huán)境下,文件上傳路徑(本地上傳)
     */
    private static String otherUploadPath;
    /**
     * 獲取地址開關(guān)
     */
    private static boolean addressEnabled;
    public static String getName() {
        return name;
    }
    public void setName(String name) {
        SystemConfig.name = name;
    }
    public String getVersion() {
        return version;
    }
    public void setVersion(String version) {
        this.version = version;
    }
    public String getCopyrightYear() {
        return copyrightYear;
    }
    public void setCopyrightYear(String copyrightYear) {
        this.copyrightYear = copyrightYear;
    }
    public boolean isDemoEnabled() {
        return demoEnabled;
    }
    public void setDemoEnabled(boolean demoEnabled) {
        this.demoEnabled = demoEnabled;
    }
    public static String getWinUploadPath() {
        return winUploadPath;
    }
    public static void setWinUploadPath(String winUploadPath) {
        SystemConfig.winUploadPath = winUploadPath;
    }
    public static String getOtherUploadPath() {
        return otherUploadPath;
    }
    public static void setOtherUploadPath(String otherUploadPath) {
        SystemConfig.otherUploadPath = otherUploadPath;
    }
    public static boolean isAddressEnabled() {
        return addressEnabled;
    }
    public void setAddressEnabled(boolean addressEnabled) {
        SystemConfig.addressEnabled = addressEnabled;
    }
    /**
     * 判斷當(dāng)前操作系統(tǒng)，返回相應(yīng)的本地上傳路徑
     *
     * @return String
     * @author Liangyixiang
     * @date 2021/11/15
     **/
    public static String getUploadPath() {
        OsInfo osInfo = SystemUtil.getOsInfo();
        // 判斷系統(tǒng)環(huán)境獲取上傳路徑
        if(ObjectUtils.isNotEmpty(osInfo) && osInfo.isWindows()){
            return getWinUploadPath();
        }else{
            return getOtherUploadPath();
        }
    }
    /**
     * 獲取業(yè)務(wù)系統(tǒng)名稱
     */
    public static String getSystemName() {
        return getName();
    }
}

name、addressEnabled 以及 winUploadPath、otherUploadPath 都是靜態(tài)的成員變量，但是他們name、addressEnabled能獲取到配置文件的值，winUploadPath、otherUploadPath不可以。