全站資源開放下載,感謝廣大網友的支持
鏈接失效請移步職業司平臺
非盈利平臺

非盈利平臺

只為分享一些優質內容

Java幫幫-微信公眾號

Java幫幫-微信公眾號

將分享做到極致

微信小程序

微信小程序

更方便的閱讀

職業司微信公眾號

職業司微信公眾號

實時動態通知

安卓APP

安卓APP

我們從此不分開

程序員生活志-公眾號

程序員生活志-公眾號

程序員生活學習圈,互聯網八卦黑料

支付寶贊助-Java幫幫社區
微信贊助-Java幫幫社區

Spring Boot讀取配置文件的幾種方式【云圖智聯】

5
發表時間:2020-07-14 09:18

Spring Boot獲取文件總的來說有三種方式,分別是@Value注解,@ConfigurationProperties注解和Environment接口。這三種注解可以配合著@PropertySource來使用,@PropertySource主要是用來指定具體的配置文件。

@PropertySource解析

@Target(ElementType.TYPE)@Retention(RetentionPolicy.RUNTIME)@Documented@Repeatable(PropertySources.class)public @interface PropertySource {        String name() default "";    String[] value();    boolean ignoreResourceNotFound() default false;    String encoding() default "";    Class<? extends PropertySourceFactory> factory() default PropertySourceFactory.class;}
  • value():指定配置文件

  • encoding():指定編碼,因為properties文件的編碼默認是ios8859-1,讀取出來是亂碼

  • factory():自定義解析文件類型,因為該注解默認只會加載properties文件,如果想要指定yml等其他格式的文件需要自定義實現。

一、@Value注解讀取文件

新建兩個配置文件config.properties和configs.properties,分別寫入如下內容:

zhbin.config.web-configs.name=Java旅途zhbin.config.web-configs.age=22
zhbin.config.web-configs.name=Java旅途zhbin.config.web-configs.age=18

新增一個類用來讀取配置文件

@Configuration@PropertySource(value = {"classpath:config.properties"},encoding="gbk")public class GetProperties {    @Value("${zhbin.config.web-configs.name}")    private String name;    @Value("${zhbin.config.web-configs.age}")    private String age;    public String getConfig() {        return name+"-----"+age;    }}

如果想要讀取yml文件,則我們需要重寫DefaultPropertySourceFactory,讓其加載yml文件,然后在注解

@PropertySource上自定factory。代碼如下:

public class YmlConfigFactory extends DefaultPropertySourceFactory {    @Override    public PropertySource<?> createPropertySource(String name, EncodedResource resource) throws IOException {        String sourceName = name != null ? name : resource.getResource().getFilename();        if (!resource.getResource().exists()) {            return new PropertiesPropertySource(sourceName, new Properties());        } else if (sourceName.endsWith(".yml") || sourceName.endsWith(".yaml")) {            Properties propertiesFromYaml = loadYml(resource);            return new PropertiesPropertySource(sourceName, propertiesFromYaml);        } else {            return super.createPropertySource(name, resource);        }    }    private Properties loadYml(EncodedResource resource) throws IOException {        YamlPropertiesFactoryBean factory = new YamlPropertiesFactoryBean();        factory.setResources(resource.getResource());        factory.afterPropertiesSet();        return factory.getObject();    }}
@PropertySource(value = {"classpath:config.properties"},encoding="gbk",factory = YmlConfigFactory.class)

二、Environment讀取文件

配置文件我們繼續用上面的兩個,定義一個類去讀取配置文件

@Configuration@PropertySource(value = {"classpath:config.properties"},encoding="gbk")public class GetProperties {    @Autowired    Environment environment;    public String getEnvConfig(){        String name = environment.getProperty("zhbin.config.web-configs.name");        String age = environment.getProperty("zhbin.config.web-configs.age");        return name+"-----"+age;    }}

三、@ConfigurationProperties讀取配置文件

@ConfigurationProperties可以將配置文件直接映射成一個實體類,然后我們可以直接操作實體類來獲取配置文件相關數據。

新建一個yml文件,當然properties文件也沒問題

zhbin:   config:    web-configs:      name: Java旅途      age: 20

新建實體類用來映射該配置

@Component@ConfigurationProperties(prefix = "zhbin.config")@Datapublic class StudentYml {        // webConfigs務必與配置文件相對應,寫為駝峰命名方式    private WebConfigs webConfigs = new WebConfigs();    @Data    public static class WebConfigs {        private String name;        private String age;    }}
  • prefix = "zhbin.config"用來指定配置文件前綴

如果需要獲取list集合,則做以下修改即可。

zhbin:   config:    web-configs:      - name: Java旅途        age: 20      - name: Java旅途2        age: 202
@Component@ConfigurationProperties(prefix = "zhbin.config")@Datapublic class StudentYml {    private List<WebConfigs> webConfigs = new ArrayList<>();    @Data    public static class WebConfigs {        private String name;        private String age;    }}

經驗與坑

  • properties文件默認使用的是iso8859-1,并且不可修改

  • yml文件的加載順序高于properties,但是讀取配置信息的時候會讀取后加載的

  • @PropertySource注解默認只會加載properties文件

  • @PropertySource注解可以與任何一種方式聯合使用

  • 簡單值推薦使用@Value,復雜對象推薦使用@ConfigurationProperties

免費學習視頻歡迎關注云圖智聯:


Java幫幫學習群生態

Java幫幫學習群生態

總有一款能幫到你

Java學習群

Java學習群

與大牛一起交流

大數據學習群

大數據學習群

在數據中成長

九點編程學習群

九點編程學習群

深夜九點學編程

python學習群

python學習群

人工智能,爬蟲

測試學習群

測試學習群

感受測試的魅力

Java幫幫生態承諾

Java幫幫生態承諾

一直堅守,不負重望

初心
勤儉
誠信
正義
分享
友鏈交換:加幫主QQ2524138991 留言即可 24小時內答復  
業司
教育資訊
會員登錄
獲取驗證碼
登錄
登錄
我的資料
留言
回到頂部