使用 golang 验证 yaml 架构（语义检查）

Question

我们有需要读取具有特定结构的 YAML 文件的工具。当我们得到 YAML 文件时，我们需要知道是否

1. 根据某些准则检查 YAML 文件是否有效 - 语义检查
2. 语法错误在哪里

例如，这是我们需要解决的验证示例

 _version:  {required: true}
   id: {required: true, pattern: '/^[A-Za_\-\.]+$/'}   
   release-version: {required: true}
   type:   

   builds:
     type:seq
     sequence:
       -type:map
     mapping:
        name:{required: true, unique: true, pattern: '/^[A-Za-z0-3_\-\.]+$/'}
        params: 
          type: map
          mapping: { =: {type: any} } 

映射是键值对象
seq 可以有多个构建
输入任何是和键值

我们使用这个开源来解析yaml https://github.com/go-yaml/yaml

一个想法（这很好）是转换为 json，如下所示，通过将文件转换为 json 并验证它是否有库支持它，在我的上下文中的任何示例都会非常有帮助 https://github.com/xeipuuv/gojsonschema

但不确定我如何处理

Type map
Type seq

Answer 1

您可以使go-yaml 与jsonschema 一起工作。看到这个问题：https://github.com/santhosh-tekuri/jsonschema/issues/5

简而言之：

1. 根据this issue，创建一个生成兼容输出类型的自定义 yaml 解析器。
2. 使用该自定义解析器将 yaml 解析为 interface{}
3. 使用jsonschema.ValidateInterface 进行验证。

（一旦 yaml.v3 发布，自定义解组器应该可以替换为配置选项）

我最初使用公认答案的方法解析为一个结构，然后编写代码来手动验证该结构是否符合我的规范。这很快就变得非常丑陋 - 上述方法允许一个干净的单独规范和可靠的验证。

Answer 2

这是你可以尝试的。

按照预期的 yaml 数据的形状建模一个结构体：

type Config struct {
        Version struct {
                Required bool
        }
        ID struct {
                Required bool
                Pattern string
        }
        ReleaseVersion struct {
                Required bool
        }
        Type interface{}
        Builds struct {
                Type []interface{} `yaml:"type"`
                Sequence struct {
                        Type string
                }
                Mapping struct {
                        Name map[string]interface{}
                        Params struct {
                                Type string `yaml:"type"`
                                Mapping struct {
                                        To map[string]string `yaml:"="`
                                }
                        }
                } `yaml:"mapping"`              
        }
}

添加了yaml标志yaml:"somefield"来标记我们感兴趣的数据的yaml的字段名称。

还有许多未知/未确定类型的字段可以声明为空接口(interface{})，或者如果您想“强制”底层表单是键值对象，您可以将其声明为map[string]interface{}或其他结构。

然后我们将 yaml 数据解组到结构中：

cfg := Config{}
err := yaml.Unmarshal([]byte(data), &cfg)
if err != nil {
        log.Fatalf("error: %v", err)
}

由于我们将字段建模为匿名结构或映射，因此我们可以通过检查特定字段与 nil 的相等性来测试特定字段是否具有“键值”值。

// Mapping is a key value object
if (Mapping != nil) {
        // Mapping is a key-value object, since it's not nil.
}


// type any is and key value
// Mapping.To is declared with map[string]string type
// so if it's not nil we can say there's a map there.
if (Mapping.To != nil) {
        // Mapping.To is a map
}

在编组/解组中，映射和结构是可以互换的。结构的好处是您可以提前预定义字段的名称，同时将其解组到映射时，您将不清楚键是什么。