> ## Documentation Index
> Fetch the complete documentation index at: https://docs.xray.cool/llms.txt
> Use this file to discover all available pages before exploring further.

# 格式介绍

> 目前xray的POC主要是使用YAML进行编写，所以我们在学习编写POC前，先来学习一下YAML

## 简介

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

## 基本语法

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

## YAML的基本数据类型

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

## 纯量

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

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

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

```yaml theme={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 world'  #可以使用双引号或者单引号包裹特殊字符
    - newline
      newline2    #字符串可以拆成多行，每一行会被转化成一个空格
date:
    - 2018-02-17    #日期必须使用ISO 8601格式，即yyyy-MM-dd
datetime:
    -  2018-02-17T15:02:31+08:00    #时间使用ISO 8601格式，时间和日期之间使用T连接，最后使用+代表时区
```

## YAML 数组

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

```yaml theme={null}
- A
- B
- C
```

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

```yaml theme={null}
key: [value1, value2, ...]
```

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

```yaml theme={null}
-
 - A
 - B
 - C
```

一个相对复杂的例子：

```yaml theme={null}
companies:
    -
        id: 1
        name: company1
        price: 200W
    -
        id: 2
        name: company2
        price: 500W
```

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

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

```json theme={null}
companies: [{id: 1,name: company1,price: 200W},{id: 2,name: company2,price: 500W}]
```

## YAML 对象

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

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

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

```yaml theme={null}
key:
    child-key: value
    child-key2: value2
```

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

```yaml theme={null}
?
    - complexkey1
    - complexkey2
:
    - complexvalue1
    - complexvalue2
```

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

## 复合结构

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

```yaml theme={null}
languages:
  - Ruby
  - Perl
  - Python
websites:
  YAML: yaml.org
  Ruby: ruby-lang.org
  Python: python.org
  Perl: use.perl.org
```

转换为 json 为：

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