当前位置:网站首页 > 技术博客 > 正文

yml文件格式要求



1. 认识 YAML

  YAML是一个类似 XML、JSON 的标记性语言。YAML 强调以数据为中心,并不是以标识语言为重点。因而 YAML 本身的定义比较简单,号称“一种人性化的数据格式语言”。

1.1 YAML 的设计目标:
  • 人类容易阅读
  • 可用于不同程序间的数据交换
  • 适合描述程序所使用的数据结构,特别是脚本语言
  • 丰富的表达能力与可扩展性
  • 易于使用
1.2 YAML 与 XML、JSON
  • YAML 与 XML
    • 具有 XML 同样的优点,但比 XML 更加简单、敏捷等
  • YAML 与 JSON
    • JSON 可以看作是 YAML 的子集,也就是说 JSON 能够做的事情,YAML 也能够做
    • YAML 能表示得比 JSON 更加简单和阅读,例如“字符串不需要引号”。所以 YAML 容易可以写成 JSON 的格式,但并不建议这种做
    • YAML 能够描述比 JSON 更加复杂的结构,例如“关系锚点”可以表示数据引用(如重复数据的引用)。
1.3 YAML 组织结构

  YAML 文件可以由一或多个文档组成(也即相对独立的组织结构组成),文档间使用“---”(三个横线)在每文档开始作为分隔符。同时,文档也可以使用“...”(三个点号)作为结束符(可选)。如下图所示:

文档示图

<br/>

  • 如果只是单个文档,分隔符“---”可省略。
  • 每个文档并不需要使用结束符“...”来表示结束,但是对于网络传输或者流来说,作为明确结束的符号,有利于软件处理。(例如不需要知道流关闭就能知道文档结束) <br/>

  YAML 认为数据由以下三种结构组成:(每个文档由三种结构混合组成)

  • 标量 (相当于数据类型)
  • 序列 (相当于数组和列表)
  • 键值表(相当于 Map 表)

2. YAML 编写规范

  • 规范一:文档使用 Unicode 编码作为字符标准编码,例如 UTF-8
  • 规范二:使用“#”来表示注释内容
  • 规范三:使用空格作为嵌套缩进工具。通常建议使用两个空格缩进,不建议使用 tab (甚至不支持)
  • 规范四:序列表示
    • 使用“-”(横线) + 单个空格表示单个列表项
    • 使用"[]"表示一组数据
    • 组合表示。每个结构都可以嵌套组成复杂的表示结构。
  • 规范五:键值表
    • 使用 “:”(冒号) + 空格表示单个键值对
    • 使用"{}"表示一个键值表
    • "? " 问号+空格表示复杂的键。当键是一个列表或键值表时,就需要使用本符号来标记。
    • 组合表示。每个结构都可以嵌套组成复杂的表示结构。
  • 规范六:文本块
    • 使用 “|” 和文本内容缩进表示的块:保留块中已有的回车换行。相当于段落块
    • 使用 “>” 和文本内容缩进表示的块:将块中回车替换为空格,最终连接成一行。
    • 使用定界符“”(双引号)、‘’(单引号)或回车表示的块:最终表示成一行。
  • 规范七:数据类型的约定
    • 对一些常用数据类型的表示格式进行了约定,包括:
    • “!”(叹号)显式指示类型,或自定义类型标识。单叹号通常是自定义类型,双叹号是内置类型
  • 规范八:锚点与引用,定义数据的复用。
    • 第一步:使用 “&” 定义数据锚点(即要复制的数据)
    • 第二步:使用 “*” 引用上述锚点数据(即数据的复制目的地)

版权声明


相关文章:

  • java map集合排序2025-07-15 21:01:02
  • stream.of方法2025-07-15 21:01:02
  • 破解手机锁屏密码的方法是什么?2025-07-15 21:01:02
  • 梯度提升树分类算法2025-07-15 21:01:02
  • python爬虫爬取网页所有数据2025-07-15 21:01:02
  • 单片机c语言编程入门2025-07-15 21:01:02
  • date函数举例2025-07-15 21:01:02
  • makefile error32025-07-15 21:01:02
  • 线程同步方法有几种2025-07-15 21:01:02
  • ajax中6种请求方式2025-07-15 21:01:02