您的位置:

深入浅出:.yaml文件格式详解

一、基本介绍

YAML是一种“人类友好的数据序列化标准”,完整名称为“YAML Ain’t Markup Language”。它是一种类似于XML和JSON的格式,用于在应用程序中存储和交换数据。YAML最大的优点是易读、易写,可以用于Lua、Perl、Python、Ruby等众多编程语言。同时,通过“可用性即正确性”(“as readable as possible”)这一设计原则,使得YAML比起XML和JSON更具可读性和可维护性。

二、数据类型

YAML支持各种数据类型,包括:标量(scalar)、序列(sequence)、映射(mapping)。其中标量是最常用的类型,表示单个数据元素,可以是数字、字符串、布尔值等;序列则是一组数据元素的有序集合,可以通过“-”来表示;映射则表示一组键值对,可以通过“:”来表示。下面是一个具有不同数据类型的YAML示例:

people:
  - Alice Smith
  - Bob Jones
  - Cathy Johnson
address:
  street: 100 Main Street
  city: Anytown
  state: CA
  zip: 12345
married: true
age: 30

三、缩进规则

YAML的最主要特点之一就是缩进。通过缩进的方式区分出数据层次结构和关键字,使得YAML看起来更具有可读性和可维护性。在YAML中,缩进的空格数必须是2的倍数,缩进的层次深度代表了序列或映射的嵌套深度。下面是一个示例:

name: John Smith
age: 30
contact:
  email: john.smith@example.com
  phone:
    home: 555-1234
    work: 555-5678

四、注释

和大部分编程语言一样,YAML也支持注释的功能。在YAML中,注释以“#”开头,可以在行末或数据元素后面添加注释,以提高代码可读性。

name: John Smith # Person's name
age: 30 # Person's age
# Contact details
contact:
  email: john.smith@example.com # Person's email address
  phone: # Person's phone numbers
    home: 555-1234 # Home phone
    work: 555-5678 # Work phone

五、常见用途

YAML可以被广泛应用于各种场景中。比如,用于编写配置文件、构建配置文件(例如Docker Compose)、编写GitHub操作的配置文件、编写Kubernetes资源文件等等。

六、示例代码

下面是一个简单的Python例子,读取YAML文件并输出其中的姓名和年龄。

import yaml

with open("person.yaml", "r") as f:
    data = yaml.load(f, Loader=yaml.FullLoader)

print("Name: " + data["name"])
print("Age: " + str(data["age"]))