全站资源开放下载,感谢广大网友的支持
链接失效请移步职涯宝平台的学习路线|资源下载分类
支持用户留言评论_客服实时在线_问题解决更快
非盈利平台

非盈利平台

只为分享一些优质内容

Java帮帮-微信公众号

Java帮帮-微信公众号

将分享做到极致

微信小程序

微信小程序

更方便的阅读

百度小程序

百度小程序

搜索便捷阅读

支付宝小程序

支付宝小程序

支付也能阅读

程序员生活志-公众号

程序员生活志-公众号

程序员生活学习圈,互联网八卦黑料

支付宝赞助-Java帮帮社区
微信赞助-Java帮帮社区

Spring Boot读取配置文件的几种方式【云图智联】

3
发表时间: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

免费学习视频欢迎关注云图智联:https://e.yuntuzhilian.com/


Java帮帮学习群生态

Java帮帮学习群生态

总有一款能帮到你

Java学习群

Java学习群

与大牛一起交流

大数据学习群

大数据学习群

在数据中成长

九点编程学习群

九点编程学习群

深夜九点学编程

python学习群

python学习群

人工智能,爬虫

测试学习群

测试学习群

感受测试的魅力

Java帮帮生态承诺

Java帮帮生态承诺

一直坚守,不负重望

初心
勤俭
诚信
正义
分享
友链交换:加帮主QQ2524138991 留言即可 24小时内答复  
满吉教育资讯
会员登录
获取验证码
登录
登录
我的资料
留言
回到顶部