yaml语法

警告
本文最后更新于 2023-02-24,文中内容可能已过时,请谨慎使用。
信息
YAML文件后缀为 .yml,如:action.yml
  • 大小写敏感
  • 使用缩进表示层级关系
  • 缩进不允许使用tab,只允许空格
  • 缩进的空格数不重要,只要相同层级的元素左对齐即可
  • #表示注释
注意
本文的yml代码统一使用两个空格缩进
  • 对象:键值对的集合,又称为映射(mapping)/ 哈希(hashes) / 字典(dictionary)
  • 数组:一组按次序排列的值,又称为序列(sequence)/ 列表(list)
  • 纯量(scalars):单个的、不可再分的值

对象键值对使用冒号结构表示:key: value

也可以将所有键值对写成一个行内对象: key:{key1: value1, key2: value2, …}

websites:
  YAML: yaml.org 
  Ruby: ruby-lang.org 
  Python: python.org 
  Perl: use.perl.org
  
hash: { name: tom, city: beijing } 
{
    "websites": {
        "YAML": "yaml.org",
        "Ruby": "ruby-lang.org",
        "Python": "python.org",
        "Perl": "use.perl.org"
    },
    "hash": {
        "name": "tom",
        "city": "beijing"
    }
}

一组连词线开头的行,构成一个数组。

- python
- go
- java
- javascript
[
    "python",
    "go",
    "java",
    "javascript"
]

数组的子成员也可以是一个数组

lanuages:
  -
   - java
   - python
   - golang
  - hello
{
    "lanuages": [
        [
            "java",
            "python",
            "golang"
        ],
        "hello"
    ]
}

数组也可以采用行内表示法

lanuages: ["java","golang","python",["hello"]]
{
    "lanuages": [
        [
            "java",
            "python",
            "golang"
        ],
        "hello"
    ]
}

从上面的代码也可以看出,数组和对象可以构成复合结构

纯量是最基本的,不可再分的值,包括:

  • 字符串
  • 布尔值
  • 整数
  • 浮点数
  • 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\n" # 双引号包裹不会转义特殊字符,单引号会转义
    - 'Hello world'  #可以使用双引号或者单引号包裹特殊字符
    - 'labor''s day' # 单引号中还有单引号
    - newline
      newline2    #字符串可以拆成多行,第二行开始必须使用相同缩进
date:
    - 2018-02-17    #日期必须使用ISO 8601格式,即yyyy-MM-dd
datetime: 
    -  2018-02-17T15:02:31+08:00    #时间使用ISO 8601格式,时间和日期之间使用T连接,最后使用+代表时区

多行字符串可以使用|保留换行符, 如果不需要末尾换行符,可以使用|-

str:  |-
 这是一段
 多行
 字符串 
{
    "str": "这是一段\n多行\n字符串"
}

相关文章