定制 YAML 标签在 Go 中的应用

学习Golang要努力，但是不要急！今天的这篇文章《定制 YAML 标签在 Go 中的应用》将会介绍到等等知识点，如果你想深入学习Golang，可以关注我！我会持续更新相关文章的，希望对大家都能有所帮助！

我在 go 中有这些嵌套结构，并为其属性添加了自定义标签，

type dummyparams struct {
  param1 string `yaml:"param1"`
  param2 string `yaml:"param2"`
}

type dummy struct {
  name string `yaml:"name"`
  type string `yaml:"type"`
  params dummyparams `yaml:"params"`
}

我创建了一些 dummy 实例并将它们添加到切片中，

dummies := make([]dummy, 0)
dummy1 := dummy {
    name: "a"
    type: "type a"
    params: dummyparams {
        param1: "foo"
        param2: "bar"
    }
}
dummies = append(dummies, dummy1)
dummy2 := dummy {
    name: "b"
    type: "type b"
    params: dummyparams {
        param1: "foo"
        param2: "bar"
    }
}
dummies = append(dummies, dummy2)

最后我整理数据并将其写入文件

yamlData, err := yaml.Marshal(&dummies)
// handle error ...
writeErr := os.WriteFile("foo.yaml", yamlData, 0644)
// handle write error ...

但是我得到的 yaml 没有小写标记名称，而是有大写结构名称。 有人知道为什么会发生这种情况以及如何解决它吗？

正确答案

归咎于您正在使用的 yaml 实现。例如，如果您使用 gopkg.in/yaml.v3 ，它就可以工作。在 go playground 上尝试一下。因此，一种解决方案是使用另一种 yaml 实现，例如 gopkg.in/yaml.v3。

您在评论中提到您正在使用 https:// /pkg.go.dev/sigs.k8s.io/[电子邮件受保护]。它的包文档说：

简而言之，该库首先使用 go-yaml 将 yaml 转换为 json，然后使用 json.marshal 和 json.unmarshal 与结构进行转换。这意味着它有效地重用了 json 结构标签以及自定义 json 方法 marshaljson 和 unmarshaljson ，这与 go-yaml 不同。

所以 sigs.k8s.io/[email protected] 第一个编组到 json。如果您想要小写的字段名称，请使用 json 标签而不是 yaml 标签：

import "sigs.k8s.io/yaml"

type dummyparams struct {
    param1 string `json:"param1"`
    param2 string `json:"param2"`
}

type dummy struct {
    name   string      `json:"name"`
    type   string      `json:"type"`
    params dummyparams `json:"params"`
}

通过此更改，输出包含小写名称（在 go playground 上尝试）：

- name: a
  params:
    param1: foo
    param2: bar
  type: type a
- name: b
  params:
    param1: foo
    param2: bar
  type: type b

请注意，必须使用 json 标签而不是 yaml 才能使其工作只是 sigs.k8s.io/[电子邮件受保护] 包。如果您想让它与这个包和其他yaml实现一起使用，您可以提供两者 json 和 yaml 标签：

type DummyParams struct {
    Param1 string `json:"param1" yaml:"param1"`
    Param2 string `json:"param2" yaml:"param2"`
}

type Dummy struct {
    Name   string      `json:"name" yaml:"name"`
    Type   string      `json:"type" yaml:"type"`
    Params DummyParams `json:"params" yaml:"params"`
}

今天带大家了解了的相关知识，希望对你有所帮助；关于Golang的技术知识我们会一点点深入介绍，欢迎大家关注golang学习网公众号，一起学习编程~