從配置文件中獲取屬性應該是SpringBoot開發中最為常用的功能之一，但就是這麼常用的功能，仍然有很多開發者抓狂～今天帶大家簡單回顧一下這六種的使用方式：

一、Environment

註入Environment類調用其方法getProperty(屬性key)即可

@Slf4j
@SpringBootTest
public class EnvironmentTest {

    @Resource
    private Environment env;

    @Test
    public void var1Test() {
        String var1 = env.getProperty("env.var1");
        log.info("Environment獲取的配置內容：{}", var1);
    }
}

二、@Value 註解

只要在變數上加註解 @Value("${env.var1}")就可以了，@Value 註解會自動將配置文件中的env.var1屬性值註入到var1欄位中。

@Slf4j
@SpringBootTest
public class EnvVariablesTest {

    @Value("${env.var1}")
    private String var1;
    
    @Test
    public void var1Test(){
        log.info("配置文件屬性: {}",var1);
    }
}

三、@ConfigurationProperties 註解

在 application.yml 配置文件中添加配置項：

env:
  var1: 變數值1
  var2: 變數值2

創建一個 MyConf 類用於承載所有首碼為env的配置屬性。

@Data
@Configuration
@ConfigurationProperties(prefix = "env")
public class MyConf {

    private String var1;
    
    private String var2;
}

在需要使用var1、var2屬性值的地方，將 MyConf 對象註入到依賴對象中即可。

@Slf4j
@SpringBootTest
public class ConfTest {

    @Resource
    private MyConf myConf;

    @Test
    public void myConfTest() {
        log.info("@ConfigurationProperties註解獲取的配置內容：{}", JSON.toJSONString(myConf));
    }
}

四、@PropertySources 註解

在 src/main/resources/ 目錄下創建自定義配置文件 important.properties，增加兩個屬性。

env.var1=變數值1
env.var2=變數值2

在需要使用自定義配置文件的類上添加 @PropertySources 註解，註解 value屬性中指定自定義配置文件的路徑，可以指定多個路徑，用逗號隔開。

@Data
@Configuration
@PropertySources({
        @PropertySource(value = "classpath:important.properties", encoding = "utf-8"),
        @PropertySource(value = "classpath:important.properties",encoding = "utf-8")
})
public class PropertySourcesConf {

    @Value("${env.var1}")
    private String var1;

    @Value("${env.var2}")
    private String var2;
}

五、YamlPropertiesFactoryBean 載入 YAML 文件

@Configuration
public class MyYamlConfig {

    @Bean
    public static PropertySourcesPlaceholderConfigurer yamlConfigurer() {
        PropertySourcesPlaceholderConfigurer configurer = new PropertySourcesPlaceholderConfigurer();
        YamlPropertiesFactoryBean yaml = new YamlPropertiesFactoryBean();
        yaml.setResources(new ClassPathResource("test.yml"));
        configurer.setProperties(Objects.requireNonNull(yaml.getObject()));
        return configurer;
    }
}

可以通過 @Value 註解或 Environment.getProperty() 方法來獲取其中定義的屬性值。

@Slf4j
@SpringBootTest
public class YamlTest {

    @Value("${env.var3}")
    private String var3;

    @Test
    public void  myYamlTest() {
        log.info("Yaml獲取配置內容：{}", var3);
    }
}

六、JAVA原生讀取

@Slf4j
@SpringBootTest
public class CustomTest {

    @Test
    public void customTest() {
        Properties props = new Properties();
        try {
            InputStreamReader inputStreamReader = new InputStreamReader(
                    this.getClass().getClassLoader().getResourceAsStream("test.properties"),
                    StandardCharsets.UTF_8);
            props.load(inputStreamReader);
        } catch (IOException e1) {
            System.out.println(e1);
        }
        log.info("Properties Name：" + props.getProperty("env.appName"));
    }
}

作者：京東零售 馬巨集偉

來源：京東雲開發者社區 轉載請註明來源