Golang如何定义字段名可变的结构体 适配动态键JSON反序列化

场景说明 #

需要反序列化的JSON存在动态字符串键（如示例中的string-id-001、string-id-002这类任意字符串ID），示例JSON结构如下：

{"list":{"string-id-001":{"id":"blah","name":"cool"},"string-id-002":{"id":"yas","name":"rad"}}}

常规硬编码字段映射的结构体需要提前写死所有JSON键名，完全无法适配键动态变化的场景，硬编码写法示例：

type Foo struct {
    List struct {
        StringID001 struct {
            ID   string `json:"id"`
            Name string `json:"name"`
        } `json:"string-id-001"`
        StringID002 struct {
            ID   string `json:"id"`
            Name string `json:"name"`
        } `json:"string-id-002"`
    } `json:"list"`
}

过往处理同类问题时使用interface{}承接反序列化结果，需要做大量类型断言，使用成本较高。

最优实现 #

Go标准库encoding/json原生支持map类型的反序列化，不需要引入第三方库，也不需要全量使用interface{}丢失强类型特性。
只需要将动态键对应的字段定义为map[string]子项结构体类型即可，子项结构体对应动态键下固定结构的字段：

• 首先定义动态键对应的固定结构子项：

type Item struct {
    ID   string `json:"id"`
    Name string `json:"name"`
}

• 外层结构体仅需定义固定层级的字段，动态键层用map承接：

type Foo struct {
    // map的key对应动态字符串ID，value对应ID下的固定结构
    List map[string]Item `json:"list"`
}

使用方式 #

反序列化逻辑和普通结构体完全一致，不需要额外处理：

func main() {
    rawJSON := `{"list":{"string-id-001":{"id":"blah","name":"cool"},"string-id-002":{"id":"yas","name":"rad"}}}`
    var data Foo
    if err := json.Unmarshal([]byte(rawJSON), &data); err != nil {
        panic(err)
    }

    // 直接通过动态ID访问对应值
    fmt.Println(data.List["string-id-001"].Name) // 输出: cool
    fmt.Println(data.List["string-id-002"].ID)   // 输出: yas

    // 支持遍历所有动态键值对
    for dynamicID, item := range data.List {
        fmt.Printf("动态ID: %s, 对应内容: %+v\n", dynamicID, item)
    }
}

扩展场景处理 #

如果动态键对应的子项结构也不固定，可以将map的值类型定义为json.RawMessage，先承接原始JSON字节，后续根据业务场景按需做二次反序列化即可，兼顾灵活性和类型安全。

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