YAML教程

YAML是“YAML Is not markup language”的缩写形式,是一种数据序列化语言,设计为人性化的,并且适用于其他编程语言的日常任务。本教程详细介绍了一些重要的神经语言编程技巧。

面向读者

本教程的目标读者包括使用JSON和XML文件进行配置设置的Web开发人员。 任何打算以人类可读的结构化数据格式编写标记的程序员也可以学习YAML。

前提条件

本教程的先决条件包括HTML,XML和JSON的基本知识。 YAML专门针对常见用例(如配置文件,日志文件和跨语言共享文件以及数据共享)而设计。

问题反馈

我们不能保证您在学习此Yaml教程的过程中不会遇到任何问题。本教程中的讲解,示例和代码等只是根据作者的理解来概括写出。由于作者水平和能力有限,因此不保正所有编写的文章都准确无误。但是如果有遇到任何错误或问题,请反馈给我们,我们会及时纠正以方便后续读者阅读。

快速入门

下面展示YAML最基本,最常用的一些使用格式:
首先YAML中允许表示三种格式,分别是常量值,对象和数组
例如:

#即表示url属性值;
url: http://www.vcclass.net
#即表示server.host属性的值;
server:
    host: http://www.vcclass.net
#数组,即表示server为[a,b,c]
server:
    - 120.168.0.21
    - 120.168.0.22
    - 120.168.0.23
#常量
pi: 3.14   #定义一个数值3.14
hasChild: true  #定义一个boolean值
name: '你好YAML'   #定义一个字符串

注释

properties文件格式相同,使用#作为注释开始,YAML中只有行注释。

基本格式要求 -

  1. YAML大小写敏感;
  2. 使用缩进代表层级关系;
  3. 缩进只能使用空格,不能使用TAB,不要求空格个数,只需要相同层级左对齐(一般2个或4个空格)

对象

使用冒号代表,格式为key: value。冒号后面要加一个空格:

key: value

可以使用缩进表示层级关系;

key: 
    child-key: value
    child-key2: value2

YAML中还支持流式(flow)语法表示对象,比如上面例子可以写为:

key: {child-key: value, child-key2: value2}

较为复杂的对象格式,可以使用问号加一个空格代表一个复杂的key,配合一个冒号加一个空格代表一个值(value)。

?  
    - complexkey1
    - complexkey2
:
    - complexvalue1
    - complexvalue2

表示对象的属性是一个数组[complexkey1,complexkey2],对应的值也是一个数组[complexvalue1,complexvalue2]

数组

使用一个短横线加一个空格代表一个数组项:

hobby:
    - Java
    - LOL

当然也可以有这样的写法:

-
    - Java
    - LOL

可以简单理解为:[[Java,LOL]]
一个相对复杂的例子:

companies:
    -
        id: 1
        name: company1
        price: 200W
    -
        id: 2
        name: company2
        price: 500W

表示是companies属性是一个数组,每一个数组元素又是由id,name,price三个属性构成;
数组也可以使用流式(flow)的方式表示:

常量

YAML中提供了多种常量结构,包括:整数,浮点数,字符串,NULL,日期,布尔,时间。下面使用一个例子来快速了解常量的基本使用:

boolean: 
    - TRUE  #true,True都可以
    - FALSE  #false,False都可以
float:
    - 3.14
    - 6.8523015e+5  #可以使用科学计数法
int:
    - 123
    - 0b1010_0111_0100_1010_1110    #二进制表示
null:
    nodeName: 'node'
    parent: ~  #使用~表示null
string:
    - 哈哈
    - 'Hello world'  #可以使用双引号或者单引号包裹特殊字符
    - newline
      newline2    #字符串可以拆成多行,每一行会被转化成一个空格
date:
    - 2018-07-17    #日期必须使用ISO 8601格式,即yyyy-MM-dd
datetime: 
    -  2018-07-17T19:02:31+08:00    #时间使用ISO 8601格式,时间和日期之间使用T连接,最后使用+代表时区

一些特殊符号

YAML中提供了很多特殊符号,在这里简单介绍常用的一些:
第1种--- YAML可以在同一个文件中,使用—-表示一个文档的开始;比如Springboot中profile的定义:

server:
    address: 192.168.1.100
---
spring:
    profiles: development
    server:
        address: 127.0.0.1
---
spring:
    profiles: production
    server:
        address: 192.168.1.120

代表定义了两个profile,一个是development,一个production;也常常使用---来分割不同的内容,比如记录日志:

---
Time: 2018-07-17T15:02:31+08:00
User: ed
Warning:
     This is an error message for the log file
---
Time: 2018-07-17T15:05:21+08:00
User: ed
Warning:
    A slightly different error message.

第2种...---配合使用,在一个配置文件中代表一个文件的结束:

---
time: 20:03:20
player: Sammy Sosa
action: strike (miss)
...
---
time: 20:03:47
player: Sammy Sosa
action: grand slam
...

相当于在一个yaml文件中连续写了两个yaml配置项。

第3种!! YAML中使用!!做类型强行转换:

string:
    - !!str 54321
    - !!str true

相当于把数字和布尔类型强转为字符串。当然允许转型的类型很多,比如:

--- !!set
- Mark McGwire: 65
- Sammy Sosa: 63
- Sammy Sosa: 63
- Ken Griffy: 58

将数组解析为set,简单理解,转化的内容就是:[{Ken Griffy=58}, {Mark McGwire=65}, {Sammy Sosa=63}],重复的Sammy Sosa去掉;

第4种>在字符串中折叠换行,| 保留换行符,这两个符号是YAML中字符串经常使用的符号,比如:

accomplishment: >
 Mark set a major league
 home run record in 1998.
stats: |
 65 Home Runs
 0.278 Batting Average

那么结果是:

stats=65 Home Runs
 0.278 Batting Average,

| 符号保留了换行符,而accomplishment的结果为:

accomplishment=Mark set a major league home run record in 1998.

即将换行符转化成了空格;要注意一点的是,每行的文本前一定要有一个空格。
|符号常见用于在YAML中配置HTML片段:

phraseTemplate: |
  <p style="color: red">
    some template ${msg}
  </p>

第5种,引用。重复的内容在YAML中可以使用&来完成锚点定义,使用*来完成锚点引用,例如:

hr:
- Mark McGwire
- &SS Sammy Sosa
rbi:
- *SS 
- Ken Griffey

可以看到,在hr中,使用&SS为Sammy Sosa设置了一个锚点(引用),名称为SS,在rbi中,使用*SS完成了锚点使用,那么结果为:

{rbi=[Sammy Sosa, Ken Griffey], hr=[Mark McGwire, Sammy Sosa]}

也可以这样定义:

SS: &SS Sammy Sosa
hr:
 - Mark McGwire
 - *SS
rbi:
 - *SS 
 - Ken Griffey

第6种,合并内容。主要和锚点配合使用,可以将一个锚点内容直接合并到一个对象中。来看一个示例:

merge:
  - &CENTER { x: 1, y: 2 }
  - &LEFT { x: 0, y: 2 }
  - &BIG { r: 10 }
  - &SMALL { r: 1 }

sample1: 
    <<: *CENTER
    r: 10

sample2:
    << : [ *CENTER, *BIG ]
    other: haha

sample3:
    << : [ *CENTER, *BIG ]
    r: 100

在merge中,定义了四个锚点,分别在sample中使用。
sample1中,<<: *CENTER意思是引用{x: 1,y: 2},并且合并到sample1中,那么合并的结果为:sample1={r=10, y=2, x=1}

sample2中,<<: [*CENTER, *BIG] 意思是联合引用{x: 1,y: 2}{r: 10},并且合并到sample2中,那么合并的结果为:sample2={other=haha, x=1, y=2, r=10}

sample3中,引入了*CENTER, *BIG,还使用了r: 100覆盖了引入的r: 10,所以sample3值为:sample3={r=100, y=2, x=1}

有了合并,就可以在配置中把相同的基础配置抽取出来,在不同的子配置中合并引用即可。


猿狮妹
2022-12-01
YAML教程 YAML 教程 编程课程
热门教程
1 YAML注释 既然对YAML的语法和基础知识感到满意,那么进一步了解它的细节。在本章中,将了解如何在YAML中使用注释。YAML支持单行注释。 下面借助一个例子来解释其结构 -# this is single line comment.YAML不支持多行注释。 如果要为多行提供注释,可以执行此操作,如下例所示 -# this# is a multiple# line comment注释的特点YAML中评论的特征如下 - 执行期间会跳过注释的块。注释有助于添加指定代码块...
2 YAML教程 YAML是“YAML Is not markup language”的缩写形式,是一种数据序列化语言,设计为人性化的,并且适用于其他编程语言的日常任务。
3 YAML缩进和分离 当学习任何编程语言时,缩进和分离是两个主要概念。本章详细讨论了与YAML相关的这两个概念。YAML的缩进YAML不包括任何强制性空格。此外,没有必要保持一致。有效的YAML缩进如下所示 -a: b: - c - d - ef: "ghi"在YAML中使用缩进时,应该记住以下规则:流块必须至少包含一些具有周围当前块级别的空格。YAML的流含量跨越多条线。流内容以{或[开头。阻止列表项包括与周...
4 YAML标量和标签 YAML中的标量使用文字类型以块格式编写,表示为(|)。 它表示换行计数。 在YAML中,标量以折叠样式(>)书写,其中每一行表示折叠空间,其以空行或更多缩进行结束。文字中保留的新行如下所示 -ASCII Art--- |\//||\/||// || ||__折叠的换行符将保留为更多缩进的行和空白行,如下所示 ->Sammy Sosa completed anotherfine season with great stats.63 Home ...
5 YAML故障安全模式 YAML模式被定义为一组标签的组合,并包括用于解析非特定标签的机制。 YAML中的故障安全模式以这样的方式创建,即它可以与任何YAML文档一起使用。 它也被视为通用YAML文档的推荐架构。类型故障安全模式有两种类型:通用映射和通用序列。通用映射它代表一个关联容器。 这里,每个键在关联中是唯一的,并且映射到恰好一个值。 YAML对键定义没有任何限制。下面给出了表示通用映射的示例 -Clark : EvansIngy : döt NetOren : Ben-Kiki...
6 YAML完整长度示例 以下完整长度示例指定YAML的构造,其中包括符号和各种表示,这些表示在以JSON格式转换或处理它们时将非常有用。 这些属性在JSON文档中也称为键名。 这些符号是出于安全目的而创建的。上述YAML格式表示具有各种其他属性的默认值,适配器和主机的各种属性。 YAML还会记录生成的每个文件,这些文件会保留生成的错误消息的跟踪。 在以JSON格式转换指定的YAML文件时,得到所需的输出,如下所述 -defaults: &defaults adapter: pos...
7 YAML字符流 在YAML中,将了解如下各种字符流 - 指令文件边界标记文件完整流在本章中,将详细介绍和学习它们。1. 指令指令是YAML处理器中使用的基本指令。 指令是表示详细信息,如注释,不会反映在序列化树中。 在YAML中,无法定义私有指令。 本节讨论各种类型的指令及相关示例 -保留指令保留指令初始化为三个连字符(---),如下例所示。 保留的指令将转换为JSON的特定值。%YAML 1.1--- !!str”foo”...
8 YAML集合和结构 YAML包括使用缩进范围的块集合。 在这里,每个条目都以一个新行开头。 集合中的块序列表示每个条目带有破折号和空格( - )。 在YAML中,块集合样式不由任何特定指示符表示。 YAML中的块集合可以与其他标量数量区分开来,并且包含其中包含的键值对的标识。映射是JSON结构中包含的键值的表示。 它经常用于多语言支持系统以及在移动应用程序中创建API。 映射使用键值对表示以及冒号和空格(:)的使用。示例考虑一系列标量的例子,例如球员名单如下所示 -...
9 YAML块样式 YAML包括两种块标量样式:字面和折叠。块标量由少量指标控制,标题在内容本身之前。 块标量头的示例如下 -%YAML 1.2---!!seq [ !!str ”literal ”, !!str ”·folded ”, !!str ”keep ”, !!str ”·strip”,]具有默认行为的JSON格式输出如下 -[ ”litera...
10 YAML流程 YAML遵循流程的标准程序。YAML中的本机数据结构包括简单表示,例如:节点。 它也称为表示节点图。它包括映射,序列和标量,正在序列化以创建序列化树。通过序列化,对象将使用字节流进行转换。序列化事件树有助于创建字符流的表示,反向过程将字节流解析为序列化事件树。 之后节点将转换为节点图。之后在YAML本机数据结构中转换这些值。 如下图解释 -...
  • Copyright © 2021 猿狮院, All rights reserved.