如何使用 go-yaml 将整数值编组为十六进制？

Question

我有一个带有整数字段的结构，其以十六进制形式表示对人类有意义。例如，将此字段设为供应商 ID字段。

我想将此数据保存到 YAML 文件中以进行手动编辑，然后从文件中加载它。据我了解，YAML 本身中数字的十六进制表示没有问题，但是go-yaml（我使用v3）以十进制形式对整数进行编码，并且我还没有找到一种正常的方法来使其以十六进制形式保存它们。

让我们以以下代码为起点：

import (
    //...
    "gopkg.in/yaml.v3"
)

type DeviceInfo struct {
    VendorId uint32 `yaml:"vendorid"`
}

func main() {
    deviceInfo := DeviceInfo{VendorId: 0xdeadbeef}

    yml, err := yaml.Marshal(deviceInfo)
    if err != nil {
        log.Fatal(err)
    }

    fmt.Println(string(yml))
}

此代码生成带有十进制值的 YAML：

vendorid: 3735928559

接下来，允许您为自己的类型go-yaml创建自定义封送拆收器。我这样做了（我故意省略了格式字符串0x中的前缀fmt.Sprintf()）：

type Uint32Hex uint32

func (U Uint32Hex) MarshalYAML() (interface{}, error) {
    return fmt.Sprintf("%x", U), nil
}

type DeviceInfo struct {
    VendorId Uint32Hex `yaml:"vendorid"`
}

func main() {
    // the same code
}

此代码生成十六进制值，但没有前缀0x（目前符合逻辑）：

vendorid: deadbeef

但是如果我0x在自定义封送拆收器中添加前缀：

func (U Uint32Hex) MarshalYAML() (interface{}, error) {
    return fmt.Sprintf("0x%x", U), nil
}

该值已正确生成，但不是数字，而是字符串：

vendorid: "0xdeadbeef"

为了将这一行解组为数字，我还必须编写一个自定义解组器。我不喜欢这个解决方案。

最后，我有以下几个问题：

1. 有没有go-yaml我没有找到的简单方法来生成十六进制数字？

2. 是否可以在go-yaml不更改包本身的情况下作为包的扩展来制作自定义编码器？对我来说，更方便的方法是在结构描述中传递格式标记，例如，如下所示：

   type DeviceInfo struct {
       VendorId uint32 `yaml:"vendorid,hex"`
   }
   

3. 如果这需要更改包代码，那么对于这种情况，Go 的做法是什么？只需将包文件复制到我的项目中，根据需要修改并导入本地即可？

Answer 1

这里的问题是，引用字符串在 yaml 中是可选的，但go-yaml使用与 JSON 编码器相同的内部架构。这意味着首先处理自定义封送处理，然后完全独立地应用引用逻辑。原因deadbeef没有被引用，但是0xdeadbeef是因为后者是一个数字。它被引用，这样当它知道它应该是一个字符串时，它就不会意外地被解组为数字，因为您的自定义封送拆收器返回了一个字符串。因为deadbeef不能被读取为有效数字，所以不需要用引号引起来。您可以做两件事：

1. 从字符串完成您的自定义 Marshal/Unmarshal：

func (U *Uint32Hex) UnmarshalYAML(value *yaml.Node) error {
    parsed, err := strconv.ParseUint(value.Value, 0, 32)
    *U = Uint32Hex(parsed)
    return err
}

2. 分叉go-yaml并修改它。如果您这样做，则不应更改源文件中的导入。相反，您应该replace向您的 中添加一条指令go.mod，如下所示：

require gopkg.in/yaml.v3 v3.0.1

replace gopkg.in/yaml.v3 v3.0.1 => ../yaml.v3 // Your local path to the fork

我更喜欢解决方案 1，因为它允许您以您喜欢的方式序列化这些值，而不会偏离其他人生成的 yaml，并且不需要您维护分支。