YAML文件的写法,以及和JSON的区别
2024-07-11 本文已影响0人
lihao_李浩
YAML(YAML Ain't Markup Language)基本规则与比较
YAML(YAML Ain't Markup Language)是一种人类可读的、用于数据序列化的格式。以下是一些基本的YAML书写规则:
基本规则
-
缩进:
- 使用空格进行缩进,推荐使用2个或4个空格。
- 不允许使用制表符(Tab)进行缩进。
- 缩进表示层级关系。
-
键值对:
- 使用冒号
:
来分隔键和值,键和值之间至少有一个空格。 - 键和值都可以是字符串、数字、布尔值、列表或对象。
- 使用冒号
-
注释:
- 使用
#
开始的行表示注释,注释不会被解析。 - 注释可以放在单独一行,也可以在键值对之后。
- 使用
数据类型
1 字符串:
- 字符串可以不使用引号,如果字符串包含特殊字符(如
:
),需要使用引号。 - 单引号
'
和双引号"
都可以使用。 - 多行字符串可以使用
|
或>
。
name: John Doe
description: "A developer"
single_line: "This is a single line string"
multi_line: |
This is a multi-line string.
It can contain multiple lines.
2 数字:
- 可以直接写整数或浮点数。
age: 30
height: 1.75
2 布尔值:
- 使用 true 或 false。
is_active: true
has_account: false
3 列表:
- 使用 - 表示列表项,每个项前都有一个缩进。
languages:
- Python
- JavaScript
- Go
4 对象:
- 使用缩进表示对象的层级关系。
address:
street: 123 Main St
city: Anytown
zip: 12345
示例
以下是一个包含多种数据类型的完整YAML示例:
用户信息
user:
name: John Doe
age: 30
is_active: true
skills:
- Programming
- Writing
address:
street: 123 Main St
city: Anytown
zip: 12345
profile:
description: >
John is a developer
and writer.
bio: |
He works on various projects.
Loves coding and sharing knowledge.
YAML 和 JSON 有许多相似之处,都是用于数据序列化的格式,并且在很多场景下可以相互转换。不过,它们在语法和使用上也有一些不同之处。以下是一些主要区别:
YAML 和 JSON 的区别
1 可读性:
- YAML 更加注重可读性,设计上更接近于人类自然语言,减少了许多标点符号,如逗号和引号。
- JSON 更加简洁,通常使用大量的标点符号,如大括号 {} 和方括号 []。
2 注释:
- YAML 支持注释,可以使用 # 来添加注释。
- JSON 不支持注释。
3 格式要求:
- YAML 使用缩进来表示层级关系,不允许使用制表符(Tab),必须使用空格。
- JSON 使用大括号 {} 表示对象,使用方括号 [] 表示数组,没有缩进要求,但通常会使用缩进来提高可读性。
4 数据类型:
- YAML 支持更多的数据类型,比如日期、二进制数据等。
- JSON 主要支持字符串、数字、布尔值、数组和对象。
示例对比
以下是相同数据在 YAML 和 JSON 中的表示形式:
YAML 示例
user:
name: John Doe
age: 30
is_active: true
skills:
- Programming
- Writing
address:
street: 123 Main St
city: Anytown
zip: 12345
profile:
description: >
John is a developer
and writer.
bio: |
He works on various projects.
Loves coding and sharing knowledge.
JSON 示例
{
"user": {
"name": "John Doe",
"age": 30,
"is_active": true,
"skills": [
"Programming",
"Writing"
],
"address": {
"street": "123 Main St",
"city": "Anytown",
"zip": "12345"
},
"profile": {
"description": "John is a developer and writer.",
"bio": "He works on various projects.\nLoves coding and sharing knowledge."
}
}
}
适用场景
- YAML 常用于配置文件,比如在 DevOps 中的 Ansible、Kubernetes 配置文件等。
- JSON 常用于数据交换,比如 RESTful API 的请求和响应数据格式。
总的来说,YAML 和 JSON 各有优缺点,选择使用哪种格式取决于具体的使用场景和需求。