其他 - YAML 入门

1. 概述

   1. 简单介绍 YAML 语言

2. 背景

   1. 很多地方, 都在使用 YAML
      1. k8s
      2. spring
      3. 其他

3. 准备

   1. 验证工具

      1. YAML、YML在线格式化校验工具

         1. 一个 YAML 转换 JSON 的工具

            1. 通常来说, YAML 是可以转化为 JSON 的
            2. 有一个能告诉你对错的验证工具, 对学习很有帮助

         2. 这里如果使用 广告屏蔽插件的化, 背景会变得不太好看

            1. 处理办法, 是把 body 元素里的 style 属性去掉即可

   2. JSON 的基础

      1. 起码知道 map, list 的表示

1. YAML

1. 概述

   1. 简述 YAML 相关

2. 什么是 YAML

   1. YAML ain't markup language
      1. YAML 不是标记语言
      2. 这个玩法, 和 gnu 有点类似...

3. 目的

   1. 一门 可读性好 的语言
   2. 一门可以作为 数据序列化标准 的语言
   3. 一门 跨平台 的语言

4. 和 JSON 的关系

   1. JSON 更加注重 跨平台, YAML 更重视可读
   2. YAML 可以视为 JSON 的超集
      1. JSON 的格式, 在 YAML 中合法

5. 后缀名到底是 .YAML 还是 .yml

   1. 都行
   2. 推荐使用 .YAML

2. 语法

1. 概述
   1. 简单介绍 YAML 语法

1. 普通文本

1. 概述

   1. 尝试输入普通文本

2. 例子

   # 输入
   1
   2
   3
   
   4
   # 转换
   '1 2 3\n4'
   

3. 我的想法

   1. 虽然转换成功, 但是不建议使用
      1. 为啥非要用 YAML 来存放普通文本呢

2. 注释

1. 概述

   1. YAML 的注释

2. 注释格式

   1. 开始

      1. 以 # 开头

   2. 位置

      1. 行首
         1. 整行都被视为注释
      2. 行中
         1. 符号 # 右侧的字符, 被视为注释

   3. 格式

      1. 符号 # 和注释内容之间, 需要 空格 隔开

3. 约定

   1. 我在后面整理中, 不会在 YAML 里添加任何注释
   2. 下文中的 # 只是用来分隔的 解释说明文字

3. 简单 map

1. 概述
   1. 简单 map

例子1: kv 分隔符

1. 示例

   # 输入
   1:1
   # 输出
   61
   

2. 结果

   1. 卧槽怎么是这个东西?

3. 原因

   1. : 格式有问题

   2. 可用的格式, 有这两种

      # 官网推荐这一种, : 紧跟key, 但是在 value 前面, 有一个空格
      1: 1
      2 : 2
      

   3. 后面一定注意, YAML 其实 很吃 格式

      1. 格式很重要

4. 修正

   # 输入
   1: 1
   # 输出, 这就对了嘛
   { '1': 1 }
   

例子2: 简单的 map

1. 示例

   # 输入
   1: 10
   abandon: 狂热
   # 输出
   { '1': 10, abandon: '狂热' }
   

2. 结果

   1. 数字 和 字母都能作为 key
      1. 而且比起 JSON, YAML 的格式好像更为简单
         1. 起码 '' 的使用, 没有那么复杂

其他注意的问题

1. 概述

   1. 一些其他的注意事项
   2. 本来想 举例子 来说, 但还是太懒了

2. 字符集

   1. YAML 支持 unicode 的所有可见字符集

3. 特殊字符

   1. 如果需要 #, :, 则可以用 '' 或者 "" 引用, 保证使用正常
      1. 那个转化器, 无法识别 "", 这个暂时没法验证

4. key 不能重复

   1. 重复的 key, 会导致 解析失败

5. key 不能为空

   1. 否则会导致 解析失败
      1. 单纯的 空格 和 tab 也不行
      2. 空字符串, 倒是没问题

6. value 可以为空

   1. 转换出来的 JSON, 会识别为 null
   2. 如果是文字 null, 则加上 ''

7. 数字值域

   1. 使用 11111111111111111111 做 键 时

      1. 转化后的 键 为 11111111111111110000
      2. 不知道是因为解析器使用 js 的原因, 还是其他原因

   2. 在使用数字的时候, 要有意识的去注意 值域

8. bool

   1. YAML 支持 bool 类型
      1. true, True
      2. false, False

4. 简单 list

1. 概述
   1. 简单 list

例子1: 简单 list

1. 示例

   # 输入
   -
   - ' '
   - '	'
   - 1
   - abandon
   # 输出
   [ null, ' ', '\t', 1, 'abandon' ]
   

2. 结果

   1. 值可以为空
   2. 空格 和 tab 必须用 '' 或者 ""
      1. 否则视为 null
   3. • 和 值 之间, 必须要有 空格
   4. 友情提示: 注意对齐, 后面的缩进, 会有大麻烦

5. 嵌套

1. 概述
   1. 尝试一些相对复杂的嵌套

例子1: map 嵌套

1. 示例

   # 输入
   key1:
     key11: value11
     key12: value12
   key2:
     key11: value11
     key12: value12
   # 输出
   { key1: { key11: 'value11', key12: 'value12' },
     key2: { key21: 'value21', key22: 'value22' } }
   

2. 结果

   1. map 可以作为 value

3. 注意

   1. 缩进

      1. YAML 中, 层次是靠 缩进 体现的
      2. 缩进使用的, 是 两个空格
      3. 一定不能用 tab 去缩进
      4. 缩进不正确, 会导致报错

   2. 当然, 可以多层嵌套

      1. 但具体能嵌套多少层, 我也是不清楚

例子2: list 嵌套

1. 示例

   # 输入
   - super1
   -
     - sub1
     - sub2
   - super3
   # 输出
   [ 'super1', [ 'sub1', 'sub2' ], 'super3' ]
   

2. 结果

   1. list 可以作为 list 元素存在
      1. 那个空行 - 需要注意

3. 注意

   1. 还是缩进
   2. 层数
      1. 可以多层嵌套
      2. 但是能套多少层, 我还是不清楚

例子3: list 做 map 的 key

1. 示例

   # 输入
   ?
     - var1
     - var2
   :
     key
   # 输出
   { 'var1,var2': 'key' }
   

2. 结果

   1. list 作为 map 的 key, 成功转化

3. 注意

   1. 注意格式
      1. ?
      2. :
   2. map 不能作为 map 的 key

例子4: list 作为 map 的 value

1. 示例

   # 输入
   key:
     - value1
     - value2
   # 输出
   { key: [ 'value1', 'value2' ] }
   

2. 结果

   1. 成功

例子5: map 作为 list 的元素

1. 示例

   # 输入
   - key10: value10
     key11: value11
   - key20: value20
     key21: value21
   # 输出
   [ { key10: 'value10', key11: 'value11' },
    { key20: 'value20', key21: 'value21' } ]
   

2. 结果

   1. 成功嵌套

6. 其他

1. 感觉了解了这些, 基本就够用了吧

   1. 感觉日常使用, 基本是 够了

2. 当然有一些疑问

   1. 层数上限
   2. 容量上限
   3. int 和 float 的上限
   4. 特殊转义
   5. " 和 ' 的区别

3. 这些问题, 如果在使用中遇到, 再去处理吧

4. 感觉 YAML 其实是一种 写起来更简单的 JSON

   1. 如果有想法的话, 其实是可以写一个东西, 来将 YAML 转化为 JSON 的

ps

1. ref
   1. YAML
   2. What is the difference between .yaml and .yml extension?
   3. YAML、YML在线格式化校验工具