### 彪哥

爱好前端

- 技术文档

  - Git使用手册
  - Markdown使用教程
  - npm常用命令
  - npm packageJson属性详解
  - yaml语言教程
    - 简介
    - 基本语法
    - 数据类型
    - YAML 对象
    - YAML 数组
    - 复合结构（对象和数组组合）
    - 纯量
    - 转换数据格式
    - 锚点引用
  - Git修改分支名

- GitHub技巧

- Nodejs

- 博客搭建

- 技术
- 技术文档

heBody
2019-12-25
目录

# yaml语言教程

# # yaml语言教程

## # 简介

YAML 是 "YAML Ain't a Markup Language"（YAML 不是一种标记语言）的递归缩写。在开发的这种语言时，YAML 的意思其实是："Yet Another Markup Language"（仍是一种标记语言）。

YAML 的语法和其他高级语言类似，并且可以简单表达清单、散列表，标量等数据形态。它使用空白符号缩进和大量依赖外观的特色，特别适合用来表达或编辑数据结构、各种配置文件、倾印调试内容、文件大纲（例如：许多电子邮件标题格式和YAML非常接近）。

YAML 的配置文件后缀为 .yml，如：runoob.yml 。

> yaml常用来用作配置文件，和json类似

## # 基本语法

- 大小写敏感

- 使用缩进表示层级关系

- 缩进不允许使用tab，只允许空格

- 缩进的空格数不重要，只要相同层级的元素左对齐即可

- '#'表示注释

## # 数据类型

YAML 支持以下几种数据类型：

- 对象：键值对的集合，又称为映射（mapping）/ 哈希（hashes） / 字典（dictionary）
- 数组：一组按次序排列的值，又称为序列（sequence） / 列表（list）
- 纯量（scalars）：单个的、不可再分的值

## # YAML 对象

对象的几种表示形式：

1、对象键值对使用冒号结构表示 key: value，冒号后面要加一个空格。

    key: value

1

2、也可以使用 key:{key1: value1, key2: value2, ...}。

    key:{child-key1:value1,child-key2:value2}

1

3、还可以使用缩进表示层级关系；

    key:
        child-key1: value1
        child-key2: value2

1
2
3

同2，只是表示形式不同。

4、较为复杂的对象格式，可以使用问号加一个空格代表一个复杂的 key，配合一个冒号加一个空格代表一个 value：

    ?
        - complexkey1
        - complexkey2
    :
        - complexvalue1
        - complexvalue2

1
2
3
4
5
6

意思即对象的属性是一个数组 [complexkey1,complexkey2]，对应的值也是一个数组 [complexvalue1,complexvalue2]

## # YAML 数组

以 - 开头的行表示构成一个数组：

    - A
    - B
    - C

1
2
3

YAML 支持多维数组，可以使用行内表示：

    key: [value1, value2, ...]

1

数据结构的子成员是一个数组，则可以在该项下面缩进一个空格。

    -
     - A
     - B
     - C

1
2
3
4

一个相对复杂的例子：

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

1
2
3
4
5
6
7
8
9

意思是 companies 属性是一个数组，每一个数组元素又是由 id、name、price 三个属性构成。

数组也可以使用流式(flow)的方式表示：

    companies: [{id: 1,name: company1,price: 200W},{id: 2,name: company2,price: 500W}]

1

## # 复合结构（对象和数组组合）

数组和对象可以构成复合结构，例：

    languages:
      - Ruby
      - Perl
      - Python
    websites:
      YAML: yaml.org
      Ruby: ruby-lang.org
      Python: python.org
      Perl: use.perl.org

1
2
3
4
5
6
7
8
9

转换为 js 为：

    {
      languages: [ 'Ruby', 'Perl', 'Python'],
      websites: {
        YAML: 'yaml.org',
        Ruby: 'ruby-lang.org',
        Python: 'python.org',
        Perl: 'use.perl.org'
      }
    }

1
2
3
4
5
6
7
8
9

## # 纯量

纯量是最基本的，不可再分的值，包括：

- 字符串
- 布尔值
- 整数
- 浮点数
- Null
- 时间
- 日期

使用一个例子来快速了解纯量的基本使用：

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

多行字符串可以使用`|`保留换行符，也可以使用`>`折叠换行。

    this: |
      Foo
      Bar
    that: >
      Foo
      Bar

1
2
3
4
5
6

转为js代码如下。

    { this: 'Foo\nBar\n', that: 'Foo Bar\n' }

1

`+`表示保留文字块末尾的换行，`-`表示删除字符串末尾的换行。

    s1: |
      Foo

    s2: |+
      Foo

    s3: |-
      Foo

1
2
3
4
5
6
7
8
9

转为json代码如下

    { s1: 'Foo\n', s2: 'Foo\n\n\n', s3: 'Foo' }

1

字符串之中可以插入 HTML 标记。

    message: |
      <p style="color: red">
        段落
      </p>

1
2
3
4

## # 转换数据格式

允许使用两个感叹号，强制转换数据类型。

    e: !!str 123
    f: !!str true

1
2

转换js结果同：

    { e: '123', f: 'true' }

1

## # 锚点引用

& 锚点和< span class="marked">* 别名，可以用来引用:

    defaults: &defaults # 添加锚点
      adapter:  postgres
      host:     localhost

    development:
      database: myapp_development
      <<: *defaults # <<表示合并，*引用锚点

    test:
      database: myapp_test
      <<: *defaults # <<表示合并，*引用锚点

1
2
3
4
5
6
7
8
9
10
11

相当于:

    defaults:
      adapter:  postgres
      host:     localhost

    development:
      database: myapp_development
      adapter:  postgres
      host:     localhost

    test:
      database: myapp_test
      adapter:  postgres
      host:     localhost

1
2
3
4
5
6
7
8
9
10
11
12
13

& 用来建立锚点（defaults），<< 表示合并到当前数据，***** 用来引用锚点。

下面是另一个例子:

    - &showell Steve
    - Clark
    - Brian
    - Oren
    - *showell

1
2
3
4
5

转为js代码如下:

    [ 'Steve', 'Clark', 'Brian', 'Oren', 'Steve' ]

1

> 参考：

> - yaml官网：https://yaml.org/
>   (opens new window)
> - yaml与js的转换demo：http://nodeca.github.io/js-yaml/
>   (opens new window)
> - 菜鸟教程：https://www.ruanyifeng.com/blog/2016/07/yaml.html
>   (opens new window)

编辑
(opens new window)
上次更新: 2022/12/14, 19:36:42
npm packageJson属性详解
Git修改分支名

← npm packageJson属性详解 Git修改分支名→

最近更新

  01
Git修改分支名
08-11

  02
CSS给table的tbody添加滚动条
06-29

  03
我做了一个手写春联小网页，祝大家虎年暴富 原创
01-28

更多文章>

Copyright © 2016-2022 Hesb | MIT License

- 跟随系统
- 浅色模式
- 深色模式
- 阅读模式