jq

概述

参考：
官方文档

jq 是轻量级且灵活的处理 JSON 数据的 Shell 命令行工具

这里是官方提供的 jq 命令在线测试工具，提供原始 JSON 内容，会自动根据表达式输出结果。

jq 用法详解

官方文档：https://stedolan.github.io/jq/manual/

jq 程序是一个过滤器，接收一个输入，并产生一个输出。

基础过滤

官方文档：https://stedolan.github.io/jq/manual/#Basicfilters

下面的 jq 用法，都是用下面这个 json 文件作为演示

{"favorite":{"drink":"water","food":"sushi","game":"WOW & PAL"},"sushiKinds":["sashimi",{"name":"hot"},{"name":"handRoll","rice":"more"},{"name":null}],"arrayBrowser":[{"name":"360","url":"http://www.so.com"},{"name":"bing","url":"http://www.bing.com"}]}

格式化后的内容如下，格式化内容仅作参考对照，因为 jq 命令本身就可以实现格式化的 json 的作用。

{
  "favorite": {
    "drink": "water",
    "food": "sushi",
    "game": "WOW & PAL"
  },
  "sushiKinds": [
    "sashimi",
    {
      "name": "hot"
    },
    {
      "name": "handRoll",
      "rice": "more"
    },
    {
      "name": null
    }
  ],
  "arrayBrowser": [
    {
      "name": "360",
      "url": "http://www.so.com"
    },
    {
      "name": "bing",
      "url": "http://www.bing.com"
    }
  ]
}

`.` 符号

点.符号与 go 模板中的点作用一样，表示当前作用域的对象。对于 jq 来说，所有给 jq 输入的内容，都是当前作用域的对象。比如

~]# cat demo.json
{"favorite":{"drink":"water","food":"sushi","game":"WOW & PAL"},"sushiKinds":["sashimi",{"name":"hot"},{"name":"handRoll","rice":"more"},{"name":null}],"arrayBrowser":[{"name":"360","url":"http://www.so.com"},{"name":"bing","url":"http://www.bing.com"}]}
~]# cat demo.json | jq .
{
  "favorite": {
    "drink": "water",
    "food": "sushi",
    "game": "WOW & PAL"
  },
  "sushiKinds": [
    "sashimi",
    {
      "name": "hot"
    },
    {
      "name": "handRoll",
      "rice": "more"
    },
    {
      "name": null
    }
  ],
  "arrayBrowser": [
    {
      "name": "360",
      "url": "http://www.so.com"
    },
    {
      "name": "bing",
      "url": "http://www.bing.com"
    }
  ]
}

获取 map 的值

给定 map 的名称，获取其值。.foo.bar与.foo|.bar作用相同。如果 map 名称中包含特殊字符或以数字开头，则需要适用双引号将其括起来，例如

~]# cat demo.json | jq '.favorite.food'
"sushi"

获取 array 的值

~]# cat demo.json | jq .arrayBrowser
[
  {
    "name": "360",
    "url": "http://www.so.com"
  },
  {
    "name": "bing",
    "url": "http://www.bing.com"
  }
]
~]# cat demo.json | jq .arrayBrowser[]
{
  "name": "360",
  "url": "http://www.so.com"
}
{
  "name": "bing",
  "url": "http://www.bing.com"
}
~]# cat demo.json | jq .arrayBrowser[].name
"360"
"bing"
~]# cat demo.json | jq .arrayBrowser[1]
{
  "name": "bing",
  "url": "http://www.bing.com"
}

最佳实践

修改文件内容

$ jq '.foo.bar' file.json

这会定位JSON文件中名为“foo”的对象的“bar”字段。

$ jq '.foo.bar = "new value"' file.json

这会将名为“foo”的对象中的“bar”字段的值替换为“new value”。

$ jq '.foo.bar = "new value"' > /tmp/jq_result.json && /usr/bin/cp /tmp/js_result.json file.json

这将在原始JSON文件中直接替换“foo”对象的“bar”字段的值为“new value”。

使用 –arg 选项修改文件内容

主要是适用于修改的内容来自于变量的场景

不用 –arg 的示例

~]# jq ".favorite.drink = "${DRINK}"" test/test.json
jq: error: water_var/0 is not defined at <top-level>, line 1:
.favorite.drink = water_var                  
jq: 1 compile error

这样报错了，需要给 " 添加 \

jq ".favorite.drink = \"${DRINK}\"" test/test.json

使用 –arg 的效果

jq --arg drink "${DRINK}" '.favorite.drink = $drink' test/test.json

通过 –arg 使用了外部变量 DRINK

反馈

此页是否对你有帮助？

Glad to hear it! Please tell us how we can improve.

Sorry to hear that. Please tell us how we can improve.

最后修改 May 13, 2024: tailscale, jq, clearup (4e49da16)

jq

概述