Go语言中将嵌套JSON对象解组为原始字节数组或字符串

在Go语言中处理JSON时，有时需要将嵌套的JSON对象作为原始字节数组（`[]byte`）或字符串来处理，而非进行完整的结构体解析。本文将详细介绍如何利用`encoding/json`包中的`json.RawMessage`类型来优雅地实现这一需求，避免“无法将对象解组到[]uint8类型”的错误，从而实现灵活的JSON数据处理和延迟解析。

理解JSON解组中的挑战

在Go语言中，encoding/json包提供了强大的JSON序列化和反序列化能力。通常，我们会定义一个Go结构体，其字段与JSON对象的键一一对应，然后使用json.Unmarshal将JSON数据解析到该结构体实例中。然而，当JSON数据中包含一个嵌套对象，而我们希望在Go结构体中将其作为一个未解析的原始字符串或字节数组存储时，直接将其声明为string或[]byte类型会遇到问题。

例如，考虑以下JSON结构：

{
    "id"  : 15,
    "foo" : { "foo": 123, "bar": "baz" }
}

如果尝试将其解组到如下Go结构体：

立即学习“go语言免费学习笔记（深入）”；

type Bar struct {
    ID  int64  `json:"id"`
    Foo []byte `json:"foo"` // 期望将嵌套对象作为原始字节存储
}

json.Unmarshal会抛出类似json: cannot unmarshal object into Go value of type []uint8的错误。这是因为encoding/json默认会尝试将JSON对象解析为Go的复合类型（如结构体、map），而不能直接将其视为原始字节序列。

解决方案：使用 json.RawMessage

为了解决上述问题，Go标准库在encoding/json包中提供了一个专门的类型：json.RawMessage。

什么是 json.RawMessage？

json.RawMessage是一个[]byte类型，它代表一个原始编码的JSON对象。它的特殊之处在于它实现了json.Marshaler和json.Unmarshaler接口。这意味着当json.Unmarshal遇到一个字段是json.RawMessage类型时，它不会尝试进一步解析这个JSON片段，而是直接将其原始字节内容存储到json.RawMessage实例中。同样，在json.Marshal时，它会直接输出其包含的原始字节内容。

怪兽AI数字人

数字人短视频创作，数字人直播，实时驱动数字人

44

查看详情

其文档描述如下：

type RawMessage []byteRawMessage is a raw encoded JSON object. It implements Marshaler and Unmarshaler and can be used to delay JSON decoding or precompute a JSON encoding.

如何使用 json.RawMessage

将json.RawMessage应用于我们之前的例子，可以轻松实现将嵌套JSON对象作为原始字节处理的需求。

示例代码：

package main

import (
    "encoding/json"
    "fmt"
)

// 定义原始JSON字符串
var jsonStr = []byte(`{
    "id"  : 15,
    "foo" : { "foo": 123, "bar": "baz" }
}`)

// 定义目标Go结构体，其中嵌套对象使用 json.RawMessage 类型
type Bar struct {
    ID  int64           `json:"id"`
    Foo json.RawMessage `json:"foo"` // 使用 json.RawMessage 存储原始JSON片段
}

func main() {
    var bar Bar

    // 尝试解组JSON
    err := json.Unmarshal(jsonStr, &bar)
    if err != nil {
        // 错误处理
        panic(err)
    }

    // 打印解组后的结构体内容
    fmt.Printf("解组结果: %+v\n", bar)

    // 进一步处理 RawMessage 中的内容
    // 如果需要，可以再次对 bar.Foo 进行解组
    var nestedFoo struct {
        Foo int    `json:"foo"`
        Bar string `json:"bar"`
    }
    err = json.Unmarshal(bar.Foo, &nestedFoo)
    if err != nil {
        panic(err)
    }
    fmt.Printf("嵌套Foo字段的进一步解析结果: %+v\n", nestedFoo)

    // 将结构体重新编码为JSON
    marshaledBar, err := json.Marshal(bar)
    if err != nil {
        panic(err)
    }
    fmt.Printf("重新编码为JSON: %s\n", marshaledBar)
}

运行结果：

解组结果: {ID:15 Foo:[123 32 34 102 111 111 34 58 32 49 50 51 44 32 34 98 97 114 34 58 32 34 98 97 122 34 32 125]}
嵌套Foo字段的进一步解析结果: {Foo:123 Bar:baz}
重新编码为JSON: {"id":15,"foo":{"foo":123,"bar":"baz"}}

从输出可以看出，bar.Foo字段成功存储了{"foo": 123, "bar": "baz"}这个JSON对象的原始字节表示。之后，如果需要，我们可以对bar.Foo这个json.RawMessage进行二次解组，将其解析到另一个具体的结构体中。

json.RawMessage 的应用场景

json.RawMessage在以下场景中非常有用：

1. 延迟解析 (Lazy Decoding)：当JSON数据中包含某些字段，这些字段可能不是每次都需要解析，或者它们的解析逻辑比较复杂、耗时。将这些字段存储为json.RawMessage，可以延迟其解析，仅在需要时才进行，从而提高初始解组的性能。
2. 处理动态或不确定结构的JSON：如果JSON的某些部分结构不固定，或者在运行时才能确定其具体类型，json.RawMessage提供了一种灵活的方式来捕获这些未知结构，之后再根据业务逻辑进行自定义解析。
3. 部分JSON处理：只对JSON的某些固定部分感兴趣，而其他部分仅需作为原始数据传递或存储。
4. JSON代理或转发：在实现JSON数据代理服务时，可能需要接收JSON，修改其中一部分，然后将剩余部分原样转发，json.RawMessage在此场景下非常方便。

注意事项

• 内存开销：json.RawMessage会完整地存储原始JSON片段的字节，这可能会比直接解析到具体Go类型占用更多内存（因为具体类型可能只存储所需数据，而RawMessage存储包括键、引号、逗号等在内的所有原始字符）。
• 错误处理：对json.RawMessage进行二次解组时，同样需要进行错误处理，因为其内容可能并非总是有效的JSON。
• 类型安全：json.RawMessage本身不提供任何类型检查。在对其内容进行二次解析时，需要确保目标结构体与RawMessage中存储的JSON结构相匹配。

总结

json.RawMessage是Go语言中处理JSON数据的一个强大且灵活的工具，它允许开发者将JSON的特定部分作为原始字节序列来处理，而非强制进行立即的结构体解析。通过这种方式，可以有效地解决将嵌套JSON对象解组为原始字符串或字节数组的问题，同时支持延迟解析和处理动态JSON结构，从而提升程序的灵活性和性能。在需要对JSON数据进行精细控制或优化性能时，json.RawMessage无疑是一个值得优先考虑的解决方案。

以上就是Go语言中将嵌套JSON对象解组为原始字节数组或字符串的详细内容，更多请关注php中文网其它相关文章！