原创:微信公众号
码农参上
,欢迎分享,转载请保留出处。
在上一篇文章中,我们从源码角度分析了SpringBoot解析yml配置文件的全流程,那么我们今天就来点实战,总结一下除了烂大街的 @Value
和 @ConfigurationProperties
外,还能够通过哪些方式,来读取yml配置文件的内容。
1、Environment
在Spring中有一个类 Environment
,它可以被认为是当前应用程序正在运行的环境,它继承了 PropertyResolver
接口,因此可以作为一个属性解析器使用。先创建一个yml文件,属性如下:
person:
name: hydra
gender: male
age: 18
使用起来也非常简单,直接使用 @Autowired
就可以注入到要使用的类中,然后调用它的 getProperty()
方法就可以根据属性名称取出对应的值了。
@RestController
public class EnvironmentController {
@Autowired
private Environment environment;
@GetMapping("envTest")
private void getEnv(){
System.out.println(environment.getProperty("person.name"));
System.out.println(environment.getProperty("person.gender"));
Integer autoClose = environment
.getProperty("person.age", Integer.class);
System.out.println(autoClose);
String defaultValue = environment
.getProperty("person.other", String.class, "defaultValue");
System.out.println(defaultValue);
}
}
在上面的例子中可以看到,除了简单的获取外, Environment
提供的方法还可以对取出的属性值进行类型转换、以及默认值的设置,调用一下上面的接口,打印结果如下:
hydra
male
18
defaultValue
除了获取属性外,还可以用来判断激活的配置文件,我们先在 application.yml
中激活 pro
文件:
spring:
profiles:
active: pro
可以通过 acceptsProfiles
方法来检测某一个配置文件是否被激活加载,或者通过 getActiveProfiles
方法拿到所有被激活的配置文件。测试接口:
@GetMapping("getActiveEnv")
private void getActiveEnv(){
System.out.println(environment.acceptsProfiles("pro"));
System.out.println(environment.acceptsProfiles("dev"));
String[] activeProfiles = environment.getActiveProfiles();
for (String activeProfile : activeProfiles) {
System.out.println(activeProfile);
}
}
打印结果:
true
false
pro
2、YamlPropertiesFactoryBean
在Spring中还可以使用 YamlPropertiesFactoryBean
来读取自定义配置的yml文件,而不用再被拘束于 application.yml
及其激活的其他配置文件。
在使用过程中,只需要通过 setResources()
方法设置自定义yml配置文件的存储路径,再通过 getObject()
方法获取 Properties
对象,后续就可以通过它获取具体的属性,下面看一个例子:
@GetMapping("fcTest")
public void ymlProFctest(){
YamlPropertiesFactoryBean yamlProFb = new YamlPropertiesFactoryBean();
yamlProFb.setResources(new ClassPathResource("application2.yml"));
Properties properties = yamlProFb.getObject();
System.out.println(properties.get("person2.name"));
System.out.println(properties.get("person2.gender"));
System.out.println(properties.toString());
}
查看运行结果,可以读取指定的 application2.yml
的内容:
susan
female
{person2.age=18, person2.gender=female, person2.name=susan}
但是这样的使用中有一个问题,那就是只有在这个接口的请求中能够取到这个属性的值,如果再写一个接口,不使用 YamlPropertiesFactoryBean
读取配置文件,即使之前的方法已经读取过这个yml文件一次了,第二个接口取到的仍然还是空值。来对这个过程进行一下测试:
@Value("${person2.name:null}")
private String name;
@Value("${person2.gender:null}")
private String gender;
@GetMapping("fcTest2")
public void ymlProFctest2(){
System.out.println(name);
System.out.println(gender);
}
先调用一次 fcTest
接口,再调用 fcTest2
接口时会打印 null
值:
null
null
想要解决这个问题也很简单,可以配合 PropertySourcesPlaceholderConfigurer
使用,它实现了 BeanFactoryPostProcessor
接口,也就是一个bean工厂后置处理器的实现,可以将配置文件的属性值加载到一个 Properties
文件中。使用方法如下:
@Configuration
public class PropertyConfig {
@Bean
public static PropertySourcesPlaceholderConfigurer placeholderConfigurer() {
PropertySourcesPlaceholderConfigurer configurer
= new PropertySourcesPlaceholderConfigurer();
YamlPropertiesFactoryBean yamlProFb
= new YamlPropertiesFactoryBean();
yamlProFb.setResources(new ClassPathResource("application2.yml"));
configurer.setProperties(yamlProFb.getObject());
return configurer;
}
}
再次调用之前的接口,结果如下,可以正常的取到 application2.yml
中的属性:
susan
female
除了使用 YamlPropertiesFactoryBean
将yml解析成 Properties
外,其实我们还可以使用 YamlMapFactoryBean
解析yml成为 Map
,使用方法非常类似:
@GetMapping("fcMapTest")
public void ymlMapFctest(){
YamlMapFactoryBean yamlMapFb = new YamlMapFactoryBean();
yamlMapFb.setResources(new ClassPathResource("application2.yml"));
Map map = yamlMapFb.getObject();
System.out.println(map);
}
打印结果:
{person2={name=susan, gender=female, age=18}}
3、监听事件
在上篇介绍原理的文章中,我们知道SpringBoot是通过监听事件的方式来加载和解析的yml文件,那么我们也可以仿照这个模式,来加载自定义的配置文件。
首先,定义一个类实现 ApplicationListener
接口,监听的事件类型为 ApplicationEnvironmentPreparedEvent
,并在构造方法中传入要解析的yml文件名:
public class YmlListener implements
ApplicationListener {
private String ymlFilePath;
public YmlListener(String ymlFilePath){
this.ymlFilePath = ymlFilePath;
}
//...
}
自定义的监听器中需要实现接口的 onApplicationEvent()
方法,当监听到 ApplicationEnvironmentPreparedEvent
事件时会被触发:
@Override
public void onApplicationEvent(ApplicationEnvironmentPreparedEvent event) {
ConfigurableEnvironment environment = event.getEnvironment();
ResourceLoader loader = new DefaultResourceLoader();
YamlPropertySourceLoader ymlLoader = new YamlPropertySourceLoader();
try {
List> sourceList = ymlLoader
.load(ymlFilePath, loader.getResource(ymlFilePath));
for (PropertySource propertySource : sourceList) {
environment.getPropertySources().addLast(propertySource);
}
} catch (IOException e) {
e.printStackTrace();
}
}
上面的代码中,主要实现了:
- 获取当前环境
Environment
,当ApplicationEnvironmentPreparedEvent
事件被触发时,已经完成了Environment
的装载,并且能够通过event
事件获取 - 通过
YamlPropertySourceLoader
加载、解析配置文件 - 将解析完成后的
OriginTrackedMapPropertySource
添加到Environment
中
修改启动类,在启动类中加入这个监听器:
public static void main(String[] args) {
SpringApplication application = new SpringApplication(MyApplication.class);
application.addListeners(new YmlListener("classpath:/application2.yml"));
application.run(args);
}
在向 environment
中添加 propertySource
前加一个断点,查看环境的变化:
执行完成后,可以看到配置文件源已经被添加到了环境中:
启动完成后再调用一下接口,查看结果:
susan
female
能够正确的取到配置文件中的值,说明自定义的监听器已经生效。
4、SnakeYml
前面介绍的几种方式,在Spring环境下无需引入其他依赖就可以完成的,接下来要介绍的 SnakeYml
在使用前需要引入依赖,但是同时也可以脱离Spring环境单独使用。先引入依赖坐标:
org.yaml
snakeyaml
1.23
准备一个yml配置文件:
person1:
name: hydra
gender: male
person2:
name: susan
gender: female
在使用 SnakeYml
解析yml时,最常使用的就是 load
、 loadlAll
、 loadAs
方法,这三个方法可以加载yml文件或字符串,最后返回解析后的对象。我们先从基础的 load
方法开始演示:
public void test1(){
Yaml yaml=new Yaml();
Map map =
yaml.load(getClass().getClassLoader()
.getResourceAsStream("snake1.yml"));
System.out.println(map);
}
运行上面的代码,打印Map中的内容:
{person1={name=hydra, gender=male}, person2={name=susan, gender=female}}
接下来看一下 loadAll
方法,它可以用来加载yml中使用 ---
连接符连接的多个文档,将上面的yml文件进行修改:
`yml
person1:
name: hydra
gender: male
Original: https://www.cnblogs.com/trunks2008/p/15829085.html
Author: 码农参上
Title: 5种高大上的yml文件读取方式,你知道吗?
原创文章受到原创版权保护。转载请注明出处:https://www.johngo689.com/573398/
转载文章受原作者版权保护。转载请注明原作者出处!