根据类型字段对 JSON 进行动态解析以获取仅包含顶级字段的结构

学习Golang要努力，但是不要急！今天的这篇文章《根据类型字段对 JSON 进行动态解析以获取仅包含顶级字段的结构》将会介绍到等等知识点，如果你想深入学习Golang，可以关注我！我会持续更新相关文章的，希望对大家都能有所帮助！

假设我有以下无法修改的事件结构（甚至标签也不能修改）：

type openaudiostream struct {
    type     string `json:"type"`
    id       string `json:"id"`
    address  string `json:"address"`
    channels int    `json:"channels"`
}

type openvideostream struct {
    type        string `json:"type"`
    id          string `json:"id"`
    address     string `json:"address"`
    aspectratio string `json:"aspectratio"`
}

我有一个 api 端点，它发出 json 字符串（我也无法修改），其中包含映射到这两个结构之一的事件，但我无法提前知道它是哪一个，所以我需要以某种方式提取类型字段来确定要实例化的结构，然后将 json 的其余部分解组到实例化的事件对象中。

我想到的第一个方法是像这样调用 json.unmarshal 两次：

func jsonunmarshal(payload []byte) (event, error) {
    eventtype := struct {
        type string
    }{}

    err := json.unmarshal(payload, &eventtype)
    if err != nil {
        return nil, fmt.errorf("failed to unmarshal json: %v", err)
    }

    var event event
    switch eventtype.type {
    case "audio":
        event = &openaudiostream{}
        err = json.unmarshal(payload, event)
    case "video":
        event = &openvideostream{}
        err = json.unmarshal(payload, event)
    default:
        err = fmt.errorf("unrecognised event type: %s", eventtype.type)
    }

    if err != nil {
        return nil, fmt.errorf("failed to unmarshal json: %v", err)
    }

    return event, nil
}

虽然这很有效，但遍历 json 字符串两次效率很低，所以我想，也许我可以创建一个联合类型并使用它来解组 json，如下所示：

func notworking(payload []byte) (event, error) {
    eventunion := struct {
        type string `json:"type"`
        openaudiostream
        openvideostream
    }{}

    err := json.unmarshal(payload, &eventunion)
    if err != nil {
        return nil, fmt.errorf("failed to unmarshal json: %v", err)
    }

    var event event
    switch eventunion.type {
    case "audio":
        event = &extractor.openaudiostream
    case "video":
        event = &extractor.openvideostream
    default:
        return nil, fmt.errorf("unrecognised event type: %s", eventunion.type)
    }

    return event, nil
}

除了是一个丑陋的黑客之外，如果嵌入的结构包含冲突的字段，这种方法就不起作用。 json 解组器只是忽略它们而不会产生任何错误。

最后，我想起映射结构可能会有所帮助，而且事实上，我可以像这样使用它：

func mapstructureDecode(payload []byte) (Event, error) {
    var unmarshaledPayload map[string]interface{}

    err := json.Unmarshal(payload, &unmarshaledPayload)
    if err != nil {
        return nil, fmt.Errorf("failed to unmarshal JSON: %v", err)
    }

    var ok bool
    var val interface{}
    var eventType string
    if val, ok = unmarshaledPayload["type"]; ok {
        eventType, ok = val.(string)
    }
    if !ok {
        return nil, fmt.Errorf("failed to determine event type: %v", err)
    }

    var event Event
    switch eventType {
    case "audio":
        event = &openAudioStream{}
        err = mapstructure.Decode(unmarshaledPayload, &event)
    case "video":
        event = &openVideoStream{}
        err = mapstructure.Decode(unmarshaledPayload, event)
    default:
        err = fmt.Errorf("unrecognised event type: %s", eventType)
    }

    if err != nil {
        return nil, fmt.Errorf("failed to unmarshal JSON: %v", err)
    }

    return event, nil
}

但是，使用这个库对于这个任务来说似乎有点矫枉过正，如果输入 json 不遵循标准命名约定，则需要将 mapstruct 标签添加到结构字段，如果我有，这就是一个问题，例如 aspect_ratio aspectratio。

上述实验的完整代码可以在这里找到：https://play.golang.org/p/qtgov6i8m5p

我很好奇是否有其他方法可以使用现有库来解决这个问题。我在想也许对 json.rawmessage 和自定义 unmarshaljson 方法的一些创造性使用可能会有所帮助，但如果我在事件结构中只有顶级字段，这似乎没有用。

解决方案

您可以在组合结构中解组一次，然后根据类型创建新结构。

func jsonUnmarshal(payload []byte) (Event, error) {
    data := struct {
        Type        string
        ID          string
        Address     string
        Channels    int
        AspectRatio string
    }{}
    // Unmarshal in combined stuct
    err := json.Unmarshal(payload, &data)
    if err != nil {
        return nil, fmt.Errorf("failed to unmarshal JSON: %v", err)
    }
    var event Event
    switch data.Type {
    case "audio":
        // Creating new stuct 
        event = &openAudioStream{Type: data.Type, ID: data.ID, Address: data.Address, Channels: data.Channels}
    case "video":
        event = &openVideoStream{Type: data.Type, ID: data.ID, Address: data.Address, AspectRatio: data.AspectRatio}
    default:
        err = fmt.Errorf("unrecognised event type: %s", data.Type)
    }
    if err != nil {
        return nil, fmt.Errorf("failed to unmarshal JSON: %v", err)
    }
    return event, nil
}

文中关于的知识介绍，希望对你的学习有所帮助！若是受益匪浅，那就动动鼠标收藏这篇《根据类型字段对 JSON 进行动态解析以获取仅包含顶级字段的结构》文章吧，也可关注golang学习网公众号了解相关技术文章。