0

0

保持Go中未解析JSON字段的最佳方法

碧海醫心

碧海醫心

发布时间:2025-10-29 15:29:45

|

360人浏览过

|

来源于php中文网

原创

保持go中未解析json字段的最佳方法

本文探讨了在Go语言中使用`encoding/json`包处理JSON数据时,如何解码部分字段到结构体,同时保留未定义在结构体中的其他字段。我们将介绍使用`json.RawMessage`类型和自定义`Unmarshaler`/`Marshaler`接口的方法,并简要提及其他库的解决方案,以帮助开发者灵活处理动态JSON数据。

在Go语言中处理JSON数据时,经常会遇到需要将JSON数据解码到结构体,进行一些操作后再重新编码回JSON的情况。然而,JSON数据中可能包含一些结构体中未定义的字段,这些字段可能是动态的,并且需要在重新编码时保留。encoding/json包本身并没有直接提供保留这些未知字段的机制,但我们可以通过一些技巧来实现这一目标。

使用 json.RawMessage

json.RawMessage 类型允许我们延迟解析JSON数据。我们可以将JSON数据的一部分直接存储为原始的JSON数据,稍后再进行处理。以下是一个示例:

package main

import (
    "encoding/json"
    "fmt"
)

type Person struct {
    Name    string          `json:"name"`
    Age     uint            `json:"age"`
    Phone   string          `json:"phone"`
    Address json.RawMessage `json:"address,omitempty"` // 将未知字段存储在这里
}

func main() {
    jsonData := []byte(`{ "name": "Joe Smith", "age": 42, "phone": "614-555-1212", "debug": true, "codeword": "wolf", "address": {"street": "Main St", "city": "Anytown"} }`)

    var p Person
    err := json.Unmarshal(jsonData, &p)
    if err != nil {
        fmt.Println("Error unmarshaling JSON:", err)
        return
    }

    // Happy birthday
    p.Age++

    // 修改Address 中的数据
    var addressMap map[string]interface{}
    if err := json.Unmarshal(p.Address, &addressMap); err != nil {
        fmt.Println("Error unmarshaling Address:", err)
        return
    }

    addressMap["street"] = "New Street"
    newAddress, err := json.Marshal(addressMap)
    if err != nil {
        fmt.Println("Error marshaling Address:", err)
        return
    }
    p.Address = newAddress

    data, err := json.Marshal(p)
    if err != nil {
        fmt.Println("Error marshaling JSON:", err)
        return
    }

    fmt.Println(string(data))
}

在这个例子中,Address 字段被声明为 json.RawMessage 类型。当JSON数据被解码时,所有不在 Person 结构体中的字段,包括 debug 和 codeword,会被存储在 Address 中。当重新编码回JSON时,这些字段会被原样保留。

注意事项:

  • 使用 json.RawMessage 需要手动处理未解析的JSON数据,这可能涉及到额外的解析和编码步骤。
  • 需要预先知道哪些字段可能是不确定的,并将它们放入 json.RawMessage 字段中。

实现 Unmarshaler 和 Marshaler 接口

另一种方法是实现自定义的 Unmarshaler 和 Marshaler 接口。通过这种方式,我们可以完全控制JSON数据的解码和编码过程。以下是一个示例:

Picsart
Picsart

Picsart是全球最大的数字创作平台。

下载
package main

import (
    "encoding/json"
    "fmt"
)

type Person struct {
    Name    string                 `json:"name"`
    Age     uint                   `json:"age"`
    Phone   string                 `json:"phone"`
    Unknown map[string]interface{} `json:"-"` // 忽略编码,手动处理
}

func (p *Person) UnmarshalJSON(data []byte) error {
    // 定义一个辅助类型,避免无限递归
    type Alias Person
    aux := &struct {
        *Alias
    }{
        Alias: (*Alias)(p),
    }

    // 先将已知的字段解码到结构体
    if err := json.Unmarshal(data, &aux); err != nil {
        return err
    }

    // 解码到 map[string]interface{},获取所有字段
    var allFields map[string]interface{}
    if err := json.Unmarshal(data, &allFields); err != nil {
        return err
    }

    // 过滤掉已知的字段,将未知的字段存储到 Unknown 字段
    p.Unknown = make(map[string]interface{})
    knownFields := map[string]bool{"name": true, "age": true, "phone": true}
    for k, v := range allFields {
        if !knownFields[k] {
            p.Unknown[k] = v
        }
    }

    return nil
}

func (p Person) MarshalJSON() ([]byte, error) {
    // 定义一个辅助类型,避免无限递归
    type Alias Person
    aux := &struct {
        *Alias
        Unknown map[string]interface{} `json:",omitempty"` // 将 Unknown 字段添加到 JSON
    }{
        Alias:   (*Alias)(&p),
        Unknown: p.Unknown,
    }

    return json.Marshal(aux)
}

func main() {
    jsonData := []byte(`{ "name": "Joe Smith", "age": 42, "phone": "614-555-1212", "debug": true, "codeword": "wolf" }`)

    var p Person
    err := json.Unmarshal(jsonData, &p)
    if err != nil {
        fmt.Println("Error unmarshaling JSON:", err)
        return
    }

    // Happy birthday
    p.Age++

    data, err := json.Marshal(p)
    if err != nil {
        fmt.Println("Error marshaling JSON:", err)
        return
    }

    fmt.Println(string(data))
}

在这个例子中,我们实现了 UnmarshalJSON 和 MarshalJSON 方法。UnmarshalJSON 方法首先将JSON数据解码到结构体,然后将所有字段解码到一个 map[string]interface{} 中,并将未知的字段存储到 Unknown 字段中。MarshalJSON 方法将 Unknown 字段添加到JSON数据中,然后再进行编码。

注意事项:

  • 实现 Unmarshaler 和 Marshaler 接口需要编写更多的代码,但可以提供更灵活的控制。
  • 需要小心处理递归调用,避免无限循环。

其他库的解决方案

除了 encoding/json 包之外,还有一些其他的库提供了更方便的解决方案。例如,labix.org/v2/mgo/bson 库提供了 inline 标签,可以用于将未知字段直接嵌入到结构体中。

总结

在Go语言中,保留未解析的JSON字段需要一些技巧。json.RawMessage 类型和自定义 Unmarshaler 和 Marshaler 接口是两种常用的方法。选择哪种方法取决于具体的需求和场景。如果只需要简单地保留未知字段,json.RawMessage 类型可能更简单。如果需要更灵活的控制,自定义 Unmarshaler 和 Marshaler 接口可能更合适。同时,也可以考虑使用其他库提供的解决方案。

相关专题

更多
json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

400

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

528

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

305

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

67

2025.09.10

string转int
string转int

在编程中,我们经常会遇到需要将字符串(str)转换为整数(int)的情况。这可能是因为我们需要对字符串进行数值计算,或者需要将用户输入的字符串转换为整数进行处理。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

311

2023.08.02

golang结构体相关大全
golang结构体相关大全

本专题整合了golang结构体相关大全,想了解更多内容,请阅读专题下面的文章。

193

2025.06.09

golang结构体方法
golang结构体方法

本专题整合了golang结构体相关内容,请阅读专题下面的文章了解更多。

184

2025.07.04

硬盘接口类型介绍
硬盘接口类型介绍

硬盘接口类型有IDE、SATA、SCSI、Fibre Channel、USB、eSATA、mSATA、PCIe等等。详细介绍:1、IDE接口是一种并行接口,主要用于连接硬盘和光驱等设备,它主要有两种类型:ATA和ATAPI,IDE接口已经逐渐被SATA接口;2、SATA接口是一种串行接口,相较于IDE接口,它具有更高的传输速度、更低的功耗和更小的体积;3、SCSI接口等等。

980

2023.10.19

苹果官网入口直接访问
苹果官网入口直接访问

苹果官网直接访问入口是https://www.apple.com/cn/,该页面具备0.8秒首屏渲染、HTTP/3与Brotli加速、WebP+AVIF双格式图片、免登录浏览全参数等特性。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

10

2025.12.24

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WEB前端教程【HTML5+CSS3+JS】
WEB前端教程【HTML5+CSS3+JS】

共101课时 | 8万人学习

JS进阶与BootStrap学习
JS进阶与BootStrap学习

共39课时 | 3.1万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号