定义自己的 YAML 语法的简洁方法？

Question

对于XML，有Document Type Definitions (DTD)定义了所有元素，但是YAML有类似的东西吗？

我在 Validating YAML with an XML DTD 上找到了一个 post，它建议无论如何都要使用 DTD and/or 一个简单的 XML，但我怀疑这对我的情况是否可行：我的项目决定采用（自定义）YAML 格式。从这种格式的 YAML 文件中，一个相当复杂的 XML 是通过算法生成的。 YAML 包含的信息比 XML 少得多，但人类编辑必须知道所有重要的事情。

目前，我的 YAML 的定义主要是平淡无奇的（作为相当抽象的需求文本），作为解析和转换为 XML 的实际源代码。两者都不适合应该维护 YAML 文件的最终用户。 是否有简洁明了的方法来定义我的自定义 YAML 语法？

Answer 1

首先，YAML 是语法。你要描述的不是语法，而是结构

YAML 是一种序列化格式。因此，你序列化和反序列化的数据类型就是一个YAML文件的结构描述。除非您使用 YAML 进行数据交换，否则您通常会有一个应用程序来实现加载 YAML 文件。

默认情况下，许多 YAML 实现反序列化为列表、字典和简单值（字符串、整数……）的异构结构。但是，如果您采用某种结构，则可以写下定义该结构的类型，然后将您的 YAML 加载到该类型的对象中。简单示例（在本例中为 Java）：

public class Book {
    public static class Person {
        public String name;
        public int age;
    }

    public Person author;
    public String title;
}

此类型描述此 YAML 文档的结构：

author:
  name: John Doe
  age: 23
title: Very interesting title

任何能够反序列化为类型的 YAML 实现都能够检查这些类型；在运行时通过反射或在编译时通过宏或其他编译时评估方式。因此，您也可以检查该结构并使用它为用户自动生成文档（可能使用 Java 扩展文档的文档注释）。

现在您可能会使用动态类型语言。如果该语言是 Python，您仍然可以定义类来定义您的结构，并且您可以使用 type hints 来定义标量值的类型。这为您提供了用户文档，但是您仍然需要手动实施验证，因为类型提示并未强制执行（PyYAML 的 add_path_resolver 是此处重要的挂钩，无需使用 YAML 标记即可将部分文档图解析为特定类型）。

对于其他语言，可能存在不同的解决方案。通常，最好维护一个描述 YAML 结构的单一真实来源 (SSOT)，然后将其用作用户文档和验证的基础。由于 YAML 是一种序列化格式，如果语言和 YAML 实现允许您定义目标类型，那么目标类型是 SSOT 的自然选择。

定义自己的 YAML 语法的简洁方法？

Concise way of defining your own YAML syntax?

xml

yaml

dtd