美文网首页
YAML基础语法手册以及和JSON的对照

YAML基础语法手册以及和JSON的对照

作者: cnwinds | 来源:发表于2020-03-06 17:59 被阅读0次

    k8s使用了YAML格式进行容器编排,因此这里来详细学习一下YAML文件的基本规则。
    本文介绍 YAML 的语法,可以使用在线网站进行验证YAML验证

    简介

    它的基本语法规则:

    • 大小写敏感
    • 使用缩进表示层级关系
    • 缩进时不允许使用Tab键,只允许使用空格。
    • 缩进的空格数目不重要,只要相同层级的元素左侧对齐即可
    • # 表示注释,从这个字符一直到行尾,都会被解析器忽略。

    YAML 支持的数据结构有三种:

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

    以下分别介绍这三种数据结构。

    对象

    对象的一组键值对,使用冒号结构表示。

    YAML JSON
    animal: pets { animal: 'pets' }

    YAML也允许另一种写法,将所有键值对写成一个行内对象。

    YAML JSON
    hash: { name: Steve, foo: bar } { hash: { name: 'Steve', foo: 'bar' } }

    数组

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

    YAML JSON
    - Cat
    - Dog
    - Goldfish
    [ 'Cat', 'Dog', 'Goldfish' ]

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

    YAML JSON
    -
      - Cat
      - Dog
      - Goldfish
    [ [ 'Cat', 'Dog', 'Goldfish' ] ]

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

    YAML JSON
    animal: [Cat, Dog] { animal: [ 'Cat', 'Dog' ] }

    纯量

    纯量是最基本的、不可再分的值。

    • 整数
    • 浮点数
    • 布尔值
    • null
    • 字符串

    数值直接以字面量的形式表示

    YAML JSON
    number: 12.30 { number: 12.30 }

    最新标准里 y / Y / yes / Yes / YES / n / N / no / No / NO / true / True / TRUE / false / False / FALSE / on / On / ON / off / Off / OFF 全部都会被解析成正确的 bool 类型,为了兼容性比较好建议用 true 和 false。

    YAML JSON
    isSet: true { isSet: true }

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

    YAML JSON
    e: !!str 123
    f: !!str true
    { e: '123', f: 'true' }

    ~ / null / Null / NULL 还有空字符都被解析成 null 类型,最标准的写法是 ~。

    YAML JSON
    e: ~ { e: null }

    字符串

    字符串是最常见,也是最复杂的一种数据类型。
    字符串默认不使用引号表示。

    YAML JSON
    str: 这是一行字符串 { str: '这是一行字符串' }

    如果字符串之中包含空格或特殊字符,需要放在引号之中。

    YAML JSON
    str: '内容: 字符串' { str: '内容: 字符串' }

    单引号和双引号都可以使用,双引号不会对特殊字符转义。

    YAML JSON
    s1: '内容\n字符串'
    s2: "内容\n字符串"
    { s1: '内容\\n字符串', s2: '内容\n字符串' }

    单引号之中如果还有单引号,必须连续使用两个单引号转义。

    YAML JSON
    str: 'labor''s day' { str: 'labor's day' }

    字符串可以写成多行,从第二行开始,必须有一个单空格缩进。换行符会被转为空格。

    YAML JSON
    str: 这是一段
     多行
     字符串
    { str: '这是一段 多行 字符串' }

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

    YAML JSON
    this:|
     Foo
     Bar
    that: >
     Foo
     Bar
    this:
    'Foo\nBar\n', that: 'Foo Bar\n' }

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

    YAML JSON
    s1:|
     Foo

    s2:|+
     Foo


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

    复合结构

    对象和数组可以结合使用,形成复合结构。

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

    引用

    锚点&和别名*,可以用来引用。

    defaults: &defaults
      adapter:  postgres
      host:     localhost
    
    development:
      database: myapp_development
      <<: *defaults
    
    test:
      database: myapp_test
      <<: *defaults
    

    等同于下面的代码。

    defaults:
      adapter:  postgres
      host:     localhost
    
    development:
      database: myapp_development
      adapter:  postgres
      host:     localhost
    
    test:
      database: myapp_test
      adapter:  postgres
      host:     localhost
    

    &用来建立锚点(defaults),<<表示合并到当前数据,*用来引用锚点。

    下面是另一个例子。

    YAML JSON
    - &showell Steve
    - Clark
    - Brian
    - Oren
    - *showell
    [ 'Steve', 'Clark', 'Brian', 'Oren', 'Steve' ]

    参考链接

    相关文章

      网友评论

          本文标题:YAML基础语法手册以及和JSON的对照

          本文链接:https://www.haomeiwen.com/subject/mvxwrhtx.html