如何自定义UnmarshalYAML实现结构体反序列化并保留额外参数？

问题核心是：在自定义的UnmarshalYAML函数中直接反序列化原结构体时，会再次触发该自定义函数，导致无限递归。

解决方案思路 #

通过定义临时类型（原结构体的别名或匿名结构体）绕开自定义的反序列化逻辑，先完成结构体已知字段的反序列化，再单独处理额外字段。

代码示例 #

假设你的原结构体定义如下：

type Config struct {
    Name  string                 `yaml:"name"`
    Extra map[string]interface{} `yaml:"-"`
}

修改后的自定义UnmarshalYAML函数：

import "gopkg.in/yaml.v3"

func (c *Config) UnmarshalYAML(value *yaml.Node) error {
    // 定义临时类型，与Config字段完全一致，但不继承自定义的UnmarshalYAML方法
    type tempConfig Config
    var temp tempConfig

    // 反序列化到临时类型，使用默认逻辑，不会触发递归
    if err := value.Decode(&temp); err != nil {
        return err
    }
    // 将临时类型的值赋值回原结构体
    *c = Config(temp)

    // 反序列化所有YAML键值到map，用于提取额外字段
    var allFields map[string]interface{}
    if err := value.Decode(&allFields); err != nil {
        return err
    }

    // 过滤掉结构体已定义的字段，剩余的存入Extra
    c.Extra = make(map[string]interface{})
    definedFields := map[string]bool{"name": true} // 注意YAML字段名是小写的`name`
    for k, v := range allFields {
        if !definedFields[k] {
            c.Extra[k] = v
        }
    }

    return nil
}

优化点（可选） #

如果结构体字段较多，手动维护definedFields容易出错，可以用反射自动收集字段对应的YAML键名：

import "reflect"

// ... 在UnmarshalYAML函数中替换definedFields部分
definedFields := make(map[string]bool)
t := reflect.TypeOf(temp)
for i := 0; i < t.NumField(); i++ {
    field := t.Field(i)
    yamlTag := field.Tag.Get("yaml")
    if yamlTag != "" && yamlTag != "-" {
        // 处理yaml标签中的选项（比如`yaml:"name,omitempty"`）
        if idx := yamlTag.Index(','); idx != -1 {
            yamlTag = yamlTag[:idx]
        }
        definedFields[yamlTag] = true
    } else {
        // 没有yaml标签时，使用字段名的蛇形命名（YAML默认行为）
        definedFields[toSnakeCase(field.Name)] = true
    }
}

其中toSnakeCase函数用于将驼峰字段名转为蛇形（比如UserName转user_name），可自行实现或参考第三方工具库。

内容的提问来源于stack exchange，提问作者Andrea Silvestri