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

Question

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

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

这是一种方法：

package main

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

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

func printInterface(val interface{}) {
    if d, ok := val.(*Data); ok {
        fmt.Println("Asserting type *Data for val is OK")
        printStructPointer(d)
    } else {
        fmt.Println("Asserting type *Data for val is NOT OK")
    }

}

func printStructPointer(val *Data) {

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

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

游乐场：https://play.golang.org/p/OPotpTyUEz

您也可以使用类型开关进行断言，尤其是当您有多种类型时。希望这对您有所帮助！

Answer 2

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

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

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

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

解决此问题的一种方法是在运行时使用反射（reflect 包）生成动态类型。这个新类型将是一个结构，它将包含一个匿名结构字段，该字段是包装在传递的接口中的类型，还将包含我们的额外字段（类型 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 中未指定地图上的迭代顺序（有关详细信息，请参阅）。

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

Adding Arbitrary fields to json output of an unknown struct

json

struct

interface

embedding

go

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

两次编组解决