01-YAML基本使用

Posted 2023-02-22 爱学习de测试小白

YAML入门

• • • 前言
    • YAML简介
    • YAML语法
    • YAML常用写法
    • • 对象写法
      • 数组写法
      • 纯量写法
    • 复合结构
    • YMAL引用

---

前言

• 本篇来学习下YAML的基本用法

YAML简介

• YAML 是 “YAML Ain’t a Markup Language”（YAML 不是一种标记语言）的递归缩写。YAML 的语法和其他高级语言类似，并且可以简单表达清单、散列表，标量等数据形态。它使用空白符号缩进和大量依赖外观的特色，特别适合用来表达或编辑数据结构、各种配置文件。

YAML语法

• 大小写敏感
• 使用缩进表示层级关系
• 缩进不允许使用tab，只允许空格
• 缩进的空格数不重要，只要相同层级的元素左对齐即可
• '#'表示注释

YAML常用写法

• YAML转JSON网站：https://www.json2yaml.com/convert-yaml-to-json
• YAML支持三种数据结构
  • 对象：键值对的集合，又称为映射（mapping）/ 哈希（hashes） / 字典（dictionary）
  • 数组：一组按次序排列的值，又称为序列（sequence） / 列表（list）
  • 纯量（scalars）：单个的、不可再分的值

对象写法

• 对象键值对使用冒号结构表示 key: value，冒号后面要加一个空格，且不可省略。YAML 为对象提供了 2 种写法：

1. 普通写法：用缩进表示对象与属性的层级关系

info:
	name: 大海
    age: 28
    city: 北京

2. 行内写法

info: name: 大海, age: 28, city: 北京

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

?  
  - key1
  - key2
: 
  - value1
  - value2

数组写法

• YAML 使用 “-” 表示数组中的元素，也有两种写法：

1. 普通写法

cityList:
	- 北京
  - 上海
  - 大连

2. 行内写法

cityList: [ 北京,上海,大连 ]

纯量写法

• 纯量又称字面量，是指单个的，不可拆分的值，例如：数字、字符串、布尔值、以及日期等

1. 字符串

str:
  - '你 好' # 可以使用双引号或者单引号包裹特殊字符
  - Hello
    World   # 字符串可以拆成多行，每一行会被转化成一个空格
  - '测试 \\n 开发' # 若字符串使用单引号，则会转义特殊字符
  - "测试 \\n 开发" #  若字符串使用双引号，则不会转义特殊字符，特殊字符会输出为其本身想表达的含义

2. 布尔值

boolean: 
    - TRUE  # true，True 都可以
    - false  # false，False 都可以

3. 整数

int:
    - 666
    - 0b1010_0111_0100_1010_1110  #二进制表示

4. 浮点数

float:
    - 3.14
    - 6.8523015e+5  # 可以使用科学计数法

5. Null

k8s:
    nodeName: 'node'
    parent: ~  # 使用~表示null

6. 时间

date:
    - 2018-02-17    # 日期必须使用ISO 8601格式，即yyyy-MM-dd

7. 日期

datetime: 
    -  2018-02-17T15:02:31+08:00    # 时间使用ISO 8601格式，时间和日期之间使用T连接，最后使用+代表时区

复合结构

• 以上三种数据结构可以复合使用组成复合结构，例：

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

YMAL引用

• 当 YAML 文件中出现多个重复内容时，可以通过 锚点& 与 引用* 实现引用锚点处内容的功能，从而在修改时，只需要修改锚点处的内容，即可在所有引用处生效。

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

1. & 锚点和 * 别名，可以用来引用

defaults: &defaults
  host:  192.168.1.111
  port:  6379
 
dev:
  database: dev_db
  <<: *defaults
 
prod:
  database: prod_db
  <<: *defaults

相当于

defaults: 
  host:  192.168.1.111
  port:  6379
  
dev:
  database: dev_db
  host:  192.168.1.111
  port:  6379
 
prod:
  database: prod_db
  host:  192.168.1.111
  port:  6379

2. 直接在键后设置锚点，然后空格设置值，这样在引用时，只引用值。

defaults: 
  host:  &host 192.168.1.111
  port:  &port 6379
  
dev:
  database: dev_db
  host:  *host
  port:  *port
 
prod:
  database: prod_db
  host:  *host
  port:  *port