如何基于gopkg.in/yaml.v2为自定义类型实现Unmarshaler接口？

要把YAML中的map[string][]uint16结构反序列化为map[string]EpnSeq（其中EpnSeq是map[uint16]uint16），核心思路是给EpnSeq类型实现yaml.Unmarshaler接口，让yaml.v2包知道如何将数组转换成你的自定义map类型。下面是具体实现步骤：

1. 定义基础类型和配置结构体 #

先把你的核心类型和配置结构体定义好：

import "gopkg.in/yaml.v2"

// EpnSeq 你自定义的map类型
type EpnSeq map[uint16]uint16

// CitConfig 包含目标属性的配置结构体
type CitConfig struct {
    EndPointNumberSequences map[string]EpnSeq `yaml:"endPointNumberSequences"`
    // 这里可以添加你的其他配置字段
}

2. 给EpnSeq实现UnmarshalYAML接口 #

接下来实现yaml.Unmarshaler要求的UnmarshalYAML方法，这个方法会告诉yaml包如何将YAML中的数组转换成EpnSeq：

func (e *EpnSeq) UnmarshalYAML(unmarshal func(interface{}) error) error {
    // 第一步：先把YAML里的数组临时反序列成[]uint16
    var rawSeq []uint16
    if err := unmarshal(&rawSeq); err != nil {
        return err
    }

    // 第二步：初始化EpnSeq，并把数组元素转成map键值对
    // 这里默认把数组的索引作为map的key，数组元素作为value（匹配你给的示例逻辑）
    *e = make(EpnSeq, len(rawSeq))
    for idx, val := range rawSeq {
        (*e)[uint16(idx)] = val
    }

    return nil
}

3. 测试反序列化效果 #

写一段测试代码验证解析是否正常：

import (
    "fmt"
    "log"
)

func main() {
    // 模拟你的YAML配置内容
    yamlData := `endPointNumberSequences:
  AD1: [ 0, 10, 14, 1, 11, 2, 100, 101, 12 ]`

    var cfg CitConfig
    if err := yaml.Unmarshal([]byte(yamlData), &cfg); err != nil {
        log.Fatalf("解析YAML失败: %v", err)
    }

    // 打印结果查看转换后的EpnSeq
    fmt.Println("AD1的EpnSeq内容：")
    for key, value := range cfg.EndPointNumberSequences["AD1"] {
        fmt.Printf("键: %d, 值: %d\n", key, value)
    }
}

额外调整（按需修改） #

如果你的EpnSeq不是用数组索引作为key，而是数组元素是两两成对的键值对（比如[0,10,14,1]表示0:10、14:1），可以修改UnmarshalYAML里的转换逻辑：

func (e *EpnSeq) UnmarshalYAML(unmarshal func(interface{}) error) error {
    var rawSeq []uint16
    if err := unmarshal(&rawSeq); err != nil {
        return err
    }

    // 校验数组长度是否为偶数
    if len(rawSeq)%2 != 0 {
        return fmt.Errorf("无效的序列长度：必须是偶数（键值对数量）")
    }

    *e = make(EpnSeq, len(rawSeq)/2)
    // 两两遍历数组，取前一个为key，后一个为value
    for i := 0; i < len(rawSeq); i += 2 {
        key := rawSeq[i]
        value := rawSeq[i+1]
        (*e)[key] = value
    }

    return nil
}

关键注意点 #

• 必须使用指针接收者实现UnmarshalYAML，因为我们需要修改EpnSeq实例的内容（初始化map并赋值）
• 如果YAML中的数组包含非数字类型，需要额外添加类型转换和错误处理逻辑

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