json - 将任意字段添加到未知结构的 json 输出

Question

在this stackoverflow post 它解释了如何通过将任意字段用作匿名结构来将其添加到 golang 结构中。如果您正在使用已知的结构类型，这会很好地工作，但我想知道在处理未知的结构或接口(interface)时如何做同样的事情。

我写了following example演示:

package main

import (
    "os"
    "encoding/json"
    "fmt"
)

type example interface{}
type Data struct {
    Name string
}

func printInterface(val interface{})    {
    example1 := struct {
        example
        Extra string
    }{
        example: val,
        Extra: "text",
    }
    json.NewEncoder(os.Stdout).Encode(example1)
}

func printStructPointer(val *Data)  {
    example2 := struct {
        *Data
        Extra string
    }{
        Data: val,
        Extra: "text",
    }
    json.NewEncoder(os.Stdout).Encode(example2)
}


func main() {
    d := Data{Name:"name"}
    fmt.Println("Example 1:")
    printInterface(&d)
    fmt.Println("Example 2:")
    printStructPointer(&d)
}

这将打印以下内容:

Example 1:
{"example":{"Name":"name"},"Extra":"text"}
Example 2:
{"Name":"name","Extra":"text"}

我假设我在 printInterface 中工作，如何让 JSON 输出看起来像 printStructPointer 的 JSON 输出？

Answer 1

printInterface() 之间有一个重要的区别和 printStructPointer() .第一个嵌入接口(interface)类型，而第二个嵌入结构类型(更具体地说是指向结构类型的指针)。

当您嵌入一个结构(或指向结构的指针)类型时，嵌入类型的字段得到提升，因此在第二个示例中，写入 example2.Name 将是有效的.嵌入接口(interface)类型时，接口(interface)没有字段，因此不会提升任何字段。因此，接口(interface)值是否包装结构(或指向结构的指针)并不重要，该结构的字段不会得到提升(它们不能)。

因此，在 printInterface()包装结构的接口(interface)不会在 JSON 结果中“扁平化”。

通过使用反射生成动态类型来解决它

解决此问题的一种方法是在运行时使用反射( reflect 包)生成动态类型。这个新类型将是一个结构，它将包含一个匿名结构字段，该字段是包装在传递的接口(interface)中的类型，还将包含我们的额外字段(类型 string)。

它可能是这样的:

func printInterface(val interface{}) {
    t2 := reflect.StructOf([]reflect.StructField{
        reflect.StructField{
            Name:      "X",
            Anonymous: true,
            Type:      reflect.TypeOf(val),
        },
        reflect.StructField{
            Name: "Extra",
            Type: reflect.TypeOf(""),
        },
    })

    v2 := reflect.New(t2).Elem()
    v2.Field(0).Set(reflect.ValueOf(val))
    v2.FieldByName("Extra").SetString("text")

    json.NewEncoder(os.Stdout).Encode(v2.Interface())
}

输出符合预期(在 Go Playground 上尝试):

Example 1:
{"Name":"name","Extra":"text"}
Example 2:
{"Name":"name","Extra":"text"}

通过编码两次解决

另一种方法是编码值，将其解码到映射中，添加额外的字段并再次编码:

func printInterface(val interface{}) error {
    data, err := json.Marshal(val)
    if err != nil {
        return err
    }

    v2 := map[string]interface{}{}
    if err := json.Unmarshal(data, &v2); err != nil {
        return err
    }

    v2["Extra"] = "text"
    return json.NewEncoder(os.Stdout).Encode(v2)
}

输出是一样的。在 Go Playground 上试用.

此解决方案更简单、更容易遵循，但速度较慢，因为它编码了两次。另请注意，在此示例中，结果中的字段可能采用不同的顺序，因为 Go 中未指定 map 上的迭代顺序(有关详细信息，请参见 Why can't Go iterate maps in insertion order?)。