mapstructure 将 map[string]interface{} 解码为包含自定义类型的结构给出错误

Question

我的应用采用 JSON 字符串，解组为结构 BiggerType，然后使用 mapstructure 将结构的字段 Settings 解码为类型 MainType. BiggerType 需要支持多种类型的 Settings，因此，必须声明为 map[string]interface{}。在我们有了新类型 Settings 之前，该应用程序一直运行良好，即 MainType 包含一些类型为 SpecialType.

的自定义字段

结构体和主要代码如下。运行代码给出如下错误。

* 'b' expected a map, got 'string'

为简洁起见删除了一些代码

package main

import (
    ...
    "github.com/mitchellh/mapstructure"
)

const myJSON = `{
  "settings": {
    "a": {
      "aa": {
        "aaa": {
          "sta": "special_object_A",
          "stb": "special_object_B"
        },
        "aab": "bab"
      },
      "ab": true
    },
    "b": "special_string"
  },
  "other": "other"
}`

func main() {
    var biggerType BiggerType

    err := json.Unmarshal([]byte(myJSON), &biggerType)
    if err != nil {
        panic(err)
    }

    var decodedMainType MainType

    if err := mapstructure.Decode(biggerType.Settings, &decodedMainType); err != nil {
        panic(err)
    }
}

type BiggerType struct {
    Other    string   `json:"other"`
    // Settings MainType `json:"settings"` can't be used as it needs to support other "Settings"
    Settings map[string]interface{} `json:"settings"`
}

type A struct {
    Aa *AA   `json:"aa"`
    Ab *bool `json:"ab"`
}

type AA struct {
    Aaa SpecialType `json:"aaa"`
    Aab string      `json:"aab"`
}

type MainType struct {
    A A           `json:"a"`
    B SpecialType `json:"b"`
}

type SpecialTypeObject struct {
    Sta string `json:"sta"`
    Stb string `json:"stb"`
}

func (s SpecialTypeObject) InterfaceMethod() (string, error) {
    return s.Sta + "+" + s.Stb, nil
}

type SpecialTypeString string

func (s SpecialTypeString) InterfaceMethod() (string, error) {
    return string(s), nil
}

type SpecialInterface interface {
    InterfaceMethod() (string, error)
}

// SpecialType SpecialTypeString | SpecialTypeObject
type SpecialType struct {
    Value SpecialInterface
}

func (s *SpecialType) UnmarshalJSON(data []byte) error {
    ...
}

我的目标是能够将 biggerType.Settings 解码为 decodedMainType，并且所有值都完好无损。任何人都可以与我分享任何解决方法 or/and 的建议吗？

重现问题的 playground：https://go.dev/play/p/G6mdnVoE2vZ

谢谢。

Answer 1

为什么它不起作用

* 'b' expected a map, got 'string'

在JSON中，settings.b是字符串类型。您已将其解码为 BiggerType，其中设置为 map[string]interface{}。提供的标准库 JSON 解组过程产生如下映射：

map[string]interface{} {
   "A": map[string]interface{}{...},
   "B": string("special_value"),
}

JSON解码完成。程序中不再发生 Json 解码。

然后您尝试使用 mapstructure 将您的 settings map 解码为 MainType，其中 B 的类型为 SettingsType .因此 mapstructure.Decode 尽职尽责地遍历您的 BiggerType 并尝试将其变成 MainType，但遇到了障碍。当到达B时，输入是一个字符串，输出是一个SettingsType.

您为设置类型编写了一个 UnmarshalJSON 函数，但 B 的值并未从 JSON 中解组 - 它已经是一个字符串。解码不知道如何将 string 变成 SpecialType（它说它期望 map 但这有点误导 it actually checks for map, struct, slice, and array types）

重新表述您面临的问题

那么让我们更具体地确定错误：你有。 map[string]interface{} 具有字符串值，mapstructure.Decode 尝试将其解码为具有 Struct 值的结构字段。

重述目标

您在此处显示的所有内容都是您在解决方案中遇到的问题。你的根本问题是什么？您在 BiggerType.Settings 中有一个 interface{}，它可能是 string，也可能是 map[string]interface{}，您想要将它变成一个 SpecialType，其中包含一个SpecialTypeString 或 SpecialTypeObj

我不能完全符合你的问题，你一直在谈论 MainType 可能是不同的类型，但你程序中的所有不同类型似乎都在 SpecialType 之下。

如何解决

似乎这里明显的解决方案是放弃 mapstructure 并使用自定义解组器使用您已经用于 SpecialType 的方法。 mapstructure 在需要解组 JSON 以内省某些属性然后决定如何处理其他属性的情况下很有用。但是，您没有使用 mapstructure 做任何类似的事情；最接近的是您的自定义解组器。如果自定义 Unmarshaller 可以完成这项工作，则您不需要 mapstructure.

SpecialType.UnmarshalJSON 在您的代码中已经是一个示例，说明如何将未知值包装在已知类型中并使用 switch 语句来处理未知值类型。

所以只需放弃 mapstructure，将 BiggerType 重新定义为：

type BiggerType struct {
    Other    string   `json:"other"`
    Settings MainType `json:"settings"`
}

并让已经写好的UnmarshalJSON处理MainType.B。

如果不是 SpecialType 需要此逻辑，而是 MainType，则对 SpecialType 执行与 MainType 相同的操作。

https://go.dev/play/p/DW8N8t3Lr0l

如果您想查看 mapstructure 的解决方案，请提供多个 JSON 输入示例，以便我了解它们的不同之处以及为什么可能需要 mapstructure .

Answer 2

我支持 Daniel Farrell，但可以修复现有的解决方案。

这个想法是利用 mapstructure 的能力来定制它的 Decoder ，它可以在解码过程中的关键点调用一个“钩子”。有多个可用的钩子，它们可以组合成一个“链式”钩子。

因为有一个 stock hook 可以检查目标变量的类型是否实现了 encoding.TextUnmarshaler，我们可以将你的 (*SpecialType).UnmarshalJSON 调整为 (*SpecialType).UnmarshalText 然后使用它：

func (s *SpecialType) UnmarshalText(data []byte) error {
    if len(data) > 0 && data[0] != '{' {
        s.Value = SpecialTypeString(data)
        return nil
    }

    var obj SpecialTypeObject
    if err := json.Unmarshal(data, &obj); err != nil {
        return fmt.Errorf("failed to unmarshal SpecialType: %s", err)
    }
    s.Value = obj
    return nil
}

和

var decodedMainType MainType

msd, err := mapstructure.NewDecoder(&mapstructure.DecoderConfig{
    DecodeHook: mapstructure.TextUnmarshallerHookFunc(),
    Result:     &decodedMainType,
})
if err != nil {
    return BiggerType{}, err
}

if err := msd.Decode(biggerType.Settings); err != nil {
    return BiggerType{}, err
}

完整的解决方案：https://go.dev/play/p/jaCD9FdSECz.

但话又说回来——正如 Daniel 所暗示的，您似乎已经爱上了使用 mapstructure，因为它有望成为一个看起来很复杂的问题的简单解决方案。
事实上，encoding/json 似乎有库存设施来涵盖您的用例 — 正是通过使某些类型实现 json.Unmarshaler，所以我会尝试在这种情况下放弃 mapstructure：它很有用包，但现在您似乎正在围绕它实现的框架规则工作。

mapstructure 将 map[string]interface{} 解码为包含自定义类型的结构给出错误

mapstructure decode a map[string]interface{} into a struct containing custom type gives Error

go

unmarshalling

为什么它不起作用

重新表述您面临的问题

重述目标

如何解决