Golang解析YAML指定字段时键顺序影响结果的异常问题

问题分析 #

你遇到的问题并非YAML键顺序必须与结构体字段顺序一致，而是由两个核心原因导致：

1. YAML格式不规范：你的示例YAML文件中，根级别的键（如cat_name、happy）带有前置缩进，这违反了YAML语法规则——根级别映射的键不应有缩进。这种不规范格式会导致解析器行为不稳定，表现为部分字段在特定顺序下能被读取，其他顺序下无法正确解析。
2. 库默认解析行为：goccy/go-yaml默认对YAML结构检查较严格，当遇到结构体未定义的字段时，即使不返回错误，也可能在格式不规范的场景下干扰后续字段的解析流程。

解决方案 #

方案1：修正YAML文件格式 #

移除根级别键前的所有缩进，修正后的YAML如下：

---
cat_name: rusty
dog_name: billy
cat_food: Purina
dog_food: Blue
cat_rescued: true
dog_rescued: false
cat_age: 4
dog_age: 6
happy: true

方案2：配置反序列化选项（忽略未知字段） #

如果需要保留YAML中的未知字段且不影响解析，可使用UnmarshalWithOptions并关闭Strict模式，确保解析器忽略未定义字段，且不干扰后续字段读取。修改后的代码如下：

data, err := ioutil.ReadFile(filename)
if err != nil {
    return nil, fmt.Errorf("Could not read file %s. An error has occurred: %w", filename, err)
}

params := MyStruct{}
if err = yaml.UnmarshalWithOptions(data, &params, yaml.Strict(false)); err != nil {
    return nil, fmt.Errorf("could not parse yaml from file. %w", err)
}

return &params, nil

验证 #

完成上述任一修改后，无论YAML键的顺序如何，都能正确将happy、cat_name、cat_age的值反序列化到结构体中。

内容的提问来源于stack exchange，提问作者J. B.