YAML基础语法手册以及和JSON的对照

k8s使用了YAML格式进行容器编排,因此这里来详细学习一下YAML文件的基本规则。
本文介绍 YAML 的语法,可以使用在线网站进行验证YAML验证

简介

它的基本语法规则:

  • 大小写敏感
  • 使用缩进表示层级关系
  • 缩进时不允许使用Tab键,只允许使用空格。
  • 缩进的空格数目不重要,只要相同层级的元素左侧对齐即可
  • # 表示注释,从这个字符一直到行尾,都会被解析器忽略。

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

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

以下分别介绍这三种数据结构。

对象

对象的一组键值对,使用冒号结构表示。

YAML JSON
animal: pets { animal: 'pets' }

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

YAML JSON
hash: { name: Steve, foo: bar } { hash: { name: 'Steve', foo: 'bar' } }

数组

一组连词线开头的行,构成一个数组。

YAML JSON
- Cat
- Dog
- Goldfish
[ 'Cat', 'Dog', 'Goldfish' ]

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

YAML JSON
-
  - Cat
  - Dog
  - Goldfish
[ [ 'Cat', 'Dog', 'Goldfish' ] ]

数组也可以采用行内表示法。

YAML JSON
animal: [Cat, Dog] { animal: [ 'Cat', 'Dog' ] }

纯量

纯量是最基本的、不可再分的值。

  • 整数
  • 浮点数
  • 布尔值
  • null
  • 字符串

数值直接以字面量的形式表示

YAML JSON
number: 12.30 { number: 12.30 }

最新标准里 y / Y / yes / Yes / YES / n / N / no / No / NO / true / True / TRUE / false / False / FALSE / on / On / ON / off / Off / OFF 全部都会被解析成正确的 bool 类型,为了兼容性比较好建议用 true 和 false。

YAML JSON
isSet: true { isSet: true }

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

YAML JSON
e: !!str 123
f: !!str true
{ e: '123', f: 'true' }

~ / null / Null / NULL 还有空字符都被解析成 null 类型,最标准的写法是 ~。

YAML JSON
e: ~ { e: null }

字符串

字符串是最常见,也是最复杂的一种数据类型。
字符串默认不使用引号表示。

YAML JSON
str: 这是一行字符串 { str: '这是一行字符串' }

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

YAML JSON
str: '内容: 字符串' { str: '内容: 字符串' }

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

YAML JSON
s1: '内容\n字符串'
s2: "内容\n字符串"
{ s1: '内容\\n字符串', s2: '内容\n字符串' }

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

YAML JSON
str: 'labor''s day' { str: 'labor's day' }

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

YAML JSON
str: 这是一段
 多行
 字符串
{ str: '这是一段 多行 字符串' }

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

YAML JSON
this:|
 Foo
 Bar
that: >
 Foo
 Bar
this:
'Foo\nBar\n', that: 'Foo Bar\n' }

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

YAML JSON
s1:|
 Foo

s2:|+
 Foo


s3:|-
 Foo
{ s1: 'Foo\n', s2: 'Foo\n\n\n', s3: 'Foo' }

复合结构

对象和数组可以结合使用,形成复合结构。

YAML JSON
languages:
- Ruby
- Perl
- Python
websites:
  YAML: yaml.org
  Ruby: ruby-lang.org
  Python: python.org
  Perl: se.perl.org
{ languages: [ 'Ruby', 'Perl', 'Python' ],
  websites:
   { YAML: 'yaml.org',
     Ruby: 'ruby-lang.org',
     Python: 'python.org',
     Perl: 'use.perl.org' } }

引用

锚点&和别名*,可以用来引用。

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),<<表示合并到当前数据,*用来引用锚点。

下面是另一个例子。

YAML JSON
- &showell Steve
- Clark
- Brian
- Oren
- *showell
[ 'Steve', 'Clark', 'Brian', 'Oren', 'Steve' ]

参考链接

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 218,284评论 6 506
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,115评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 164,614评论 0 354
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,671评论 1 293
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,699评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,562评论 1 305
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,309评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,223评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,668评论 1 314
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,859评论 3 336
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,981评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,705评论 5 347
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,310评论 3 330
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,904评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,023评论 1 270
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,146评论 3 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,933评论 2 355

推荐阅读更多精彩内容

  • 声明: 原文链接地址: http://www.ruanyifeng.com/blog/2016/07/yaml.h...
    Michael_林阅读 7,728评论 0 3
  • yaml 语言 语法规则:1.大小写敏感2.使用缩进表示 层级关系3.缩进时不允许使用 tab键,只允许使用空格...
    Helen_Cat阅读 1,820评论 0 0
  • link: http://www.ruanyifeng.com/blog/2016/07/yaml.html 一、...
    Janny_lwj阅读 128评论 1 0
  • 一、YML是什么 YAML (YAML Aint Markup Language)是一种标记语言,通常以.yml为...
    xlystar阅读 2,140评论 0 1
  • 昨天给大家来了一部高智商,而且特别烧脑的电影,就连院长看了很久也没能看懂什么意思。这些剧都比较长,但值得花时间去细...
    女生动漫阅读 31,236评论 0 6