使用github.com/go-yaml/yaml解析含未导出字段结构体时的字段丢失问题

我之前踩过一模一样的坑！你遇到的问题核心原因很明确：当你为结构体实现自定义UnmarshalYAML接口后，yaml库的默认反射解析逻辑就会完全被接管，如果你只在自定义方法里处理未导出字段，那些导出字段自然不会被自动赋值。

问题根源 #

默认情况下，go-yaml只会解析结构体的导出字段（首字母大写的字段），未导出字段需要你手动处理。但一旦你实现了UnmarshalYAML，整个解析流程就交给你的自定义代码了——你没处理的字段，库不会帮你填。

正确的解决方法 #

最稳妥的方式是用一个临时的全导出结构体承接YAML的所有字段，然后把值拷贝到原结构体的导出和未导出字段中，同时可以在这个过程中对未导出字段做自定义处理。

举个具体的代码例子：

假设你的原结构体是这样的：

type MyStruct struct {
    Name string `yaml:"name"` // 导出字段
    age  int    `yaml:"age"`  // 未导出字段
}

那正确的UnmarshalYAML实现应该是这样的：

func (m *MyStruct) UnmarshalYAML(value *yaml.Node) error {
    // 定义临时结构体，把所有需要解析的字段都设为导出的
    // 字段标签要和YAML里的key对应
    var tmp struct {
        Name string `yaml:"name"`
        Age  int    `yaml:"age"` // 这里首字母大写，让yaml库能解析到
    }

    // 先把YAML数据解析到临时结构体
    if err := value.Decode(&tmp); err != nil {
        return err
    }

    // 把临时结构体的值拷贝到原结构体
    m.Name = tmp.Name       // 赋值导出字段
    m.age = tmp.Age         // 赋值未导出字段

    // 如果需要对未导出字段做额外处理，比如类型转换、校验，这里可以加逻辑
    // 比如：if m.age < 0 { return errors.New("age can't be negative") }

    return nil
}

另一种方式：用临时类型规避递归调用 #

如果你不想重新定义临时结构体，也可以用类型别名的方式，但要注意规避递归调用（因为原结构体实现了UnmarshalYAML，直接解析会无限递归）：

func (m *MyStruct) UnmarshalYAML(value *yaml.Node) error {
    // 定义一个临时类型，它是MyStruct的别名，但没有实现UnmarshalYAML
    type tmpStruct MyStruct
    var tmp tmpStruct

    // 解析到临时类型，用默认逻辑处理导出字段
    if err := value.Decode(&tmp); err != nil {
        return err
    }

    // 拷贝导出字段的值
    *m = MyStruct(tmp)

    // 单独处理未导出字段：因为tmp的age还是未导出的，默认解析没赋值，所以得手动解析
    var ageNode struct {
        Age int `yaml:"age"`
    }
    if err := value.Decode(&ageNode); err != nil {
        return err
    }
    m.age = ageNode.Age

    return nil
}

这种方式适合结构体字段很多的情况，但需要单独处理未导出字段，稍微麻烦一点。

关键提醒 #

• 自定义UnmarshalYAML时，一定要确保所有需要的字段都被手动处理，不管是导出还是未导出的。
• 避免递归调用：如果直接解析到原结构体指针，会反复调用你自己的UnmarshalYAML方法，导致栈溢出，所以必须用临时类型或临时结构体来绕开。

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