Go使用go-yaml/yaml库兼容新旧YAML配置文件的实现方案

要同时支持两种格式，核心是给Host结构体实现yaml.Unmarshaler接口，让解析器根据输入的节点类型自动适配处理逻辑：

实现自定义解析逻辑 #

import "gopkg.in/yaml.v3"

type Host struct {
    URL  string
    Name string
}

// 实现yaml.Unmarshaler接口，兼容新旧格式
func (h *Host) UnmarshalYAML(node *yaml.Node) error {
    // 先尝试按旧格式解析：节点为字符串类型
    var rawURL string
    if err := node.Decode(&rawURL); err == nil {
        h.URL = rawURL
        h.Name = "" // 旧格式下Name字段留空
        return nil
    }

    // 旧格式解析失败，切换到新格式解析：节点为结构体映射类型
    type rawHost Host // 创建临时类型避免递归调用自身Unmarshal方法
    return node.Decode((*rawHost)(h))
}

type Settings struct {
    Hosts []Host `yaml:"hosts"`
}

测试两种格式的解析 #

解析旧格式YAML #

oldYAML := `hosts:
- http://server1.com
- http://server2.com`

var oldSettings Settings
if err := yaml.Unmarshal([]byte(oldYAML), &oldSettings); err != nil {
    panic(err)
}
// 结果：oldSettings.Hosts[0].URL = "http://server1.com"，Name为空；第二个Host字段同理

解析新格式YAML #

newYAML := `hosts:
- url: http://server1.com
  name: s1
- url: http://server2.com
  name: s2`

var newSettings Settings
if err := yaml.Unmarshal([]byte(newYAML), &newSettings); err != nil {
    panic(err)
}
// 结果：newSettings.Hosts[0].URL = "http://server1.com"，Name = "s1"；第二个Host字段同理

关键说明 #

• 自定义解析方法优先尝试旧格式的字符串解析，失败后回退到新格式的结构体解析，保证旧配置文件无需修改即可正常解析。
• 使用临时类型rawHost是为了避免直接解码Host时递归调用自身的UnmarshalYAML方法，造成死循环。

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