亲宝软件园·资讯

展开

Go 转 JSON

宇宙之一粟 人气:0

在日常工作中,除了需要从 JSON 转化为 Go 的数据结构。但往往相反的情况是:我们需要将数据以 JSON 字符串的形式发送到 Web 服务器。今天我们将学会如何从一个结构化数据编码为 JSON 。

Json(Javascript Object Nanotation)是一种数据交换格式,常用于前后端数据传输。任意一端将数据转换成json 字符串,另一端再将该字符串解析成相应的数据结构,如string类型,strcut对象等。

结构体转为 JSON 格式

比如,我们有如下的结构体:

type Student struct {
    Name string
    Age int
    Address Address
}

type Address struct {
    Road string
    Street string
    City string
    Province string
    Country string
}

Zhang3 := Student{
        Name: "张三",
        Age:  18,
        Address: Address{
            Road:     "renmin south road",
            Street:   "123 street",
            City:     "cs",
            Province: "hn",
            Country:  "CN",
        },
    }

将学生编码为 JSON 格式,我们可以使用 JSON 包中的 json.Marshl() 函数:

Info_of_Zhang3, err := json.Marshal(Zhang3)
if err == nil {
    fmt.Println(string(Info_of_Zhang3))
} else {
    fmt.Println(err)
    return
}

Marshal() 函数返回编码后的 JSON (字节切片)和 error 信息(如果出错的话)。然后我们可以打印 JSON 字符串。
完整代码如下:

package main

import (
    "encoding/json"
    "fmt"
)

type Student struct {
    Name    string
    Age     int
    Address Address
}

type Address struct {
    Road     string
    Street   string
    City     string
    Province string
    Country  string
}

func main() {

    Zhang3 := Student{
        Name: "张三",
        Age:  18,
        Address: Address{
            Road:     "renmin south road",
            Street:   "123 street",
            City:     "cs",
            Province: "hn",
            Country:  "CN",
        },
    }

    Info_of_Zhang3, err := json.Marshal(Zhang3)
    if err == nil {
        fmt.Println(string(Info_of_Zhang3))
    } else {
        fmt.Println(err)
        return
    }

}

运行代码,得到如下 JSON 数据结果:

$ go run main.go
{"Name":"张三","Age":18,"Address":{"Road":"renmin south road","Street":"123 street","City":"cs","Province":"hn","Country":"CN"}}

当你看 JSON 输出时,你可能已经注意到没有缩进。如果你想缩进输出并很好地格式化它,你可以使用json. MarshalIndent()函数。
比如,使用如下语句:

Info_of_Zhang3, err := json.MarshalIndent(Zhang3, "", "    ")

函数解析:第二个参数指定每行输出的开头的字符串。输出的开头,第三个参数指定每行要缩进的字符串。此时json.MarshalIndent(Zhang3, "", "    ")可以得到如下的输出:

{
    "Name": "张三",
    "Age": 18,
    "Address": {
        "Road": "renmin south road",
        "Street": "123 street",
        "City": "cs",
        "Province": "hn",
        "Country": "CN"
    }
}

接口转为 JSON 格式

有时您并不希望固定结构中的字段数量。 相反,您希望能够在需要的时候添加额外的数据。您可以使用空接口来实现这一点,如下所示:

type Student map[string] interface{}
type Address map[string] interface{}

使用空接口,可以创建自己的 Student 变量,还可以添加想要的元素,就像这样:

Zhang3 := Student{
    "Name": "张三",
    "Age": 18,
    "Address": Address{
        "Road": "renmin south road",
        "Street": "123 street",
        "City": "cs",
        "Province": "hn",
        "Country": "CN",
    },
    "Year": 2022,    // 新增学年
}

完整代码如下:

package main

import (
    "encoding/json"
    "fmt"
)

type Student map[string]interface{}
type Address map[string]interface{}

func main() {
    Zhang3 := Student{
        "Name": "张三",
        "Age":  18,
        "Address": Address{
            "Road":     "renmin south road",
            "Street":   "123 street",
            "City":     "cs",
            "Province": "hn",
            "Country":  "CN",
        },
        "Year":       2022, // 新增学年
        "GraduateAt": 2026, // 毕业年份
    }

    InfoOfZhang3, err := json.MarshalIndent(Zhang3, "", "    ")
    if err == nil {
        fmt.Println(string(InfoOfZhang3))
    } else {
        fmt.Println(err)
    }
}

代码输出结果为:

{
    "Address": {
        "City": "cs",
        "Country": "CN",
        "Province": "hn",
        "Road": "renmin south road",
        "Street": "123 street"
    },
    "Age": 18,
    "GraduateAt": 2026,
    "Name": "张三",
    "Year": 2022
}

同时我们能看到输出的 JSON 中的键的顺序是按字母排序的。

Marshal() 函数的原型

我们看一下 Marshal 函数:

func Marshal(v interface{}) ([]byte, error) {
   e := newEncodeState()

   err := e.marshal(v, encOpts{escapeHTML: true})
   if err != nil {
      return nil, err
   }
   buf := append([]byte(nil), e.Bytes()...)

   e.Reset()
   encodeStatePool.Put(e)

   return buf, nil
}

函数可以接收任意类型的接口数据 v,并转换为字节数组类型,返回值就是 JSON 数据和错误信息;若转换成功,则 err == nil;
在进行对象转换为JSON的过程中,会遵循一下几条原则:
a. 布尔型转换为JSON后仍然是布尔型;
b. 浮点型转换为JSON后里面的常规数字;
c. 字符串将以 UTF-8 编码转化输出为 Unicode 字符串,将特殊字符转义;
d. 数组和切片被转换为JSON里面的数组,[]byte类会被转换为 base64 编码后的字符串,slice的零值被转换为null;
e. 结构体转换为 JSON 对象,并且只有结构体内变量必须首字母大写,才可被导出的字段转化输出,而且这些字段会被作为 JSON 对象的字符串索引;
f. 转换一个 map 类型的数据结构时,该数据的类型必须时 map[string]T ,T 可以是encoding/json 包支持的任意类型。

总结

本文只是简单的把 Go 语言常见的结构体和接口转化为 JSON 数据,其他类型类似,最后给出了编码的函数 Marshal() 原型, 并简单进行了解释。

除此之外,encoding/json 包还提供了 Encode() 和 Decode() 函数用于单一对象的格式转化,而 Marshal() 和 Unmarshal() 函数工作于多个对象和字节流上。

其实,本文只是简单的介绍了 Go 语言和 JSON 数据在控制台的简单转化,等后续的文章介绍了文件读取和写入时,就可以学会与 JSON 文件打交道了。敬请期待!

加载全部内容

相关教程
猜你喜欢
用户评论