Yaml对比Json优势分析以及yaml文件写法

不知道从什么时候开始，突然出现了一种以 .yaml 或 .yml 为后缀的配置文件。从最开始学习docker的时候，里面有dockercompose.yaml文件的写法。就看到了这种文件格式。结果现在学习pytest的时候，又发现在使用yaml文件来读取数据。我之前学unittest的时候都是用csv和json的啊。印象中json更多。这Yaml是何方神圣呢？

今天让我们一起来揭开Yaml的神秘面纱吧！

一、什么是Yaml?

YAML 是 “YAML Ain’t a Markup Language”（YAML 不是一种标记语言）的递归缩写。在开发的这种语言时，YAML 的意思其实是：”Yet Another Markup Language”（仍是一种标记语言）。

YAML 的语法和其他高级语言类似，并且可以简单表达清单、散列表，标量等数据形态。它使用空白符号缩进和大量依赖外观的特色，特别适合用来表达或编辑数据结构、各种配置文件、倾印调试内容、文件大纲（例如：许多电子邮件标题格式和YAML非常接近）。

YAML 的配置文件后缀为.yml或.yaml

二、YAML对比JSON优势

1.更灵活

Json格式要求必须如下：

{
  "name": "ruims"
}

虽然是统一格式，但是使用上确实有不便利的地方。比如我在浏览器上测出了接口错误。然后把参数拷贝到 Postman 里调试，这时就我要手动给每个属性和值加 "" 号，非常繁琐。

yaml格式：name: ruims

除了 "" 号，yaml 觉得 {} 和 [] 这种符号也是多余的，不如一起干掉。同时也支持引号、括号的方式

2.可以使用注释

Json里面想要加注释得加个key:value对。比如："desc":“这是一个注释信息"

而Yaml可以直接使用其它的通用注释方式 。如：#这是一个注释信息

很明显，当配置文件里注释过多时，会Json格式会增加读取数据操作的负担。

三、基本语法

• 大小写敏感
• 使用缩进表示层级关系
• 缩进不允许使用tab，只允许空格
• 缩进的空格数不重要，只要相同层级的元素左对齐即可
• ‘#’表示注释

四、数据类型

YAML 支持以下几种数据类型：

• 对象：键值对的集合，又称为映射（mapping）/ 哈希（hashes） / 字典（dictionary）
• 数组：一组按次序排列的值，又称为序列（sequence） / 列表（list）
• 纯量（scalars）：单个的、不可再分的值

YAML 对象

对象键值对使用冒号结构表示 key: value，冒号后面要加一个空格。

也可以使用 key:{key1: value1, key2: value2, …}。

还可以使用缩进表示层级关系；

key: 
    child-key: value
    child-key2: value2

等于：{"key":{"child-key":"value","child-key2":"value2"}}

较为复杂的对象格式，可以使用问号加一个空格代表一个复杂的 key，配合一个冒号加一个空格代表一个 value：

存疑

?  
    - complexkey1
    - complexkey2
:
    - complexvalue1
    - complexvalue2

意思即对象的属性是一个数组 [complexkey1,complexkey2]，对应的值也是一个数组 [complexvalue1,complexvalue2]

YAML 数组

以 – 开头的行表示构成一个数组：

- A
- B
- C

等于：['A', 'B', 'C']

案例：复杂结构

案例1：

案例2：

纯量

纯量是最基本的，不可再分的值，包括：

• 字符串
• 布尔值
• 整数
• 浮点数
• 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连接，最后使用+代表时区

下面使用python pyyaml模块，读取出的：

{'boolean': [True, False], 'float': [3.14, 685230.15], 'int': [123, 685230], None: {'nodeName': 'node', 'parent': None}, 'string': ['哈哈', 'Hello world', 'newline newline2'], 'date': [datetime.date(2018, 2, 17)], 'datetime': [datetime.datetime(2018, 2, 17, 15, 2, 31, tzinfo=datetime.timezone(datetime.timedelta(seconds=28800)))]}

引用

& 用来建立锚点（defaults），* 用来引用锚点（defaults），<< 表示合并到当前数据。

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

下面是另一个例子:

- &showell Steve 
- Clark 
- Brian 
- Oren 
- *showell 

等于：[ 'Steve', 'Clark', 'Brian', 'Oren', 'Steve' ]

字符串过长

在 shell 中我们常见到一些参数很多，然后特别长的命令，如果命令都写在一行的话可读性会非常差。

假设下面的是一条长命令：

$ docker run --name my-nginx -d nginx

在 linux 中可以这样处理：

$ docker run \
 --name my-nginx \
 -d nginx

就是在每行后加 \ 符号标识换行。然而在 YAML 中更简单，不需要加任何符号，直接换行即可：

cmd: docker run
  --name my-nginx
  -d nginx

YAML 默认会把换行符转换成空格，因此转换后 JSON 如下，正是我们需要的：

{ "cmd": "docker run --name my-nginx -d nginx" }

然而有时候，我们的需求是保留换行符，并不是把它转换成空格，又该怎么办呢？

这个也简单，只需要在首行加一个 | 符号：

cmd: |
  docker run
  --name my-nginx
  -d nginx

转换成 JSON 变成了这样：

{ "cmd": "docker run\n--name my-nginx\n-d nginx" }