Go 语言提供了关于 json 的标准库包 encoding/json
。
详细官网文档见 json package - encoding/json - pkg.go.dev,这里只介绍几种常用操作。
1. 编码
编码分为两步:
- 创建一个新的 json 文件;
- 将数据结构中的内容按格式写入 json 文件。
第二步的写入,首先要使用 json.NewEncoder()
创建一个编码器,其参数是我们新创建的 json 文件指针。然后编码要使用编码器中的 Encode()
方法,其参数是我们要编码进 json 的内容。
package main
import (
"encoding/json"
"log"
"os"
)
type RepoArr struct {
Repo1 string
Repo2 string
Repo3 string
}
type Config struct {
Name string
Blog string
Repo RepoArr
StrArr []string
}
func main() {
jsonPath := "./myinfo.json"
info := []Config{{"gukaifeng", "https://gukaifeng.cn", RepoArr{"git@github.com:gukaifeng/hexo.git", "git@github.com:gukaifeng/hexo.git_2", "git@github.com:gukaifeng/hexo.git_3"}, []string{}},
{"gukaifeng2", "https://gukaifeng.cn2", RepoArr{"git@github.com:gukaifeng/hexo.git2", "git@github.com:gukaifeng/hexo.git2_2", "git@github.com:gukaifeng/hexo.git2_3"}, []string{"string-test-1", "string-test-2"}}}
jsonFile, err := os.Create(jsonPath) // 创建 json 文件
if err != nil {
log.Printf("create json file %v error [ %v ]", jsonPath, err)
return
}
defer jsonFile.Close()
encode := json.NewEncoder(jsonFile) // 创建编码器
err = encode.Encode(info) // 编码
if err != nil {
log.Printf("encode error [ %v ]", err)
return
}
}
我们执行代码后,会在 go 程序同级目录发现一个新的 myinfo.json 文件。
我们可以发现,go 写入的 json,key 与 value 是和我们的写入数据结构体中的成员名与其值相对应的。
2. 解码
同样的,解码也是分两步:
- 打开待解码的 json 文件;
- 使用 json 包提供的方法解码 json 文件到数据结构中。
第 2 步的解码首先要使用 json.NewDecoder()
创建一个解码器,其参数是我们打开的 json 文件指针。然后解码要使用解码器中的 Decode()
方法,其参数是将要存储解码信息的数据结构对象。
我们下面通过具体例子来解释。
2.1. 只有一组 json 项
假设我们有一个 myinfo.json
,与我们的 go 程序在同级目录,其中内容如下:
{
"name": "gukaifeng",
"blog": "https://gukaifeng.cn",
"repo": "git@github.com:gukaifeng/hexo.git"
}
我们看 go 语言解码代码:
package main
import (
"encoding/json"
"fmt"
"log"
"os"
)
type Config struct {
Repo string
Blog string
Name string
}
func main() {
jsonPath := "./myinfo.json"
jsonFile, err := os.Open(jsonPath)
if err != nil {
log.Printf("open json file %v error [ %v ]", jsonPath, err)
return
}
defer jsonFile.Close()
var conf Config
decoder := json.NewDecoder(jsonFile)
err = decoder.Decode(&conf)
if err != nil {
log.Printf("decode error [ %v ]", err)
return
} else {
fmt.Println(conf.Name)
fmt.Println(conf.Blog)
fmt.Println(conf.Repo)
}
}
请注意,我们第 10-14 行定义的 Config,其中的成员顺序,无需与 json 文件中的顺序一致。
Go 语言中的 json 包会自动识别 json 项到相应的成员中(json 项与成员变量名对应,不区分大小写),所以我们在 33-35 行中打印出了正确的值。
2.2. 有多组 json 项
我们上面的 json 示例中,只有一组项,即 name/blog/repo,我们看看有多组项的时候如何解析。
有多组项的时候,不论是外层还是里层的值,只要把存储解析的变量改为数组即可。
2.2.1. 外层多组 json 项
我们修改 2.1 中的 myinfo.json
如下:
[
{
"name": "gukaifeng",
"blog": "https://gukaifeng.cn",
"repo": "git@github.com:gukaifeng/hexo.git"
},
{
"name": "gukaifeng2",
"blog": "https://gukaifeng.cn2",
"repo": "git@github.com:gukaifeng/hexo.git2"
}
]
我们只需要修改上面代码第 26 行:
var conf Config -> var conf []Config
即:
package main
import (
"encoding/json"
"fmt"
"log"
"os"
)
type Config struct { // 这里成员的顺序与 json 文件中的顺序不一致
Repo string
Blog string
Name string
}
func main() {
jsonPath := "./myinfo.json"
jsonFile, err := os.Open(jsonPath) // 打开 json 文件
if err != nil {
log.Printf("open json file %v error [ %v ]", jsonPath, err)
return
}
defer jsonFile.Close()
var conf []Config
decoder := json.NewDecoder(jsonFile) // 创建 json 解码器
err = decoder.Decode(&conf) // 解码 json 文件
if err != nil {
log.Printf("decode error [ %v ]", err)
return
} else {
fmt.Println(conf)
}
}