快捷導(dǎo)航

詳解SpringBoot讀取Yml配置文件的3種方法

更新時(shí)間：2023年04月03日 09:13:31 作者：zlfjavahome

本文主要介紹了詳解SpringBoot讀取Yml配置文件的3種方法，文中通過(guò)示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧

簡(jiǎn)述：

項(xiàng)目開(kāi)發(fā)中難免要讀取配置文件，本文結(jié)合開(kāi)發(fā)經(jīng)驗(yàn)介紹幾種使用過(guò)的讀取配置文件的方法。

1.基礎(chǔ)用法，使用注解@Autowired注入Environment類(lèi)

這種方式比較常見(jiàn)，就像注入service或者dao一樣，聲明一個(gè)Environment類(lèi)變量，加上@Autowire注解。如下：

import org.springframework.core.env.Environment;
 
@Autowired
private Environment environment;

使用方法就是通過(guò)getProperty(key)方法讀取配置文件中的信息，代碼如下：

1).Yml中的配置

heycloud:
  jobInfo: http://www.baidu.com

2).獲取配置

//獲取url(注意:key一定要寫(xiě)完整，有幾層就寫(xiě)幾層，每層的名字用點(diǎn)分隔。)
String resultUrl = environment.getProperty("heycloud.jobInfo");

注：該方式讀取配置信息有一定的局限性，包括如下：

局限1：

如果要在靜態(tài)方法中讀取配置信息，不能簡(jiǎn)單的將Environment定義成static就完了，由于注入機(jī)制，注入一個(gè)靜態(tài)的bean只會(huì)得到一個(gè)空的bean，即變量的值為null，一旦使用該bean對(duì)象就會(huì)報(bào)空指針異常。

錯(cuò)誤寫(xiě)法：

@Autowired
    private static Environment environment;//這是錯(cuò)誤寫(xiě)法，environment只會(huì)是null
    public void test(){
        //獲取url
        String resultUrl = environment.getProperty("heycloud.jobInfo");//一旦使用environment變量就會(huì)報(bào)空指針異常    
    }

正確寫(xiě)法：

1.將Environment定義成static；

2.加上environment的getter/setter方；

3.將@Autowire注解加到set方法上。

這樣就可以有效注入了，值得注意的是，只需要get方法是靜態(tài)的即可，set方法不要靜態(tài)，否則得到的environment還是null。

正確代碼如下：

    private static Environment environment;
 
    @Autowired
    public void setEnvironment(Environment environment) {
        this.environment = environment;
    }
 
    public static Environment getEnvironment() {
        return environment;
    }

局限2：

Environment 無(wú)法直接讀取自定義的Yml配置文件，需要通過(guò)增加一個(gè)配置類(lèi)，將自定義的Yml文件暴露到spring environment中。

解決方法：

定義一個(gè)配置類(lèi)，將自定義的Yml文件內(nèi)容加載到Environment中，代碼如下：

import org.springframework.beans.factory.config.YamlPropertiesFactoryBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.support.PropertySourcesPlaceholderConfigurer;
import org.springframework.core.io.ClassPathResource;
import org.springframework.stereotype.Component;
 
/**
 * 配置類(lèi)
 * @Description 讀取自定義Yml格式配置文件
 * @Date 2021/3/15 10:40
 * @Created by LSH
 */
@Component
public class SqlConfig {
    @Bean
    public PropertySourcesPlaceholderConfigurer getSqlConfigurer() {
        PropertySourcesPlaceholderConfigurer configurer = new PropertySourcesPlaceholderConfigurer();
        YamlPropertiesFactoryBean sqlConfigBean = new YamlPropertiesFactoryBean();
        sqlConfigBean.setResources(new ClassPathResource("sql-properties.yml"));
        configurer.setProperties(sqlConfigBean.getObject());
        return configurer;
    }
}

寫(xiě)好配置類(lèi)，就可以通過(guò)注解@Autowired注入Environment類(lèi)來(lái)讀取自定義配置信息了。簡(jiǎn)言之，遇到局限2的問(wèn)題，只是需要多寫(xiě)一個(gè)配置類(lèi)而已。

局限3：

由于加載順序的原因，使用注解的方法不適用于在靜態(tài)代碼塊（static{}）中讀取配置，即便用了局限1的解決方法也不行，目前還沒(méi)找出解決方法，歡迎路過(guò)的大佬指點(diǎn)。

其實(shí)也可以在靜態(tài)塊中手寫(xiě)加載類(lèi)通過(guò)讀取Yml文件的路徑去加載配置，但這樣不夠簡(jiǎn)潔，如果多個(gè)類(lèi)都存在這種需求，每個(gè)都要寫(xiě)一堆加載類(lèi)，所以沒(méi)有深究。不過(guò)不止一種方法可以讀取配置文件，沒(méi)必要認(rèn)準(zhǔn)一棵樹(shù)。

2.基礎(chǔ)用法，使用@Value注解直接注入配置信息

使用方法很簡(jiǎn)單，聲明類(lèi)成員屬性，使用@Value注解直接將配置信息放入成員屬性中，格式為：@Value("${xxx.xxx.xxx}")。

代碼如下：

    @Value("${sql.newrest.CAS_GRID}")
    private String CAS_GRID;

注意：

1.同第一個(gè)方法一樣，key要寫(xiě)完整，有幾層就寫(xiě)幾層，每一層用點(diǎn)分開(kāi)。

2.該方法同第一種方法的局限性一樣。

3.進(jìn)階方法

定義一個(gè)工具類(lèi)，使用@Component注解成為配置類(lèi)，再繼承ApplicationRunner 重寫(xiě)run()，再注入Environment 類(lèi)獲取配置，可以做到在任何地方隨時(shí)隨地獲取配置信息。

代碼如下：

1).定義配置類(lèi)，聲明一些靜態(tài)屬性，用于接收配置信息

@Slf4j
@Component
public class BaseConfig implements ApplicationRunner {
    @Autowired
    private Environment environment;
    
    public static String pro1;
    public static String pro2;
    public static String pro3;
  
    @Override
    public void run(ApplicationArguments args){
        pro1=environment.getProperty("pro1");
        pro2=environment.getProperty("pro2");
        pro3=environment.getProperty("pro3");
    }
}

2).使用方法

直接用調(diào)用配置類(lèi)的靜態(tài)屬性即可獲取配置信息，不限于常規(guī)方法，靜態(tài)方法，靜態(tài)代碼塊，其實(shí)相當(dāng)于時(shí)使用一個(gè)配置類(lèi)迂回一下間接獲取配置信息。

到此這篇關(guān)于詳解SpringBoot讀取Yml配置文件的3種方法的文章就介紹到這了,更多相關(guān)SpringBoot讀取Yml配置文件內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: