spring-boot-route（二）读取配置文件的几种方式

Spring Boot提供了两种格式的配置文件，分别是properties 和 yml。Spring Boot最大的特点就是自动化配置，如果我们想修改自动化配置的默认值，就可以通过配置文件来指定自己服务器相关的参数。

配置文件集约管理了配置信息，如果把配置参数写到Java代码中，维护起来非常不方便，如果使用配置文件，我们可以统一管理，统一修改。我比较推荐使用yml格式的配置文件，YAML是专门用来写配置文件的语言，通常以yml为后缀，它的结构非常清晰，更易于阅读。

将自定义的配置写在配置文件中后，如果想要在java代码中使用配置，这时候就需要读取配置文件，读取配置文件的方式有三种，我们挨个介绍一下如果进行读取！

第一种：使用@Value注解读取

第一步：在配置文件中增加加入以下配置

config: name: Java旅途 desc: spring-boot-route

第二部：新建Java类读取配置信息

@RestController public class GetValue { @Value("${config.name}") private String name; @Value("${config.desc}") private String desc; @GetMapping("getValue") public String getValue(){ return "name="+name+";desc="+desc; } }

@Value注解使用简单，适合单个参数的注入。

第二种：使用@ConfigurationProperties读取

@ConfigurationProperties与@Value相比，更加适合读取数组类型的参数。

1. 获取单个对象

第一步：在yml文件中新建对象类型的配置信息

configs: config: name: Java旅途 desc: spring-boot-route

第二步：新建实体映射配置信息

@Component @ConfigurationProperties(prefix = "configs.config") @Data public class Config { private String name; private String desc; }

第三步：新建类测试是否获取到参数

@RestController public class GetConfigurationProperties { @Autowired private Config config; @GetMapping("/getConfig") public String getConfig(){ return config.getName()+";"+config.getDesc(); } }

2. 获取对象集合

第一步：在yml文件中新建数组类型的参数

configs: config: - name: Java旅途 desc: spring-boot-route - name: javatrip desc: spring-boot-yml

第二步：新建实体映射配置信息

@Component @ConfigurationProperties(prefix = "configarr") @Data public class Configs { private List<Config> config = new ArrayList<>(); @Data public static class Config{ private String name; private String desc; } }

第三步：新建测试类获取参数

@RestController public class GetConfigurationProperties { @Autowired private Configs configs; @GetMapping("/getConfigs") public String getConfigs(){ String content = ""; List<Configs.Config> configList = configs.getConfig(); Map<String,Object> map = new HashMap<>(); for (Configs.Config bean : configList){ content += bean.getName()+";"+bean.getDesc()+"，"; } return content; } }

除了上面介绍的两种方式之外，还可以通过Spring Boot上下文的环境变量来读取配置文件信息，不过上面两种方式已经完全可以满足所有需求，这里就不再进行介绍了。

思考与扩展

如果多个配置文件具有相同的配置信息，那么如何读取特定的配置文件信息呢？

配置文件具有优先级，一般情况下，yml文件的优先级高于properties，这样就会导致properties的配置信息后加载，最后读取的时候就会properties的配置信息的优先级会更高。

上面介绍的两种读取配置文件的方式可以和另一个注解配合使用，@PropertySource常用的三个属性，一个是value用于指定配置文件，另一个是encoding用于指定编码，最后一个是factory，用于指定解析工厂。

这里需要注意一下：@PropertySource默认只会加载properties格式的文件，也就是我们如果指定了yml类型的文件是不会生效的，这时候就需要我们重写解析工厂。

先看看下默认的解析工厂源码：

public class DefaultPropertySourceFactory implements PropertySourceFactory { public DefaultPropertySourceFactory() { } public PropertySource<?> createPropertySource(@Nullable String name, EncodedResource resource) throws IOException { return name != null ? new ResourcePropertySource(name, resource) : new ResourcePropertySource(resource); } }

自定义解析工厂，实现PropertySourceFactory

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(); } }

第一步：新建两个配置文件，test.yml和test.properties，增加以下配置信息

spring: value: javatrip123 remark: javatrip123 spring: value: javatrip123 remark: javatrip123

第二步：指定配置文件映射配置文件内容

@Data @Configuration @PropertySource(value = {"classpath:test.yml"},encoding = "gbk") @ConfigurationProperties(prefix = "spring") public class Spring { private String value; private String remark; }

第三步：新建类进行测试

@RestController public class GetSource { @Autowired private Spring spring; @GetMapping("get") public String getSource(){ return spring.getRemark()+";"+spring.getValue(); } }

---

本文示例代码已上传至github，点个star支持一下！

Spring Boot系列教程目录

spring-boot-route（一）Controller接收参数的几种方式

spring-boot-route（二）读取配置文件的几种方式

spring-boot-route（三）实现多文件上传

spring-boot-route（四）全局异常处理

spring-boot-route（五）整合swagger生成接口文档

spring-boot-route（六）整合JApiDocs生成接口文档

spring-boot-route（七）整合jdbcTemplate操作数据库

spring-boot-route（八）整合mybatis操作数据库

spring-boot-route（九）整合JPA操作数据库

spring-boot-route（十）多数据源切换

spring-boot-route（十一）数据库配置信息加密

spring-boot-route（十二）整合redis做为缓存

spring-boot-route（十三）整合RabbitMQ

spring-boot-route（十四）整合Kafka

spring-boot-route（十五）整合RocketMQ

spring-boot-route（十六）使用logback生产日志文件

spring-boot-route（十七）使用aop记录操作日志

spring-boot-route（十八）spring-boot-adtuator监控应用

spring-boot-route（十九）spring-boot-admin监控服务

spring-boot-route（二十）Spring Task实现简单定时任务

spring-boot-route（二十一）quartz实现动态定时任务

spring-boot-route（二十二）实现邮件发送功能

spring-boot-route（二十三）开发微信公众号

这个系列的文章都是工作中频繁用到的知识，学完这个系列，应付日常开发绰绰有余。如果还想了解其他内容，扫面下方二维码告诉我，我会进一步完善这个系列的文章！