Go JSON Unmarshal 嵌套对象为原始字节或字符串

本文深入探讨了在Go语言中使用`encoding/json`包处理JSON数据时，如何将嵌套的JSON对象直接解组（Unmarshal）为原始字节切片（`[]byte`）或字符串，而非将其解析为具体的Go结构体。通过介绍`json.RawMessage`类型，文章详细阐述了其原理、用法，并提供了实用的代码示例，帮助开发者有效地处理复杂的JSON结构，实现按需延迟解析，避免不必要的预解析错误。

在Go语言中，处理JSON数据是日常开发中常见的任务。encoding/json包提供了强大的功能来序列化（Marshal）和反序列化（Unmarshal）JSON。然而，在某些场景下，我们可能不希望立即解析JSON中所有的嵌套对象，而是希望将某个特定的嵌套对象作为一个原始的JSON字符串或字节切片来处理。例如，当JSON结构非常复杂、部分字段不确定或仅在特定条件下才需要进一步解析时，这种需求尤为突出。

问题场景：嵌套JSON对象解组为原始数据

假设我们有如下JSON数据：

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

我们希望将其解组到一个Go结构体中，其中id字段映射为int64，而foo字段（一个嵌套的JSON对象）则直接作为原始的字节切片（[]byte）存储，而不是被解析成另一个Go结构体。

如果尝试将foo字段定义为[]byte类型：

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对象直接解组到[]byte类型中，因为它期望的是一个JSON数组或字符串。为了解决这个问题，我们需要利用encoding/json包提供的一个特殊类型：json.RawMessage。

快转字幕

新一代 AI 字幕工作站，为创作者提供字幕制作、学习资源、会议记录、字幕制作等场景，一键为您的视频生成精准的字幕。

357

查看详情

解决方案：使用 json.RawMessage

json.RawMessage是encoding/json包中提供的一个特殊类型，它的底层实际上是[]byte。它实现了json.Marshaler和json.Unmarshaler接口，这使得它在JSON编解码过程中具有特殊的行为。

json.RawMessage的特性：

• 延迟解码： 当json.Unmarshal遇到json.RawMessage类型的字段时，它不会尝试解析该字段的内部结构，而是直接将其对应的原始JSON数据（包括大括号、引号等）作为字节切片存储。
• 预计算编码： 同样，当json.Marshal遇到json.RawMessage类型的字段时，它会直接将存储在其中的字节切片作为JSON的一部分输出，而不会再次对其进行编码。

这使得json.RawMessage非常适合用于存储未解析的JSON片段，或者在需要时手动进行二次解析。

示例代码

下面是一个使用json.RawMessage来解决上述问题的完整示例：

package main

import (
    "encoding/json"
    "fmt"
)

// 假设的JSON数据
var jsonStr = []byte(`{
    "id"  : 15,
    "foo" : { "foo": 123, "bar": "baz" }
}`)

// 定义目标结构体，使用json.RawMessage来存储嵌套的"foo"对象
type Bar struct {
    ID  int64           `json:"id"`
    Foo json.RawMessage `json:"foo"` // 使用json.RawMessage
}

func main() {
    var bar Bar

    // 执行JSON解组
    err := json.Unmarshal(jsonStr, &bar)
    if err != nil {
        fmt.Printf("Unmarshal error: %v\n", err)
        return
    }

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

    // 进一步解析嵌套的"foo"字段
    // 如果需要，可以随时将RawMessage中的内容解析到另一个结构体
    type FooDetail struct {
        Foo int    `json:"foo"`
        Bar string `json:"bar"`
    }
    var fooDetail FooDetail
    err = json.Unmarshal(bar.Foo, &fooDetail) // 对bar.Foo进行二次Unmarshal
    if err != nil {
        fmt.Printf("Unmarshal fooDetail error: %v\n", err)
        return
    }
    fmt.Printf("Foo字段二次解析结果: %+v\n", fooDetail)
}

代码解释：

1. type Bar struct { ... Foo json.RawMessagejson:"foo"... }: 在Bar结构体中，我们将Foo字段的类型定义为json.RawMessage。通过json:"foo"标签，它将与输入JSON中的"foo"键进行匹配。
2. err := json.Unmarshal(jsonStr, &bar): 当执行Unmarshal时，encoding/json包会识别到Foo字段是json.RawMessage类型。因此，它不会尝试解析{"foo": 123, "bar": "baz"}这个对象，而是将其原始的字节表示（包括大括号和内部内容）直接存储到bar.Foo中。
3. fmt.Printf("解组结果: %+v\n", bar): 打印结果会显示bar.Foo字段包含的是原始的字节切片，例如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": 123, "bar": "baz"}的ASCII字节表示。
4. 二次解析 (json.Unmarshal(bar.Foo, &fooDetail)): 示例中还展示了如何对bar.Foo（即json.RawMessage）进行二次Unmarshal。这允许我们在需要时，将原始的JSON片段解析成一个具体的Go结构体，实现了按需解析。

注意事项

• 错误处理： 在实际应用中，务必对json.Unmarshal等操作进行严格的错误检查，确保数据处理的健壮性。
• 性能考量： json.RawMessage避免了立即解析整个嵌套结构，这在处理大型JSON或仅需要部分字段的场景下，可以带来性能上的优势。
• 与string的区别： 虽然json.RawMessage底层是[]byte，但它不是普通的[]byte。如果直接将字段类型定义为string或[]byte，json.Unmarshal会尝试将其作为JSON字符串或JSON数组（分别对应Go的string和[]byte）进行解析，而不是一个JSON对象。json.RawMessage的特殊之处在于它能够“捕获”任何有效的JSON片段（对象、数组、字符串、数字、布尔值、null）作为原始字节。

总结

json.RawMessage是Go语言encoding/json包中一个非常实用的类型，它为开发者提供了一种灵活的方式来处理复杂的JSON结构。通过将嵌套的JSON对象解组为原始字节切片，我们可以实现延迟解析，根据业务逻辑按需处理数据，从而提高程序的灵活性和效率。掌握json.RawMessage的用法，是Go语言JSON处理进阶的关键一步。

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