yaml基础及其Java应用方案-京东云开发者社区

### 1 YAML介绍
YAML(YAML Ain't Markup Language)，也可以叫做YML，是一种人性化的数据序列化的语言，类似于XML，JSON。SpringBoot的配置文件就支持yaml文件。
基本语法如下：
- 大小写敏感
- 使用缩进表示层级关系
- 缩进时不允许使用Tab键，只允许使用空格。
- 缩进的空格数目不重要，只要相同层级的元素左侧对齐即可
- 表示注释，从这个字符一直到行尾，都会被解析器忽略。

#### 1.1.Yaml的数据结构
##### 1.1.1对象
写在一行

```yaml
address: {province: 山东, city: 济南}
```

写在多行
```yaml
address:
  province: 山东
  city: 济南
```

##### 1.1.2 数组：以 - 开头的行表示构成一个数组
写在一行
```yaml
hobbyList: [游泳, 跑步]
```

写在多行

```yaml
hobbyList:
- 游泳
- 跑步
```

##### 1.1.3 纯量：是最基本的、不可再分的值
字符串：默认不用加引号，包含空格或特殊字符必须加引号，单引号或双引号都可以

```yaml
userId: S123
username: "李诗诗"
password: '123456'
province: 山东
city: "济南 : ss"
```

布尔值：true、false

```yaml
success: true
```

整数
```yaml
age: 13
```

浮点数
```yaml
weight: 75.5
```

Null

```yaml
gender: ~
```

时间：使用ISO8601标准 ISO8601

```yaml
createDate: 2001-12-14T21:59:43.10+05

```

##### 1.1.4 复合结构
复合结构：数组和对象可以构成复合结构。

```yaml
---
userId: "1"
username: "lisi"
password: "123456"
addressList:
- province: "河北"
city: "邯郸"
- province: "北京"
city: "北京"
hobbyList:
- "游泳"
- "跑步"
birthday: "1989-09-28 17:07:05"
validDt: "2021-09-28 17:07:05"
```

#### 1.2 引用
锚点 & 和别名 * ，可以用来引用。

```yaml
student: 
- &name 小白 
- Clark 
teacher:
- *name
```

转为 JavaScript 代码如下:

```javascript
{
  "student": [
    "小白",
    "Clark"
  ],
  "teacher": [
    "小白"
  ]
}
```

### 2 java通过YAMLMapper 实现读写yaml格式信息

![](//img1.jcloudcs.com/developer.jdcloud.com/be6b3366-37e3-4a74-8df0-c0e1026c1ffc20220125153139.png)

YAMLMapper继承自ObjectMapper。与ObjectMapper使用方式类似。
User对象

![](//img1.jcloudcs.com/developer.jdcloud.com/3a986008-dd18-489e-b07c-00890b49519320220125153152.png)

#### 2.1 字符串与对象的互转

![](//img1.jcloudcs.com/developer.jdcloud.com/bc5a70fd-8ba5-46e9-b9d1-e31b338d575720220125153210.png)

结果：

![](//img1.jcloudcs.com/developer.jdcloud.com/28eb968f-c218-438c-a7ec-f5f2020b2be420220125153222.png)

#### 2.2 文件与对象的互转

![](//img1.jcloudcs.com/developer.jdcloud.com/9e636e40-2de3-4b63-8d84-8cef2c94889120220125153237.png)

结果：

![](//img1.jcloudcs.com/developer.jdcloud.com/83846eaa-36dd-4c40-a5a7-6e13e63575aa20220125153250.png)

### 3 Java使用Beetl模板引擎，生成yaml格式信息
Beetl是Bee Template Language的缩写，它绝不是简单的另外一种模板引擎，而是新一代的模板引擎，它功能强大，性能良好，超过当前流行的模板引擎。而且还易学易用。具体信息参考官网：

![](//img1.jcloudcs.com/developer.jdcloud.com/422eaaf8-82a1-4318-8190-49c65c08255b20220125153310.png)

Java代码、beetl模板及生成的yaml信息如下：

![](//img1.jcloudcs.com/developer.jdcloud.com/3b843fcf-bad5-45b0-a4ee-ff810672e7af20220125153328.png)

### 4 SpringBoot 解析yaml
当然除了上面介绍的以代码解析yaml的方式外，springboot也提供了方便简洁的形式来解析。这里介绍下注解形式。
#### 示例一：
在resources/yml/目录下新增文件studentinfo.yaml，使用注解@value（"${key}"）解析

![](//img1.jcloudcs.com/developer.jdcloud.com/61ec7338-580f-465e-a94a-c38e4cfdcc9020220125153349.png)

#### 示例二：
在resources/yml/目录下新增文件studentinfo.yaml，使用注解@ConfigurationProperties(prefix = "studentinfo") == @ConfigurationProperties("studentinfo")

![](//img1.jcloudcs.com/developer.jdcloud.com/b10e52f0-0c80-4064-9b91-b82923872bc320220125153404.png)

### 5 yaml,json,ini这三种格式用来做配置文件优缺点

适合人类编写：ini > toml > yaml > json > xml > plist
可以存储的数据复杂度：xml > yaml > toml ~ json ~ plist > ini

想具体了解的可参考资料：
- https://blog.csdn.net/yangyutong0506/article/details/102780228
- https://www.cnblogs.com/pqjwyn/p/13255578.html
- https://jingyan.baidu.com/article/1612d5006956d5a30e1eeeab.html

### 6 总结

开发过程中经常遇到需要Java端生成各种Yaml的配置信息（销量预测系统生成算法使用的基础配置信息），这里特意整理了下使用方案，供小伙伴们学习参考。当然json，xml，或者其他常见格式的文件信息，也可以参考这样的思路去学习封装和使用。
青春很短，不负韶华！共勉！！

------------

###### 自猿其说Tech-京东物流技术发展部
###### 作者：郭佳良（人工智能与大数据部）