SpringBoot讀取Yml設定檔的方法有哪些

1.基礎用法，使用註解@Autowired注入Environment類別

這種方式比較常見，就像注入service或dao一樣，宣告一個Environment類別變量，加上@Autowire註解。如下：

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

使用方法就是透過getProperty(key)方法讀取設定檔中的信息，程式碼如下：

1).Yml中的設定

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

2 ).取得配置

//获取url(注意:key一定要写完整，有几层就写几层，每层的名字用点分隔。)
String resultUrl = environment.getProperty("heycloud.jobInfo");

註：該方式讀取組態資訊有一定的局限性，包括如下：

限制1：

如果要在靜態方法中讀取組態訊息，不能簡單的將Environment定義成static就完了，由於注入機制，注入一個靜態的bean只會得到一個空的bean，即變數的值為null，一旦使用該bean物件就會報空指標異常。

錯誤寫法：

@Autowired
    private static Environment environment;//这是错误写法，environment只会是null
    public void test(){
        //获取url
        String resultUrl = environment.getProperty("heycloud.jobInfo");//一旦使用environment变量就会报空指针异常    
    }

正確寫法：

1.將Environment定義成static;

2.加上environment的getter/setter；

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

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

正確程式碼如下：

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

局限2：

Environment 無法直接讀取自訂的Yml設定文件，需要透過增加一個設定類，將自訂的Yml文件暴露到spring environment。

解決方法：

定義一個配置類，將自訂的Yml檔案內容載入到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;
 
/**
 * 配置类
 * @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;
    }
}

一旦設定好配置類，就能夠利用註解@Autowired來注入Environment類，從而取得自訂設定資訊。簡言之，遇到侷限2的問題，只是需要多寫一個配置類別而已。

限制3：

由於載入順序的原因，使用註解的方法不適用於在靜態程式碼區塊（static{}）中讀取配置，即便用了限制1的解決方法也不行，目前還沒找出解決方法，歡迎路過的大佬指點。

其實也可以在靜態區塊中手寫載入類別透過讀取Yml檔案的路徑去載入配置，但這樣不夠簡潔，如果多個類別都存在這種需求，每個都要寫一堆加載類，所以沒有深究。不過不只一種方法可以讀取設定文件，沒必要認準一棵樹。

2.基礎用法，使用@Value註解直接注入設定資訊

使用方法很簡單，宣告類別成員屬性，使用@Value註解直接將設定資訊放入成員屬性中，格式為：@Value("${xxx.xxx.xxx}")。

程式碼如下：

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

注意：

1.同第一個方法一樣，key要寫完整，有幾層就寫幾層，每一層用點分開。

2.此方法同第一種方法的限制一樣。

3.進階方法

定義一個工具類，使用@Component註解成為配置類，再繼承ApplicationRunner 重寫run()，再注入Environment 類別取得配置，可以做到在任何地方隨時隨地取得配置資訊。

程式碼如下：

1).定義配置類，宣告一些靜態屬性，用於接收設定資訊

@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).使用方法

直接用呼叫配置類別的靜態屬性即可取得配置訊息，不限於常規方法，靜態方法，靜態程式碼區塊，其實相當於時使用一個配置類別迂迴間接取得配置資訊。

以上是SpringBoot讀取Yml設定檔的方法有哪些的詳細內容。更多資訊請關注PHP中文網其他相關文章！