首页云计算正文

什么是YAML？为什么要使用YAML？

admin

2025-02-06 2 0条评论

YAML 代表“YAML 不是标记语言”，是一种人类可读的数据序列化标准，常用于配置文件和具有不同数据结构的语言之间的数据交换。它设计简单易懂，是开发人员和系统管理员的热门选择。

什么是YAML？

YAML 是一种强调易读性的数据序列化语言。与可能变得复杂且难以阅读的 XML 或 JSON 不同，YAML 使用简单、直观且富有表现力的语法。这使其成为配置文件和数据交换格式的绝佳选择，因为易用性和清晰度是首要考虑因素。

为什么使用 YAML？

YAML 被广泛使用的原因有以下几个：

可读性：YAML 的语法清晰易读，易于编写和理解。这种可读性降低了出错的可能性，并使维护更加容易。

灵活性：YAML 支持复杂的数据结构，包括嵌套数据，使其适用于各种应用程序。

兼容性：YAML 与许多编程语言兼容，包括 Python、Ruby 和 JavaScript。这使得它很容易集成到现有项目中。

最小语法：YAML 使用缩进和简单的语法规则，减少了标点符号和其他特殊字符的需要，使文件更简洁、更易于维护。

总之，YAML 注重可读性、灵活性和最小语法，使其成为寻求简单但功能强大的配置和数据序列化格式的开发人员和系统管理员的理想选择。

YAML 的基本语法

了解 YAML 的基本语法对于有效地创建和管理 YAML 文件至关重要。YAML 的语法设计为易于阅读和编写，注重简单性和清晰度。

结构和缩进

YAML 严重依赖缩进来表示数据的结构和层次结构。与使用括号或方括号的其他格式不同，YAML 使用空格来表示嵌套级别。以下是需要记住的一些要点：

缩进：使用空格而不是制表符进行缩进。整个文档中使用的空格数必须一致。
嵌套结构：缩进表示嵌套结构，就像 Python 处理它们的方式一样。

例子：

person:
  name: John Doe
  age: 30
  address:
    street: 123 Main St
    city: Anytown

在此示例中，姓名、年龄和地址是人员键下的键，街道和城市是地址键下的键。

键和值

在 YAML 中，数据以键值对的形式表示。键始终是字符串，值可以是各种数据类型，包括字符串、数字、列表和字典。

例子：

key: value

键和值以冒号和空格分隔。键在同一层级内必须是唯一的。

YAML 中的注释

在 YAML 中，注释以 # 字符开头并延伸到行尾。注释可用于在 YAML 文件中添加注释或说明。

例子：

# This is a comment
key: value  # This is an inline comment

标量（字符串、数字、布尔值）

标量是单个不可分割的值，例如字符串、数字和布尔值。YAML 支持多种定义标量值的方式：

字符串：字符串可以用引号引起来，也可以直接写出来。

plain_string: Hello, World! 

quoted_string: "Hello, World!"

数字：数字可以清楚地书写。

integer: 123 

float: 123.45

布尔值：布尔值可以是真或假。

boolean: true

通过了解这些基本语法规则，您可以开始有效地创建和管理 YAML 文件。YAML 的简单性和可读性使其成为配置和数据序列化的强大工具。

YAML 数据类型

YAML 支持多种数据类型，因此能够处理复杂的数据结构。了解这些数据类型对于在项目中有效使用 YAML 至关重要。

标量

标量是 YAML 中最基本的数据类型，包括字符串、数字和布尔值。它们表示单个不可分割的值。

字符串：字符串可以带引号也可以不带引号。双引号允许使用特殊字符，而单引号更适用于文字。

plain_string: Hello, World!
quoted_string: "Hello, World!"
single_quoted_string: 'Hello, World!'

数字：数字不带引号，可以是整数或浮点值。

integer: 123
float: 123.45

布尔值：布尔值写为真或假。

boolean_true: true 
boolean_false: false

序列（列表）

YAML 中的序列是项目的集合。它们使用破折号后跟空格来定义，并且每个项目都位于新行上，并且缩进级别相同。

例子：

fruits:
  - Apple
  - Orange
  - Banana

在这个例子中，fruits 是一个带有字符串值列表的键。

映射（字典）

映射，也称为字典，是键值对的集合。它们使用缩进来定义，以表示嵌套结构。

例子：

person:
  name: Jane Doe
  age: 25
  contact:
    email: jane.doe@example.com
    phone: 123-456-7890

这里，person 是一个带有嵌套键值对的键，contact 是 person 内的嵌套字典。

空值

YAML 还可以使用 null 或 ~ 表示空值。

例子：

unknown: null
missing: ~

了解这些数据类型有助于您充分利用 YAML 的数据表示功能。无论您是定义简单的键值对还是复杂的嵌套结构，YAML 灵活且易读的语法使其成为许多应用程序的理想选择。

创建和使用 YAML 文件

创建和使用 YAML 文件涉及在文本编辑器中编写 YAML 内容，然后使用编程语言（例如 Python）读取或解析该文件。本部分将指导您了解编写和读取 YAML 文件的基础知识。

编写 YAML 文件

要创建 YAML 文件，请按照以下步骤操作：

选择文本编辑器：使用支持 YAML 语法突出显示的文本编辑器，可提高可读性并减少错误。示例包括 VSCode、Sublime Text 和 Notepad++。

创建 YAML 内容：按照前面讨论的语法规则编写 YAML 内容。

例子：

person:
  name: John Doe
  age: 30
  contact:
    email: john.doe@example.com
    phone: 123-456-7890

保存文件：使用 .yaml 或 .yml 扩展名保存文件。例如，example.yaml。

在 Python 中读取 YAML 文件

Python 的 PyYAML 库使读写 YAML 文件变得容易。下面是一个如何在 Python 中读取 YAML 文件的简单示例。

安装 PyYAML：首先，如果您还没有安装 PyYAML 库，则需要安装它。

pip install pyyaml

读取 YAML 文件：使用以下 Python 代码读取 YAML 文件。

例子：

import yaml

# Open the YAML file
with open('example.yaml', 'r') as file:
    # Load the YAML content
    data = yaml.safe_load(file)

# Print the loaded data
print(data)

在此示例中，yaml.safe_load() 函数读取 YAML 内容并将其转换为 Python 字典。

使用 Python 编写 YAML 文件

您还可以使用 PyYAML 库将数据写入 YAML 文件。操作方法如下：

例子：

import yaml

# Define data to be written to YAML
data = {
    'person': {
        'name': 'John Doe',
        'age': 30,
        'contact': {
            'email': 'john.doe@example.com',
            'phone': '123-456-7890'
        }
    }
}

# Write the data to a YAML file
with open('output.yaml', 'w') as file:
    yaml.dump(data, file)

在此示例中，yaml.dump() 函数将 Python 字典写入 YAML 文件。

YAML 与 JSON

YAML 和 JSON 都是广泛使用的数据序列化和配置文件格式。虽然它们有一些相似之处，但也存在明显差异。下面的比较表突出显示了 YAML 和 JSON 之间的主要差异。

特征	YAML	JSON
可读性	高度可读且人性化	由于大量使用大括号和方括号，可读性较差
句法	使用缩进和空格，避免使用逗号和括号等特殊字符	使用括号 {}、方括号 [] 和逗号 , 来表示结构
数据类型	支持复杂数据类型，包括引用和多行字符串	支持字符串、数字、数组和对象等基本数据类型
使用案例	非常适合面向人的应用程序中的配置文件和数据序列化	常用于 Web 服务之间的 API 和数据交换
文件大小	由于增加了额外的格式以提高可读性，因此通常较大	更紧凑，数据传输更高效
评论	支持#注释	本身不支持评论
学习曲线	对于熟悉 Python 缩进的人来说很容易学习	语法简单，但由于格式要求严格，不太直观
灵活性	高度灵活，支持各种数据结构	灵活性较差但标准化程度较高

何时使用 YAML 与 JSON

使用 YAML：

当你需要一种可读可写的配置文件格式时。
对于复杂的数据结构，可受益于 YAML 的灵活语法。
当使用面向人的应用程序时，清晰度至关重要。

使用 JSON：

用于 Web API 和客户端与服务器之间的数据交换。
当使用需要轻量级和直接数据序列化的应用程序时。
在严格语法和易于机器解析是优先事项的场景中。

在 YAML 和 JSON 之间进行选择取决于项目的具体要求。YAML 因其可读性和灵活性而受到青睐，使其适合配置文件和人类可读的数据。另一方面，JSON 因其在数据交换方面的简单性和效率而被广泛用于 Web 开发。

结论

YAML 是一种功能强大且灵活的数据序列化语言，可读性和简单性都非常出色。其极简的语法和缩进的使用使其成为配置文件、数据序列化和各种其他需要人类可读性的应用程序的理想选择。

关于 YAML 要记住的要点

可读性：YAML 的语法干净且易于理解，从而减少了错误并简化了维护。
灵活性：YAML 支持复杂的数据结构，包括嵌套对象、列表和字典。
兼容性：YAML 在许多编程语言中得到广泛支持，因此很容易集成到现有项目中。
用例：YAML 特别适合配置文件、文档存储和数据序列化。

无论您是 Linux 系统管理员、程序员还是开发人员，掌握 YAML 都可以显著提高您高效管理和配置应用程序的能力。通过利用 YAML 的优势，您可以创建更易于维护和可读的配置，确保工作流程更顺畅，项目间协作更好。

打赏

海报

文章版权及转载声明

本文作者：admin 网址：http://news.edns.com/post/312730.html 发布于 2025-02-06
文章转载或复制请以超链接形式并注明出处。