json

简介

JSON（JavaScript Object Notation）是一种轻量级的数据交换格式，易于阅读和编写，同时也易于机器解析和生成。它基于 JavaScript Programming Language, Standard ECMA-262 3rd Edition - December 1999 的一个子集。

JSON 是一种使用 UTF-8 编码的纯文本格式，采用完全独立于语言的文本格式，由于写起来比 XML 格式方便，并且更为紧凑，同时所需的处理时间也更少，致使 JSON 格式越来越流行，特别是在通过网络连接传送数据方面。

开发人员可以使用 JSON 传输简单的字符串、数字、布尔值，也可以传输一个数组或者一个更复杂的复合结构。在 Web 开发领域中，JSON 被广泛应用于 Web 服务端程序和客户端之间的数据通信。

Go语言内建对 JSON 的支持，使用内置的 encoding/json 标准库，开发人员可以轻松使用Go程序生成和解析 JSON 格式的数据。

JSON 结构如下所示：

{"key1":"value1","key2":"value2","key3":["value3","value4","value5"]}

用到的api

• func Marshal(v any) ([]byte, error)
• func MarshalIndent(v any, prefix, indent string) ([]byte, error)
• func Unmarshal(data []byte, v any) error
• func NewDecoder(r io.Reader) *Decoder
• func (dec *Decoder) Decode(v any) error
• func NewEncoder(w io.Writer) *Encoder
• func (enc *Encoder) Encode(v any) error
• func (enc *Encoder) SetIndent(prefix, indent string)

写 JSON 文件

使用Go语言创建一个 json 文件非常方便，示例代码如下：

package main

import (
    "encoding/json"
    "errors"
    "fmt"
    "io/ioutil"
    "os"
)

type Person struct {
    Name  string   `json:"name"`
    Age   int      `json:"age"`
    Likes []string `json:"likes"`
}

func main() {
    info := []Person{
        {
            Name: "Scott",
            Age:  18,
            Likes: []string{
                "西红柿炒鸡蛋",
                "烟笋腊肉",
                "鱼当道",
            },
        },
        {
            Name: "Simon",
            Age:  18,
            Likes: []string{
                "酸辣土豆丝",
                "剁椒鱼头",
                "蛙小侠",
            },
        },
        {
            Name: "Judy",
            Age:  18,
            Likes: []string{
                "",
                "宫保鸡丁",
                "油淋茄子",
                "椰子鸡",
            },
        },
    }

    err := write1("info.json", info)
    if err != nil {
        fmt.Println(err.Error())
        return
    }
    fmt.Println("json文件写入成功")

}

func write1(file string, data interface{}) error {
    // __data, err := json.Marshal(data) //如果想节省文件大小就用这个api
    __data, err := json.MarshalIndent(data, "", "  ") //func MarshalIndent(v any, prefix, indent string) ([]byte, error)
    if err != nil {
        return err
    }
    return ioutil.WriteFile(file, __data, 0755)
}

func write2(file string, data interface{}) error {
    filePtr, err := os.Create(file)
    if err != nil {
        return errors.New("文件创建失败")
    }
    defer filePtr.Close()

    // 创建Json编码器
    encoder := json.NewEncoder(filePtr)
    encoder.SetIndent("", " ") //如果想节省文件大小就删掉这一行func (enc *Encoder) SetIndent(prefix, indent string)
    err = encoder.Encode(data)
    if err != nil {
        return errors.New("编码错误")
    }
    return nil
}

这里的write1和write2功能是等效的，运行结果：

读 JSON 文件

读 JSON 数据与写 JSON 数据一样简单，示例代码如下：

package main

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

type Person struct {
    Name  string   `json:"name"`
    Age   int      `json:"age"`
    Likes []string `json:"likes"`
}

func main() {
    filePtr, err := os.Open("./info.json")
    if err != nil {
        fmt.Println("文件打开失败 [Err:%s]", err.Error())
        return
    }
    defer filePtr.Close()
    var info []Person
    // 创建json解码器
    decoder := json.NewDecoder(filePtr)
    err = decoder.Decode(&info)
    if err != nil {
        fmt.Println("解码失败", err.Error())
    } else {
        fmt.Println("解码成功")
        fmt.Println(info)
    }
}

顺便提一下，还有一种叫做 BSON (Binary JSON) 的格式与 JSON 非常类似，与 JSON 相比，BSON 着眼于提高存储和扫描效率。BSON 文档中的大型元素以长度字段为前缀以便于扫描。在某些情况下，由于长度前缀和显式数组索引的存在，BSON 使用的空间会多于 JSON。