文章目录
- 1 各种配置比较
- 1.1 properties vs yml
- 1.2 classpath: vs classpath:/config
- 1.3 classpath:/config/yml vs classpath:properties
- 1.4 properties vs -profile.properties
- 1.5 properties vs -profile.yml
- 1.6 classpath:/config/properties vs classpath:application-default.yml
- 1.7 classpath:/config/application-default.yml vs classpath:/application-default.yml
- 1.8 总结
- 2 yml介绍
- 3 yml文件读取
1 各种配置比较
application.properties和application.yml 这是常用的配置文件命名，大家应该都很熟悉。但是它们的优先级到底哪个更高呢？下面就开始做试验。都以server.port来测试
1.1 properties vs yml
- resources
- application.properties # 8081
- application.yml # 8082
通过简单的启动试验发现 properties > yml
1.2 classpath: vs classpath:/config
- resources
- application.properties # 8081
- /config/application.properties # 8082
启动发现 classpath:/config > classpath
1.3 classpath:/config/yml vs classpath:properties
通过上面发现properties的优先级大于yml，config的优先级大于classpath，那么config下面的yml与classpath下面的properties对比如何呢？
- resources
- application.properties # 8081
- /config/application.yml # 8082
启动发现 classpath:/config/yml > classpath:properties
通过这个试验可以发现，位置的优先级大于命名的优先级
1.4 properties vs -profile.properties
application.properties 与 application-{profile}.properties 默认的profile为default
那么就先对比application.properties 与 applicaation-default.properties 的优先级
- resources
- application.properties # 8081
- application-default.properties # 8082
启动发现:application-default.properties > application.properties
1.5 properties vs -profile.yml
与上面的试验类似，将application-default.properties替换为application-default.yml
- resources
- application.properties # 8081
- application-default.yml # 8082
启动发现，application-default.yml > application.properties
所以，加上-default的profile属性时，yml将会大于不加profile的properties，当然如果同时加上profile的属性，那么properties依然会大于yml
1.6 classpath:/config/properties vs classpath:application-default.yml
通过前面的实验发现config的优先级还是蛮高的，但是与default相比谁高呢？
- resources
- application-default.yml # 8081
- /config/application.properties # 8082
启动发现，application-default.yml > /config/application.properties，default的优先级是大于config目录的
1.7 classpath:/config/application-default.yml vs classpath:/application-default.yml
- resources
- application-default.yml # 8081
- /config/application-default.yml # 8082
启动发现，同样是default的条件下，config/application-default.yml > application-default.yml
1.8 总结
config/application-default.properties
> config/application-default.yml
> application-default.properties
> application-default.yml
> config/application.properties
> config/application.yml
> application.properties
> application.yml
2 yml介绍
2.1 yaml基本介绍
YAML 是 YAML Ain't a Markup Language的递归缩写。在开发的这种语言时，YAML 的意思其实是：Yet Another Markup Language（仍是一种标记语言）
YAML 的语法和其他高级语言类似，并且可以简单表达清单、散列表，标量等数据形态。它使用空白符号缩进和大量依赖外观的特色，特别适合用来表达或编辑数据结构、各种配置文件、倾印调试内容、文件大纲
YAML 的配置文件后缀为 .yml，如：test.yml
2.2 yml语法
基本语法：
- 大小写敏感
- 使用缩进表示层级关系
- 缩进不允许使用
tab，只允许空格 - 缩进的空格数不重要，只要相同层级的元素
左对齐即可 #表示注释
2.3 yml数据类型
数据类型：
YAML支持以下几种数据类型：
对象：键值对的集合，又称为映射（mapping）/ 哈希（hashes） / 字典（dictionary）数组：一组按次序排列的值，又称为序列（sequence） / 列表（list）纯量（scalars）：单个的、不可再分的值
2.3.1 对象
YAML对象
对象键值对使用冒号结构表示 key: value，冒号后面要加一个 空格
也可以使用 key:{key1: value1, key2: value2, ...}
还可以使用缩进表示层级关系；
key:
child-key: value
child-key2: value2
如果有较为复杂的对象格式，可以使用 问号 加一个 空格 代表一个复杂的 key，配合一个冒号加一个空格代表一个 value：
散列表的键值可以用问号 ( ? ) 起始，用来明确的表示多个词汇组成的键值
?
- complexkey1
- complexkey2
:
- complexvalue1
- complexvalue2
意思即对象的属性是一个数组 [complexkey1,complexkey2]，对应的值也是一个数组 [complexvalue1,complexvalue2]
2.3.2 数组
YAML 数组
以 - 开头的行表示构成一个数组：
- A
- B
- C
YAML 支持多维数组，可以使用行内表示：
key: [value1, value2, ...]
数据结构的子成员是一个数组，则可以在该项下面缩进一个空格。
-
- A
- B
- C
一个相对复杂的例子：
companies:
-
id: 1
name: company1
price: 200W
-
id: 2
name: company2
price: 500W
或者不缩进换行
companies:
- id: 1
name: company1
price: 200W
- id: 2
name: company2
price: 500W
意思是 companies 属性是一个数组，每一个数组元素又是由 id、name、price 三个属性构成。
数组也可以使用流式flow的方式表示：
companies: [{id: 1,name: company1,price: 200W},{id: 2,name: company2,price: 500W}]
2.3.3 复合结构
数组和对象可以构成复合结构，例：
languages:
- Ruby
- Perl
- Python
websites:
YAML: yaml.org
Ruby: ruby-lang.org
Python: python.org
Perl: use.perl.org
转换为 json 为：
{
languages: [ 'Ruby', 'Perl', 'Python'],
websites: {
YAML: 'yaml.org',
Ruby: 'ruby-lang.org',
Python: 'python.org',
Perl: 'use.perl.org'
}
}
2.3.4 纯量
纯量是最基本的，不可再分的值，包括：
- 字符串
- 布尔值
- 整数
- 浮点数
Null- 时间
- 日期
使用一个例子来快速了解纯量的基本使用：
boolean:
- TRUE #true,True都可以
- FALSE #false，False都可以
float:
- 3.14
- 6.8523015e+5 #可以使用科学计数法
int:
- 123
- 0b1010_0111_0100_1010_1110 #二进制表示
null:
nodeName: 'node'
parent: ~ #使用~表示null
string:
- 哈哈
- 'Hello world' #可以使用双引号或者单引号包裹特殊字符
- newline
newline2 #字符串可以拆成多行，每一行会被转化成一个空格
date:
- 2018-02-17 #日期必须使用ISO 8601格式，即yyyy-MM-dd
datetime:
- 2018-02-17T15:02:31+08:00 #时间使用ISO 8601格式，时间和日期之间使用T连接，最后使用+代表时区
2.3.5 引用
& 锚点和 * 别名，可以用来引用:
defaults: &defaults
adapter: postgres
host: localhost
development:
database: myapp_development
<<: *defaults
test:
database: myapp_test
<<: *defaults
相当于:
defaults:
adapter: postgres
host: localhost
development:
database: myapp_development
adapter: postgres
host: localhost
test:
database: myapp_test
adapter: postgres
host: localhost
& 用来建立锚点（defaults），<< 表示合并到当前数据，* 用来引用锚点
下面是另一个例子:
- &showell Steve
- Clark
- Brian
- Oren
- *showell
转为 JavaScript 代码如下:
[ 'Steve', 'Clark', 'Brian', 'Oren', 'Steve' ]
2.3.6 区块的字符
再次强调，字符串不需要包在引号之内。有两种方法书写多行文字（multi-line strings），一种可以保存新行（使用 | 字符），另一种可以折叠新行（使用 > 字符）。
2.3.6.1 保存新行 (Newlines preserved)
data: | # 譯者注：這是一首著名的五行民謠(limerick)
There once was a man from Darjeeling # 這裡曾有一個人來自大吉嶺
Who got on a bus bound for Ealing # 他搭上一班往伊靈的公車
It said on the door # 門上這麼說的
"Please don't spit on the floor" # "請勿在地上吐痰"
So he carefully spat on the ceiling # 所以他小心翼翼的吐在天花板上
根据设置，前方的引领空白符号（leading white space）必须排成条状，以便和其他数据或是行为（如示例中的缩进）明显区分
2.3.6.2 折叠新行 (Newlines folded)
data: >
Wrapped text # 摺疊的文字
will be folded # 將會被收
into a single # 進單一一個
paragraph # 段落
Blank lines denote # 空白的行代表
paragraph breaks # 段落之間的區隔
和保存新行不同的是，换行字符会被转换成空白字符。而引领空白字符则会被自动消去
转载于菜鸟教程-yaml入门教程:https://www.runoob.com/w3cnote/yaml-intro.html
3 yml文件读取
在springboot中除了烂大街的@Value和@ConfigurationProperties(注意各spring版本号)外，还能够通过哪些方式，来读取yml配置文件的内容
3.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
3.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<String, Object> map = yamlMapFb.getObject();
System.out.println(map);
}
打印结果：
{person2={name=susan, gender=female, age=18}}
3.3 监听事件
在上篇介绍原理的文章中，我们知道SpringBoot是通过监听事件的方式来加载和解析的yml文件，那么我们也可以仿照这个模式，来加载自定义的配置文件。
首先，定义一个类实现ApplicationListener接口，监听的事件类型为ApplicationEnvironmentPreparedEvent，并在构造方法中传入要解析的yml文件名：
public class YmlListener implements
ApplicationListener<ApplicationEnvironmentPreparedEvent> {
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<PropertySource<?>> 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);
}
运行结果
susan
female
点击了解更多spring事件监听
点击了解更多java.util.Properties类操作properties文件
转载于:https://mp.weixin.qq.com/s/T7LDF9RlJ3k_2cRsFLwNBg
3.4 SnakeYml
前面介绍的几种方式，在Spring环境下无需引入其他依赖就可以完成的，接下来要介绍的SnakeYml在使用前需要引入依赖，但是同时也可以脱离Spring环境单独使用。
3.4.1 pom.xml
先引入依赖坐标：
<dependency>
<groupId>org.yaml</groupId>
<artifactId>snakeyaml</artifactId>
<version>1.23</version>
</dependency>
准备一个yml配置文件：
person1:
name: hydra
gender: male
person2:
name: susan
gender: female
在使用SnakeYml解析yml时，最常使用的就是load、loadlAll、loadAs方法，这三个方法可以加载yml文件或字符串，最后返回解析后的对象
3.4.2 load方法
我们先从基础的load方法开始演示：
public void test1(){
Yaml yaml=new Yaml();
Map<String, Object> map =
yaml.load(getClass().getClassLoader().getResourceAsStream("snake1.yml"));
System.out.println(map);
}
运行上面的代码，打印Map中的内容：
{person1={name=hydra, gender=male}, person2={name=susan, gender=female}}
3.4.3 loadAll方法
接下来看一下loadAll方法，它可以用来加载yml中使用---连接符连接的多个文档，将上面的yml文件进行修改：
person1:
name: hydra
gender: male
---
person2:
name: susan
gender: female
在添加了连接符后，尝试再使用load方法进行解析，报错如下显示发现了另一段yml文档从而无法正常解析：
这时候修改上面的代码，使用loadAll方法：
public void test2(){
Yaml yaml=new Yaml();
Iterable<Object> objects =
yaml.loadAll(getClass().getClassLoader().getResourceAsStream("snake2.yml"));
for (Object object : objects) {
System.out.println(object);
}
}
执行结果如下：
{person1={name=hydra, gender=male}}
{person2={name=susan, gender=female}}
可以看到，loadAll方法返回的是一个对象的迭代，里面的每个对象对应yml中的一段文档，修改后的yml文件就被解析成了两个独立的Map。
3.4.4 loadAs方法
接下来再来看一下loadAs方法，它可以在yml解析过程中指定类型，直接封装成一个对象。我们直接复用上面的snake1.yml，在解析前先创建两个实体类对象用于接收：
@Data
public class Person {
SinglePerson person1;
SinglePerson person2;
}
@Data
public class SinglePerson {
String name;
String gender;
}
下面使用loadAs方法加载yml，注意方法的第二个参数，就是用于封装yml的实体类型。
public void test3(){
Yaml yaml=new Yaml();
Person person =
yaml.loadAs(getClass().getClassLoader(). getResourceAsStream("snake1.yml"), Person.class);
System.out.println(person.toString());
}
查看执行结果：
Person(person1=SinglePerson(name=hydra, gender=male), person2=SinglePerson(name=susan, gender=female))
实际上，如果想要将yml封装成实体对象，也可以使用另一种方法。在创建Yaml对象的时候，传入一个指定实体类的构造器对象，然后直接调用load方法就可以实现：
public void test4(){
Yaml yaml=new Yaml(new Constructor(Person.class));
Person person = yaml.load(getClass().getClassLoader().getResourceAsStream("snake1.yml"));
System.out.println(person.toString());
}
执行结果与上面相同：
Person(person1=SinglePerson(name=hydra, gender=male), person2=SinglePerson(name=susan, gender=female))
3.5 jackson-dataformat-yaml
相比大家平常用jackson比较多的场景是用它来处理json，其实它也可以用来处理yml，使用前需要引入依赖：
<dependency>
<groupId>com.fasterxml.jackson.dataformat</groupId>
<artifactId>jackson-dataformat-yaml</artifactId>
<version>2.12.3</version>
</dependency>
使用jackson读取yml也非常简单，这里用到了常用的ObjectMapper，在创建ObjectMapper对象时指定使用YAML工厂，之后就可以简单的将yml映射到实体：
public void read() throws IOException {
ObjectMapper objectMapper = new ObjectMapper(new YAMLFactory());
InputStream input = new FileInputStream("F:\\Work\\yml\\src\\main\\resources\\snake1.yml");
Person person = objectMapper.readValue(input, Person.class);
System.out.println(person.toString());
}
运行结果：
Person(person1=SinglePerson(name=hydra, gender=male), person2=SinglePerson(name=susan, gender=female))
如果想要生成yml文件的话，可以调用ObjectMapper的writeValue方法实现：
public void write() throws IOException {
Map<String,Object> map=new HashMap<>();
SinglePerson person1 = new SinglePerson("Trunks", "male");
SinglePerson person2 = new SinglePerson("Goten", "male");
Person person=new Person(person1,person2);
map.put("person",person);
ObjectMapper objectMapper = new ObjectMapper(new YAMLFactory());
objectMapper.writeValue(new File("F:\\Work\\yml\\src\\main\\resources\\jackson-gen.yml"),map);
}
查看生成的yml文件，可以看到jackson对字符串类型严格的添加了引号，还在文档的开头添加了yml的链接符
扫一扫
5891
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
