关于使用jq 处理json格式的简单笔记

Posted 2023-04-21

参考技术A

json格式包含有如下的基本类型 ： 数字，字符串，false, true, null
而由基本类型组成的复合类型有 ： 数组，对象；其中数组是以 [ ] 进行标记的，而对象是以 进行标记;

jq 这个命令用来处理json数据格式，非常方便，简单记录其常用的使用方法如下：
A. 对于数组的处理：
1). 如果 jq 要处理的json是 数组类型，那么用 “ jq .[ ] ” 可以将数组的最外层的[ ] 标记脱掉, 从而变成 对象 类型。
2). 上述命令的 中括号里面可以带有参数，这个参数就是 数组的下标，这个下标从前向后最小是 0，最大值没有限制，如果超出，那么就会return null. 同时支持下标从后向前基数，最小为-1. 但是参数的值除了数字，不可以是空格. 同时数组的下表支持 切片，也就是 [2:7] 或者 [1,2,5,7] 这种格式都是支持的.
B. 对于对象的处理：
1). 因为对象里面的每个元素都是 key:value的形式存在，虽然value 也可以是一个复合类型，但是不影响 key:value 这种格式，所以对于对象，通常用 jq .key 这种方式来获取对应key的value. 其中key 在这里可以不用引号括起来,当然也可以用引号括起来,反正key都是字符串类型。
2). 如果要获得对象所有元素的key值，那么要把 |keys 串接在对象后面，需要注意的是 这里不是利用的shell的管道，而是jq内置的管道，所以属于jq的参数的一部分. 例如：

其实 keys 属性不仅仅支持 对象，也支持json 数组，比如：

3). 判断是否存在某个key.
在上面利用jq内置的 keys 属性，可以获取所有的key, 其实还有jq内置的has 方法，这个方法可以判断对应的key是否存在. 例子如下：

4). jq 的查找结果避免输出 错误，转而输出null
在查找条件的后面加上一个问号，那么如果找不到就不会输出任何的error, 相应的输出一个null来替代. 这个问号可以加在方法的后面(后面的例子中可以看到)。这在递归查找的时候非常有用;否则可能会出现报错的情形.
5). jq 的查找结果为空，避免输出null ,而是什么都不输出
目前不知道怎么实现，暂且用其他的linux 命令来过滤吧
6). 根据指定的关键字查找有该关键字的key，也就是模糊查找
jq 支持PCRE 正则表达式，所以支持模糊搜索， 这里主要展示用scan 方法输出模糊搜索的结果. 用法实例如下：

7). 根据指定的key, 查找嵌套对象中所有该key的value,输出该value
使用 .. 或者 recurse 来表示递归查找，然后通过管道进行常规的查找就可以了，举例如下：

8). 如何将匹配key 的 key 和value 一起进行输出?

以上的命令表示递归方式，获取Key为name的所有key:value对，并以key:value的方式进行输出，但是空的字典对象如何排除呢？ 目前还没有发现好的解决方法

9). 因为keys 属性支持对象的同时，也支持数组，所以如何来剔除数组而只是要对象的keys呢？
有一个walk 方法可以实现，但是不常用，所以这里不做讨论.
10).嵌套的模糊查找，上面描述了用scan进行模糊查找，以及用recurse来进行嵌套，如何两者结合呢？
因为scan方法只能够作用于字符串，所以不可以简单的将recurse和scan 结合起来使用，这里需要通过keys来实现 嵌套的模糊查询. 举例如下：

11). 其他使用小tips：
在可以使用 .key1.key2 这种情况下，也可以使用 .key1|.key2 的格式，个人更倾向于使用 .key1|.key2 ，因为看起来更清晰明了. 比如下面的例子.

在大多数情况下我们看到的json 复合格式最外层都是数组的形式，而不是对象的形式，这个是因为什么原因呢？ 因为json的对象必须是 key:value 的格式，虽然value 也可以是一个复合格式，但是一定需要key:value 形式，而 数组的不同元素的类型之间没有任何的关联，同一个数组，既可以包含有字符串元素，也可以包含对象元素，还可以包含数字... ，因此一个复合类型的 json格式一般最外层都是数组的形式.

首先用模糊查询,配合递归查找相应的key；-----简言之，就是找到key
然后用特定的key, 配合递归查询找到所有的结果；------简言之，就是依据key遍历到所有的值
最后对上述的结果做进一步的处理得到需要的结果. -----简言之，对得到的值做进一步的过滤获得真正需要的结果
简单例子如下下：

简单总结：

jq 以 JSON 格式输出结果

【中文标题】jq 以 JSON 格式输出结果

【英文标题】：jq to output results as JSON

【发布时间】：2018-08-26 18:47:46

【问题描述】：

jq 应该是

处理/过滤 JSON 输入并生成过滤器的结果作为 JSON

但是，我发现在jq 处理/过滤之后，输出结果不再是JSON 格式。

例如，https://stedolan.github.io/jq/tutorial/#result5，即，

$ curl -s 'https://api.github.com/repos/stedolan/jq/commits?per_page=5' | jq '.[] | message: .commit.message, name: .commit.committer.name'

  "message": "Merge pull request #162 from stedolan/utf8-fixes\n\nUtf8 fixes. Closes #161",
  "name": "Stephen Dolan"


  "message": "Reject all overlong UTF8 sequences.",
  "name": "Stephen Dolan"

. . . 

有什么解决方法吗？

更新：

如何将整个return包装成一个json结构：

 "Commits": [ ..., ..., ... ] 

我试过了：

jq '.[] | Commits: [message: .commit.message, name: .commit.committer.name]'
jq 'Commits: [.[] | message: .commit.message, name: .commit.committer.name]'

但两者都不起作用。

【问题讨论】：

这个 Q/A 帮助我找到了 better Github search approach，仅供参考。

【参考方案1】：

在同一页面上找到它，

https://stedolan.github.io/jq/tutorial/#result6

如果您想将输出作为单个数组获取，您可以告诉 jq 通过将过滤器包裹在方括号中来“收集”所有答案：

jq '[.[] | message: .commit.message, name: .commit.committer.name]'

【参考方案2】：

从技术上讲，除非另有说明（特别是使用 -r 命令行选项），否则 jq 会生成 JSON 实体的流。

将 JSON 实体的输入流转换为包含它们的 JSON 数组的一种方法是使用 -s 命令行选项。

对更新的响应

要产生一个 JSON 对象的形式：

 "Commits": [ ..., ..., ... ] 

你可以这样写：

jq 'Commits: [.[] | message: .commit.message, name: .commit.committer.name]'

（jq 理解 'Commits: _' 的简写。）