• Ukieweb

    佳的博客

    曾梦想仗剑天涯,后来工作忙没去。

yaml 1.2 语法介绍

[官网: YAML Ain’t Markup Language (YAML™) Version 1.2]

一、为什么学习它

在数据格式描述和较复杂数据内容展示方面的配置文件,JSON能够很好的支持,包括语法突出显示、自动格式化、验证工具等。然而缺乏注释过于严格长字符串转换会出现问题等等。对于运维人员,面对较复杂的数据结构来说,不得不寻找一个替代的方式。

YAML(YAML 不是标记语言)是一种非常灵活的格式,几乎是 JSON 的超集,已经被用在一些著名的项目中,如 Travis CI、Circle CI 和 AWS CloudFormation。YAML 的库几乎和 JSON 一样无处不在。除了支持注释换行符分隔多行字符串裸字符串和更灵活的类型系统之外,YAML 也支持引用文件,以避免重复代码。

二、基本语法规则

  • 所有的 YAML 文件开始行都应该是 ---

  • 大小写敏感

  • 使用缩进表示层级关系

  • 缩进时不允许使用Tab键,只允许使用空格。

  • 缩进的空格数目不重要,只要相同层级的元素左侧对齐即可

  • # 表示注释,从这个字符一直到行尾,都会被解析器忽略。

YAML 支持的数据结构有三种。

  • 对象:键值对的集合,又称为映射(mapping)/ 哈希(hashes) / 字典(dictionary)

  • 数组:一组按次序排列的值,又称为序列(sequence) / 列表(list)

  • 纯量/常量scalars):单个的、不可再分的值

三、对象

格式为 key: value 冒号后面要加一个空格

---
#即表示url属性值;
url: https://www.liuluanyi.cn

Yaml 也允许另一种写法,将所有键值对写成一个行内对象。

--- 
host: { ip: 10.1.1.1, port: 2222 }

四、数组

列表中的所有成员都开始于相同的缩进级别, 并且使用一个 "- " 作为开头(一个横杠和一个空格):

---
# 一个美味水果的列表
- Apple
- Orange
- Strawberry
- Mango

数据结构的子成员是一个数组,则可以在该项下面缩进一个空格

-
 - Cat
 - Dog
 - Goldfish

数组也可以采用行内(或者流式)表示法。

services: [FTP, SSH]
companies: [{id: 1,name: company1,price: 200W},{id: 2,name: company2,price: 500W}]

五、对象和数组复合使用

languages:
 - Ruby
 - Perl
 - Python 
websites:
 YAML: yaml.org 
 Ruby: ruby-lang.org 
 Python: python.org

六、纯量

  • 字符串

  • 布尔值

  • 整数

  • 浮点数

  • 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连接,最后使用+代表时

七、字符串 专讲

字符串默认不使用引号表示

str: 这是一行字符串

如果字符串之中包含空格特殊字符,需要放在引号之中

str: '内容: 字符串'

单引号双引号都可以使用,双引号不会对特殊字符转义

s1: '内容\n字符串'
s2: "内容\n字符串"

单引号之中如果还有单引号,必须连续使用两个单引号转义

str: 'labor''s day'

字符串可以写成多行,从第二行开始,必须有一个单空格缩进换行符会被转为空格

str: 这是一段
  多行
  字符串

多行字符串可以使用 | 保留换行符,也可以使用 折叠换行。

this: |
  Foo
  Bar
that: >
  Foo
  Bar

+ 表示保留文字块末尾的换行 - 表示删除字符串末尾的换行

s1: |
  Foo

s2: |+
  Foo


s3: |-
  Foo

字符串之中可以插入 HTML 标记。

message: |

  <p style="color: red">
    段落
  </p>

八、特殊符号

1、YAML 允许使用两个感叹号,强制转换数据类型

e: !!str 123
f: !!str true

2、 --- 配合使用,在一个配置文件中代表一个文件的结束

---
time: 20:03:20
player: Sammy Sosa
action: strike (miss)
...
---
time: 20:03:47
player: Sammy Sosa
action: grand slam
...

3、> 在字符串中折叠换行| 保留换行符,这两个符号是YAML中字符串经常使用的符号,比如:

this: |
  Foo
  Bar
that: >
  Foo
  Bar

4、引用。重复的内容在YAML中可以使用 & 来完成锚点定义,使用 * 来完成锚点引用,例如:

default: &default
    - Mark McGwire
    - Sammy Sosa
hr: *default

那么hr相当于引用了default的数组,注意,hr: *default要写在同一行。


0
0
下一篇:创建自签名 ssl 证书 - 仅用作测试

0 条评论

老佳啊

85后,大专学历,中原人士,家里没矿。

由于年轻时长的比较帅气,导致在别人眼里,我一直不谈恋爱的原因是清高,实则是自己的小自卑。最大的人生目标就是找一个相知相爱相容的人,共度余生。

和人相处时如果能感受到真诚,会非常注重彼此的关系,对别人没有什么心机,即使有利益冲突,一般也会以和为贵,因为在这个世界上,物质的东西,从来不会吸引到我。

特别迷恋那些大山大水,如果现在还能隐居,可能早就去了。对那些宏伟的有底蕴的人文景观比较不感冒。

从事于IT行业,却一直对厨房念念不忘,由于身材魁梧,总觉得自己上辈子是个将军,可惜这辈子没当兵,也不会打架。