YAML语法规范


原文链接: YAML语法规范

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

[jinjia2语法]
{%...%} 表达式
{{...}} 变量
{#...#} 注释

[JSON语法]
官网:http://www.json.org/
说明: JSON语法是JavaScript对象表示法语法的子集

语法规则
1 数据在名称/值对中
2 数据由逗号分隔
3 花括号保存对象
4 方括号保存数组
5 JSON值可以是:

数字(整数或浮点数)
字符串(在双引号中)
逻辑值(true 或 false)
数组(在方括号中)
对象(在花括号中)
null

[YAML语法]
官网:http://www.yaml.org/
说明:
语法规则

  1 大小写敏感
  2 使用空格缩进表示层级关系(缩进时不允许Tab键,只允许使用空格;缩进空格数目不重要,只要相同层级的元素左侧对齐即可)
  3 #表示注释,从#一直到行尾,都会被解析器忽略
  4 支持的数据结构
    对象(键值对的集合)
    数组(一组按次序排列的值)
    纯量(单个、不可再分的值)
  5 数组用一个破折号加空格("- ")表示
  6 对象用一个冒号加空格(": ")表示
  7 重复的节点(对象)首先由锚(用&符号“&”标记)标识,然后再用别名(以星号“*”引用)标识
  8 常用符号
    --- 三个破折号表示文档开始
    ... 三个点表示文档的结尾
    | 多行字符串保留换行符 \n ... \n
    > 多行字符串折叠换行   ...\n
    + 保留整个文字块[末尾]的换行 ..\n
    - 删除整个文字块[末尾]的换行 ..
    & 锚点
    * 别名(引用)
    << 合并到当前数据
test0:
  1.xml
  2.xml

test1: |
  1.xml
  2.xml

test2: >
  1.xml
  2.xml

test3: |+
  1.xml
  2.xml

test4: |-
  1.xml
  2.xml

test5: >+
  1.xml
  2.xml

test6: >-
  1.xml
  2.xml

"test0": "1.xml 2.xml",
"test1|": "1.xml\n2.xml\n",
"test2>": "1.xml 2.xml\n",
"test3|+": "1.xml\n2.xml\n\n",
"test4|-": "1.xml\n2.xml",
"test5>+": "1.xml 2.xml\n\n",
"test6>-": "1.xml 2.xml",

本文来自:阮一峰:YAML 语言教程

简介

YAML 是专门用来写配置文件的语言,非常简洁和强大,远比 JSON 格式方便。
YAML 语言(发音 /ˈjæməl/ )的设计目标,就是方便人类读写。它实质上是一种通用的数据串行化格式。

它的基本语法规则如下:

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

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

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

对象

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

	animal: pets
	{ animal: 'pets' }

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

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

数组

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


	- Cat
	- Dog
	- Goldfish

	[ 'Cat', 'Dog', 'Goldfish' ]

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


	-
	 - Cat
	 - Dog
	 - Goldfish

	[ [ 'Cat', 'Dog', 'Goldfish' ] ]

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

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

复合结构

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

```Yaml

languages:
 - Ruby
 - Perl
 - Python
websites:
 YAML: yaml.org
 Ruby: ruby-lang.org
 Python: python.org
 Perl: use.perl.org
```JavaScript

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

纯量

纯量是最基本的、不可再分的值。以下数据类型都属于 JavaScript 的纯量:

布尔值

布尔值用true和false表示

数值

分为整数和浮点数

Null

null用 ~ 表示:

parent: ~

时间

	iso8601: 2001-12-14t21:59:43.10-05:00
	{ iso8601: new Date('2001-12-14t21:59:43.10-05:00') }

日期

日期采用复合 iso8601 格式的年、月、日表示:

	date: 1976-07-31
	{ date: new Date('1976-07-31') }

字符串

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

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

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

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

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

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

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

	str: 'labor''s day'
	{ str: 'labor\'s day' }

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


	str: 这是一段
	  多行
	  字符串

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

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


	this: |
	  Foo
	  Bar
	that: >
	  Foo
	  Bar

	{ this: 'Foo\nBar\n', that: 'Foo Bar\n' }

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


	s1: |
	  Foo

	s2: |+
	  Foo


	s3: |-
	  Foo

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

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


	message: |

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

	{ message: '\n<p style="color: red">\n  段落\n</p>\n' }

强制类型转换

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

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

引用

锚点&和别名*,可以用来引用
&用来建立锚点,<< 表示合并到当前数据,*用来引用锚点:


	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' ]
`