YAML格式文件规范学习

2024-06-15 07:48

本文主要是介绍YAML格式文件规范学习,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

1. 认识 YAML

  YAML(发音 /ˈjæməl/)是一个类似 XML、JSON 的数据序列化语言。其强调以数据为中心,旨在方便人类使用;并且适用于日常常见任务的现代编程语言。因而 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/>

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

  • 标量 (相当于数据类型)

  • 序列 (相当于数组和列表)

  • 键值表(相当于 Map 表)

2. YAML 编写规范

    它的基本语法规则如下:

          1)大小写敏感

          2)使用缩进表示层级关系

          3)缩进时不允许使用Tab键,只允许使用空格。

          4)缩进的空格数目不重要,只要相同层级的元素左侧对齐即可

 

  • 规范一:文档使用 Unicode 编码作为字符标准编码,例如 UTF-8

  • 规范二:使用“#”来表示注释内容

    # 客户订单
    date: 2015-02-01
    customer:- name: Jai
    items:- no: 1234         # 订单号- descript: cpu
    
  • 规范三:使用空格作为嵌套缩进工具。通常建议使用两个空格缩进,不建议使用 tab (甚至不支持)

  • 规范四:序列表示

    • 使用“-”(横线) + 单个空格表示单个列表项
      --- # 文档开始
      - 第一章 简介
      - 第二章 设计目录
      
    • 使用"[]"表示一组数据
      --- # 文档开始
      [blue, red, green]
      
    • 组合表示。每个结构都可以嵌套组成复杂的表示结构。
      --- # 文档开始
      - [blue, red, green]     # 列表项本身也是一个列表
      - [Age, Bag]
      - site: {osc:www.oschina.net, baidu: www.baidu.com}  # 这里是同 键值表 组合表示
  • 规范五:键值表

    • 使用 “:”(冒号) + 空格表示单个键值对
      # 客户订单
      date: 2015-02-01
      customer:- name: Jai
      items:- no: 1234         # 订单号- descript: cpu- price: ¥800.00
      
    • 使用"{}"表示一个键值表
      # 客户订单
      date: 2015-02-01
      customer:- name: Jai
      items: {no: 1234, descript: cpu, price: ¥800.00}
      
    • "? " 问号+空格表示复杂的键。当键是一个列表或键值表时,就需要使用本符号来标记。
       # 使用一个列表作为键? [blue, reg, green]: Color# 等价于? - blue- reg- gree: Color
      
    • 组合表示。每个结构都可以嵌套组成复杂的表示结构。 

       Color:- blue- red- green# 相当于 (也是 JSON 的表示){Color: [blue, red, green]}div:- border: {color: red, width: 2px}- background: {color: green}- padding: [0, 10px, 0, 10px]# 使用缩进表示的键值表与列表项items:- item: cpumodel: i3price: ¥800.00- item: HDmodel: WDprice: ¥450.00# 上面使用 “-” 前导与缩进来表示多个列表项,相当于下面的JSON表示items: [{item:cpu, model:i3, price:¥800.00}, {item:HD, model:WD, price: ¥450.00}]
      
  • 规范六:文本块

    • 使用 “|” 和文本内容缩进表示的块:保留块中已有的回车换行。相当于段落块

      yaml: |      # 注意 ":" 与 "|" 之间的空格JSON的语法其实是YAML的子集,大部分的JSON文件都可以被YAML的解释器解释。
    • 使用 “>” 和文本内容缩进表示的块:将块中回车替换为空格,最终连接成一行。

      yaml: >      # 注意 ":" 与 ">" 之间的空格,另外可以使用空行来分段落JSON的语法其实是YAML的子集,大部分的JSON文件都可以被YAML的解释器解释。
    • 使用定界符“”(双引号)、‘’(单引号)或回车表示的块:最终表示成一行。

      yaml:     # 使用回车的多行,最终连接成一行。JSON的语法其实是YAML的子集,大部分的JSON文件都可以被YAML的解释器解释。yaml:     # 使用了双引号,双引号的好处是可以转义,即在里面可以使用特殊符号"JSON的语法其实是YAML的子集,大部分的JSON文件都可以被YAML的解释器解释。"
      
  • 规范七:数据类型的约定

    • 对一些常用数据类型的表示格式进行了约定,包括:

       integer: 12345     # 整数标准形式octal: 0o34        # 八进制表示,第二个是字母 ohex: 0xFF          # 十六进制表示float: 1.23e+3     # 浮点数fixed: 13.67       # 固定小数minmin: -.inf      # 表示负无穷notNumber: .NaN    # 无效数字null:              # 空值boolean: [true, false] # 布尔值string: '12345'    # 字符串date: 2015-08-23   # 日期datetime: 2015-08-23T02:02:00.1z  # 日期时间iso8601: 2015-08-23t21:59:43.10-05:00  # iso8601 日期格式spaced: 2015-08-23 21:59:43.10 -5      # ?
      
    • “!”(叹号)显式指示类型,或自定义类型标识。单叹号通常是自定义类型,双叹号是内置类型

       isString: !!str 2015-08-23     # 强调是字符串不是日期数据picture: !!binary |            # Base64  图片R0lGODlhDAAMAIQAAP//9/X17unp5WZmZgAAAOfn515eXvPz7Y6OjuDg4J+fn5OTk6enp56enmleECcgggoBADs=#下面是内置类型!!int               # 整数类型!!float             # 浮点类型!!bool              # 布尔类型!!str               # 字符串类型!!binary            # 也是字符串类型!!timestamp         # 日期时间类型!!null              # 空值!!set               # 集合!!omap, !!pairs     # 键值列表或对象列表!!seq               # 序列,也是列表!!map               # 键值表#下面是一些例子:--- !!omap- Mark: 65- Sammy: 63- Key: 58--- !!set           # 注意,“?”表示键为列表,在这里列表为 null? Mark? Sammy? Key# 下面是自定义的类型或标识%TAG ! tag:clarkevans.com,2002:   # % 是指令符号--- !shape# Use the ! handle for presenting# tag:clarkevans.com,2002:circle- !circlecenter: &ORIGIN {x: 73, y: 129}radius: 7- !linestart: *ORIGINfinish: { x: 89, y: 102 }- !labelstart: *ORIGINcolor: 0xFFEEBBtext: Pretty vector drawing.
      
  • 规范八:锚点与引用,定义数据的复用。

    • 第一步:使用 “&” 定义数据锚点(即要复制的数据)
    • 第二步:使用 “*” 引用上述锚点数据(即数据的复制目的地)
       ---hr:- Mark McGwire# Following node labeled SS- &SS Sammy Sosa            # 定义要复制的数据rbi:- *SS # Subsequent occurrence   这里是数据复制目标- Ken Griffey
      详尽语法见官网:http://www.yaml.org/spec/1.2/spec.html

这篇关于YAML格式文件规范学习的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1062850

相关文章

HarmonyOS学习(七)——UI(五)常用布局总结

自适应布局 1.1、线性布局(LinearLayout) 通过线性容器Row和Column实现线性布局。Column容器内的子组件按照垂直方向排列,Row组件中的子组件按照水平方向排列。 属性说明space通过space参数设置主轴上子组件的间距,达到各子组件在排列上的等间距效果alignItems设置子组件在交叉轴上的对齐方式,且在各类尺寸屏幕上表现一致,其中交叉轴为垂直时,取值为Vert

Ilya-AI分享的他在OpenAI学习到的15个提示工程技巧

Ilya(不是本人,claude AI)在社交媒体上分享了他在OpenAI学习到的15个Prompt撰写技巧。 以下是详细的内容: 提示精确化:在编写提示时,力求表达清晰准确。清楚地阐述任务需求和概念定义至关重要。例:不用"分析文本",而用"判断这段话的情感倾向:积极、消极还是中性"。 快速迭代:善于快速连续调整提示。熟练的提示工程师能够灵活地进行多轮优化。例:从"总结文章"到"用

【前端学习】AntV G6-08 深入图形与图形分组、自定义节点、节点动画(下)

【课程链接】 AntV G6:深入图形与图形分组、自定义节点、节点动画(下)_哔哩哔哩_bilibili 本章十吾老师讲解了一个复杂的自定义节点中,应该怎样去计算和绘制图形,如何给一个图形制作不间断的动画,以及在鼠标事件之后产生动画。(有点难,需要好好理解) <!DOCTYPE html><html><head><meta charset="UTF-8"><title>06

学习hash总结

2014/1/29/   最近刚开始学hash,名字很陌生,但是hash的思想却很熟悉,以前早就做过此类的题,但是不知道这就是hash思想而已,说白了hash就是一个映射,往往灵活利用数组的下标来实现算法,hash的作用:1、判重;2、统计次数;

零基础学习Redis(10) -- zset类型命令使用

zset是有序集合,内部除了存储元素外,还会存储一个score,存储在zset中的元素会按照score的大小升序排列,不同元素的score可以重复,score相同的元素会按照元素的字典序排列。 1. zset常用命令 1.1 zadd  zadd key [NX | XX] [GT | LT]   [CH] [INCR] score member [score member ...]

MySQL高性能优化规范

前言:      笔者最近上班途中突然想丰富下自己的数据库优化技能。于是在查阅了多篇文章后,总结出了这篇! 数据库命令规范 所有数据库对象名称必须使用小写字母并用下划线分割 所有数据库对象名称禁止使用mysql保留关键字(如果表名中包含关键字查询时,需要将其用单引号括起来) 数据库对象的命名要能做到见名识意,并且最后不要超过32个字符 临时库表必须以tmp_为前缀并以日期为后缀,备份

【机器学习】高斯过程的基本概念和应用领域以及在python中的实例

引言 高斯过程(Gaussian Process,简称GP)是一种概率模型,用于描述一组随机变量的联合概率分布,其中任何一个有限维度的子集都具有高斯分布 文章目录 引言一、高斯过程1.1 基本定义1.1.1 随机过程1.1.2 高斯分布 1.2 高斯过程的特性1.2.1 联合高斯性1.2.2 均值函数1.2.3 协方差函数(或核函数) 1.3 核函数1.4 高斯过程回归(Gauss

【学习笔记】 陈强-机器学习-Python-Ch15 人工神经网络(1)sklearn

系列文章目录 监督学习:参数方法 【学习笔记】 陈强-机器学习-Python-Ch4 线性回归 【学习笔记】 陈强-机器学习-Python-Ch5 逻辑回归 【课后题练习】 陈强-机器学习-Python-Ch5 逻辑回归(SAheart.csv) 【学习笔记】 陈强-机器学习-Python-Ch6 多项逻辑回归 【学习笔记 及 课后题练习】 陈强-机器学习-Python-Ch7 判别分析 【学

系统架构师考试学习笔记第三篇——架构设计高级知识(20)通信系统架构设计理论与实践

本章知识考点:         第20课时主要学习通信系统架构设计的理论和工作中的实践。根据新版考试大纲,本课时知识点会涉及案例分析题(25分),而在历年考试中,案例题对该部分内容的考查并不多,虽在综合知识选择题目中经常考查,但分值也不高。本课时内容侧重于对知识点的记忆和理解,按照以往的出题规律,通信系统架构设计基础知识点多来源于教材内的基础网络设备、网络架构和教材外最新时事热点技术。本课时知识

线性代数|机器学习-P36在图中找聚类

文章目录 1. 常见图结构2. 谱聚类 感觉后面几节课的内容跨越太大,需要补充太多的知识点,教授讲得内容跨越较大,一般一节课的内容是书本上的一章节内容,所以看视频比较吃力,需要先预习课本内容后才能够很好的理解教授讲解的知识点。 1. 常见图结构 假设我们有如下图结构: Adjacency Matrix:行和列表示的是节点的位置,A[i,j]表示的第 i 个节点和第 j 个