1.  
  2. 主页
  3.  / 
  4. Go 每日一库
  5.  / 
  6. Go 每日一库之 gojsonq 使用详解

Go 每日一库之 gojsonq 使用详解

简介

在日常工作中,每一名开发者,不管是前端还是后端,都经常使用 JSON。

JSON 是一个很简单的数据交换格式。相比于 XML,它灵活、轻巧、使用方便。

JSON 也是RESTful API推荐的格式。有时,我们只想读取 JSON 中的某一些字段。如果自己手动解析、一层一层读取,这就变得异常繁琐了。特别是在嵌套层次很深的情况下。

今天我们介绍gojsonq。它可以帮助我们很方便的操作 JSON。

快速使用

先安装:

后使用:

操作非常简单:

  • 首先调用gojsonq.New()创建一个JSONQ的对象;
  • 然后就可以使用该类型的方法来查询属性了。

上面代码我们直接读取位于最内层的district值和hobbies数组的第一个元素!层与层之间用.隔开,如果是数组,则在属性字段后通过.[index]读取下标为index的元素。这种方式可以实现很灵活的读取。

注意到一个细节:在查询之后,我们手动调用了一次Reset()方法。因为JSONQ对象在调用Find方法时,内部会记录当前的节点,下一个查询会从上次查找的节点开始。也就是说如果我们注释掉jq.Reset(),第二个Find()方法实际上查找的是user.address.district.user.hobbies.[0],自然就返回nil了。除此之外,gojsonq也提供了另外一种方式。如果你想要保存当前查询的一些状态信息,可以调用JSONQCopy方法返回一个初始状态下的对象,它们会共用底层的 JSON 字符串和解析后的对象。上面的gq.Reset()可以由下面这行代码代替:

后面就可以使用gpCopy查询hobbies了。

这个算是gojsonq库的一个特点,但也是初学者带来了很多困扰,需要特别注意。实际上,JSONQ提供的很多方法会改变当前节点,稍后部分我们会更清楚的看到。

数据源

除了从字符串中加载,jsonq还允许从文件和io.Reader中读取内容。分别使用JSONQ对象的FileReader方法:

和下面程序的效果是一样的:

为了后面演示方便,我构造了一个data.json文件:

高级查询

gojsonq的独特之处在于,它可以像 SQL 一样进行条件查询,可以选择返回哪些字段,可以做一些聚合统计。

字段映射

有时候,我们只关心对象中的几个字段,这时候就可以使用Select指定返回哪些字段,其余字段不返回:

只会输出idname字段:

为了显示更直观一点,我这里用json.MarshalIndent()对输出做了一些美化。

是不是和 SQL 有点像Select id,name From items

这里介绍一下From方法,这个方法的作用是将当前节点移动到指定位置。上面也说过当前节点的位置是记下来的。

例如,上面的代码中我们先将当前节点移动到items,后面的查询和聚合操作都是针对这个数组。实际上Find方法内部就调用了From

最后必须要调用Get(),它组合所有条件后执行这个查询,返回结果。

条件查询

有了SelectFrom,怎么能没有Where呢?gojsonq提供的Where方法非常多,我们大概看几个就行了。

首先是,Where(key, op, val),这个是通用的Where条件,表示keyval是否满足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连接:

上面第一个查询,查找id为 1  2 的记录。第二个查询,查找count大于 1  price小于 100 的记录。

指定偏移和返回条目数

有时我们想要分页显示,第一次查询时返回前 3 条内容,第二次查询时返回接下来的 3 条记录。

我们可以使用JSONQ对象的OffsetLimit方法来指定偏移和返回的条目数:

来看看运行结果:

聚合统计

我们还能可以对一些字段做简单的统计,计算和、平均数、最大、最小值等:

上面统计商品的总数量、最低价格、最高价格和平均价格。

聚合统计类的方法都不会修改当前节点的指向,所以JSONQ对象可以重复使用!

还可以对数据进行分组和排序:

其他格式

默认情况下,gojsonq使用 JSON 格式解析数据。

我们也可以设置其他格式解析器让gojsonq可以处理其他格式的数据:

上面代码用到了yaml库,需要额外安装:

解析器只要实现gojsonq.Decoder接口,都可以作为设置到gojsonq中,这样就可以实现任何格式的处理:

总结

gojsonq还有一些高级特性,例如自定义Where的操作类型,取第一个、最后一个、第 N 个值等。

大家如果发现好玩、好用的 Go 语言库,欢迎到 Go 每日一库 GitHub 上提交 issue。

参考

  1. gojsonq GitHub:https://github.com/thedevsaddam/gojsonq
  2. Go 每日一库 GitHub:https://github.com/darjun/go-daily-lib
这篇文章对您有用吗?

我们要如何帮助您?

发表评论

邮箱地址不会被公开。 必填项已用*标注