简介
在日常工作中,每一名开发者,不管是前端还是后端,都经常使用 JSON。JSON 是一个很简单的数据交换格式。相比于 XML,它灵活、轻巧、使用方便。JSON 也是RESTful API推荐的格式。有时,我们只想读取 JSON 中的某一些字段。如果自己手动解析、一层一层读取,这就变得异常繁琐了。特别是在嵌套层次很深的情况下。今天我们介绍gojsonq
。它可以帮助我们很方便的操作 JSON。
快速使用
先安装:
$ go get github.com/thedevsaddam/gojsonq
后使用:
package main
import (
"fmt"
"github.com/thedevsaddam/gojsonq"
)
func main() {
content := `{
"user": {
"name": "dj",
"age": 18,
"address": {
"provice": "shanghai",
"district": "xuhui"
},
"hobbies":["chess", "programming", "game"]
}
}`
gq := gojsonq.New().FromString(content)
district := gq.Find("user.address.district")
fmt.Println(district)
gq.Reset()
hobby := gq.Find("user.hobbies.[0]")
fmt.Println(hobby)
}
操作非常简单:
- 首先调用
gojsonq.New()
创建一个JSONQ
的对象; - 然后就可以使用该类型的方法来查询属性了。
上面代码我们直接读取位于最内层的district
值和hobbies
数组的第一个元素!层与层之间用.
隔开,如果是数组,则在属性字段后通过.[index]
读取下标为index
的元素。这种方式可以实现很灵活的读取。
注意到一个细节:在查询之后,我们手动调用了一次Reset()
方法。因为JSONQ
对象在调用Find
方法时,内部会记录当前的节点,下一个查询会从上次查找的节点开始。也就是说如果我们注释掉jq.Reset()
,第二个Find()
方法实际上查找的是user.address.district.user.hobbies.[0]
,自然就返回nil
了。除此之外,gojsonq
也提供了另外一种方式。如果你想要保存当前查询的一些状态信息,可以调用JSONQ
的Copy
方法返回一个初始状态下的对象,它们会共用底层的 JSON 字符串和解析后的对象。上面的gq.Reset()
可以由下面这行代码代替:
gpCopy := gp.Copy()
后面就可以使用gpCopy
查询hobbies
了。
这个算是gojsonq
库的一个特点,但也是初学者带来了很多困扰,需要特别注意。实际上,JSONQ
提供的很多方法会改变当前节点,稍后部分我们会更清楚的看到。
数据源
除了从字符串中加载,jsonq
还允许从文件和io.Reader
中读取内容。分别使用JSONQ
对象的File
和Reader
方法:
func main() {
gq := gojsonq.New().File("./data.json")
fmt.Println(gq.Find("items.[1].price"))
}
和下面程序的效果是一样的:
func main() {
file, err := os.OpenFile("./data.json", os.O_RDONLY, 0666)
if err != nil {
log.Fatal(err)
}
gq := gojsonq.New().Reader(file)
fmt.Println(gq.Find("items.[1].price"))
}
为了后面演示方便,我构造了一个data.json
文件:
{
"name": "shopping cart",
"description": "List of items in your cart",
"prices": ["2400", "2100", "1200", "400.87", "89.90", "150.10"],
"items": [
{
"id": 1,
"name": "Apple",
"count": 2,
"price": 12
},
{
"id": 2,
"name": "Notebook",
"count": 10,
"price": 3
},
{
"id": 3,
"name": "Pencil",
"count": 5,
"price": 1
},
{
"id": 4,
"name": "Camera",
"count": 1,
"price": 1750
},
{
"id": null,
"name": "Invalid Item",
"count": 1,
"price": 12000
}
]
}
高级查询
gojsonq
的独特之处在于,它可以像 SQL 一样进行条件查询,可以选择返回哪些字段,可以做一些聚合统计。
字段映射
有时候,我们只关心对象中的几个字段,这时候就可以使用Select
指定返回哪些字段,其余字段不返回:
func main() {
r := gojsonq.New().File("./data.json").From("items").Select("id", "name").Get()
data, _ := json.MarshalIndent(r, "", " ")
fmt.Println(string(data))
}
只会输出id
和name
字段:
$ go run main.go
[
{
"id": 1,
"name": "Apple"
},
{
"id": 2,
"name": "Notebook"
},
{
"id": 3,
"name": "Pencil"
},
{
"id": 4,
"name": "Camera"
},
{
"id": null,
"name": "Invalid Item"
}
]
为了显示更直观一点,我这里用json.MarshalIndent()
对输出做了一些美化。
是不是和 SQL 有点像Select id,name From items
...
这里介绍一下From
方法,这个方法的作用是将当前节点移动到指定位置。上面也说过当前节点的位置是记下来的。例如,上面的代码中我们先将当前节点移动到items
,后面的查询和聚合操作都是针对这个数组。实际上Find
方法内部就调用了From
:
// src/github.com/thedevsaddam/gojsonq/jsonq.go
func (j *JSONQ) Find(path string) interface{} {
return j.From(path).Get()
}
func (j *JSONQ) From(node string) *JSONQ {
j.node = node
v, err := getNestedValue(j.jsonContent, node, j.option.separator)
if err != nil {
j.addError(err)
}
// ============= 注意这一行,记住当前节点位置
j.jsonContent = v
return j
}
最后必须要调用Get()
,它组合所有条件后执行这个查询,返回结果。
条件查询
有了Select
和From
,怎么能没有Where
呢?gojsonq
提供的Where
方法非常多,我们大概看几个就行了。
首先是,Where(key, op, val)
,这个是通用的Where
条件,表示key
和val
是否满足op
关系。op
内置的就有将近 20 种,还支持自定义。例如=
表示相等,!=
表示不等,startsWith
表示val
是否是key
字段的前缀等等等等;
其他很多条件都是Where
的特例,例如WhereIn(key, val)
就等价于Where(key, "in", val)
,WhereStartsWith(key, val)
就等价于Where(key, "startsWith", val)
。
默认情况下,Where
的条件都是And
连接的,我们可以通过OrWhere
让其以Or
连接:
func main() {
gq := gojsonq.New().File("./data.json")
r := gq.From("items").Select("id", "name").
Where("id", "=", 1).OrWhere("id", "=", 2).Get()
fmt.Println(r)
gq.Reset()
r = gq.From("items").Select("id", "name", "count").
Where("count", ">", 1).Where("price", "