Jq语言

jq是领域特定高级的纯函数式编程语言，它采用词法作用域，其中所有JSON值都是常量。jq支持回溯并可管理JSON数据的无限长字串流。jq支持基于名字空间的模块系统，并对闭包有一定支持，尤其是它的函数和泛函表达式可以用作其他函数的参数。

## 历史

jq由Stephen Dolan创建并在2012年10月发行。它被设计为“针对JSON数据的sed类似者”。

jq最初与Icon和Haskell编程语言有关，它采用Haskell实现。随即移植至C语言。在jq版本1.5中增加支持了正则表达式。

用Go实现的gojq最初发行于2019年，gojq显著的扩展jq包括了支持YAML。

用Rust实现的jaq，它规定了指称语义，其项目目标是更快速和更准确的jq实现，仍保持与jq在大多数情况下的兼容性。在2024年3月于其目标中排除了jq的特定高级特征，比如模块、SQL风格算子和给非常大JSON文档的串流解析器。

fq是针对二进制文件的jq，最初发行于2021年。用jq实现的jqjq，最初发行于2022年。jqjq显著的可以运行自身，拥有REPL并支持`eval`。

针对jq的叫做yq的“包装器”，它首次发行于2017年，增加支持了YAML、XML和TOML。

## 用法

### 命令行用法

jq典型的用于命令行，并可以协作于其他命令行实用工具，比如curl。下面的例子展示如何将curl命令的输出通过管道接转到jq过滤器 (软件)，从而确定同这个Wikipedia页面关联的范畴名字：

```console
$ URL=$(echo 'jq语言' | jq -rR '@uri "https://zh.wikipedia.org/w/api.php?action=parse&page=\(.)&format=json"')
$ curl -s ${URL} | jq '.parse.categories[]."*"'
```

这里的流水线产生的输出，由JSON字符串的串流组成，它们是：

```console
"小寫標題"
"CS1英语来源_(en)"
"动态类型编程语言"
"函数式编程语言"
"面向文本编程语言"
"2012年建立的程式語言"
"数据查询语言"
"2012年软件"
```

上述curl命令对这个页面使用了MediaWiki API来产生JSON响应针对写作本条目之时目标网页的当前状况，上述效果也可以实现为：

bash

echo 'Jq语言' | jq -rR '@uri "https://zh.wikipedia.org/wiki/\(.)"' | xargs curl -s | sed -n 's/.*RLCONF=\(.*\);/\1/p' | jq '.wgCategories[]'

。管道（pipe）符号允许curl的输出由jq来访问，它是标准的Unix shell的进程间通信机制。

这里展示的jq过滤器的方法链是如下流水线（pipeline）的简写：

```bash
.["parse"] | .["categories"] | .[] | .["*"]
```

这对应于curl调用所产生的嵌套JSON结构。jq流水线的构造方式，同Unix风格流水线一样，采用管道符号。

### 嵌入式用法

C语言和Go实现二者都提供函数库，使得jq功能可以嵌入到其他应用和编程环境之中。

例如，gojq已经集成于SQLite，故而函数可以在其SQL语句中获得到。这些函数被标记为“确定性的”，故而可以被用在`CREATE INDEX`命令中。

## 运算的模态

jq缺省的充当针对JSON输入的“串流编辑器”，非常像被当作多行文本的“串流编辑器”的sed实用工具。但是jq有一些其他运算模态：

- 它可以将来自一个或多个来源的输入当作文本的诸行。
- 它可以将来自特定来源的输入的串流收集到一个JSON阵列之中。
- 它可以使用所谓的“串流解析器”解析其输入，产生针对所有“叶子”路径的`[PATH, VALUE]`阵列的串流。

“串流解析器”（streaming parser），在一个或多个JSON输入太大无法载入内存之时特别有用，因为它需求的内存典型的相当小。例如，对于任意大的JSON对象的阵列，峰值内存需求不比处理最大顶层对象所需要的多出很多。

这些运算模态可以在特定限制下组合起来。

## 语法和语义

### 类型

所有JSON值自身是jq中的值，它们从而有在下列表格中展示的类型。gojq和jaq实现将数区分为整数和浮点数。gojq实现支持无界精度整数算术，同于jq采用Haskell的最初实现。

类型｜过滤器｜例子

数｜`numbers`｜* * 3、3.2、1e6 * * infinite

字符串｜`strings`｜* * "Hello" *

布尔值｜`booleans`｜* * true、false

阵列｜`arrays`

对象｜`objects`

空值｜`nulls`｜* * null

null是通常表示空值的一个值，就像任何其他JSON标量一样；它不是空指针。（对应于NaN）和`<span style="color:green;font-weight: bold;">infinite</span>`（参见IEEE 754），是仅有的两个不是JSON值的jq标量。

### 形式

jq有特殊语法形式，比如：

- `EXP as $var | ……`：变量绑定。
- `PATH |= VALUE`和`PATH = VALUES`：更新赋值和平凡（plain）赋值。
- `<span style="color:green;font-weight: bold;">if</span> …… <span style="color:green;font-weight: bold;">then</span> …… <span style="color:green;font-weight: bold;">elif</span> …… <span style="color:green;font-weight: bold;">then</span> …… <span style="color:green;font-weight: bold;">else</span> …… <span style="color:green;font-weight: bold;">end</span>`：条件构造。
- `<span style="color:green;font-weight: bold;">reduce</span> EXP <span style="color:green;font-weight: bold;">as</span> $<span style="color:#B00040;">var</span> (INIT; UPDATE)`：串流归约。
- foreach EXP as $var (INIT; UPDATE; EXTRACT)：输出中间值的串流归约。
- def func : EXP;：函数创建。
- `<span style="color:green;font-weight: bold;">include</span> MOD;`和`<span style="color:green;font-weight: bold;">import</span> MOD <span style="color:green;font-weight: bold;">as</span> $<span style="color:#B00040;">name</span>;`：模块的包含和导入。

jq中有两种类型的符号，可称为“变量”的值绑定和函数。二者都是词法作用域的，表达式只能提及其左侧即前面最近的定义的符号，但是函数可以提及自身来创建递归函数。

### 过滤器

jq是面向JSON的编程语言，使用`|`符号来连接过滤器形成流水线。例如：

```console
$ echo '[1,2]' | jq 'add'
3
$ jq -n '[1,2] | add'
3
```

这里jq内的JSON阵列`[1,2]`是求值为阵列的一个jq过滤器。

尽管类似于Unix流水线，jq流水线允许将到来数据，如同并行的发送到在`|`右手端的多于一个接收者。例如，程序`add/length`将计算阵列中数的平均，故而：

```console
$ jq -n '[1,2] | add/length'
1.5
$ jq -nc '[1,2] | [length, add, add/length]'
[2,3,1.5]
```

单独的点号`.`可以充任占位符（placeholder）或通配符，例如：

```console
$ jq -nc '1 | [., .]'
[1,1]
$ jq -n '2 | pow(.; .)'
4
```

在jq中采用隐式编程风格，阶乘可以通过共递归运算`recurse()`定义为`[0,1] | recurse([first+1, last*(first+1)]) | last`，下面是其使用例子：

```console
$ echo '0 1 2 6' | jq -c '[limit(.+1; [0,1] | recurse([first+1, last*(first+1)]) | last)]'
[1]
[1,1]
[1,1,2]
[1,1,2,6,24,120,720]
$ jq -n 'first([0,1] | recurse([first+1, last*(first+1)]) | last)'
1
$ jq -n '[0,1,2,6][] | nth(.; [0,1] | recurse([first+1, last*(first+1)]) | last)'
1
1
2
720
$ jq -nc '[0,1,2,6] | map(nth(.; [0,1] | recurse([first+1, last*(first+1)]) | last))'
[1,1,2,720]
```

斐波那契数列可以通过共递归运算`recurse()`定义为`[0,1] | recurse([last, add]) | first`，下面是其使用例子：

```console
$ echo '0 1 2 6' | jq -c '[limit(.+1; [0,1] | recurse([last, add]) | first)]'
[0]
[0,1]
[0,1,1]
[0,1,1,2,3,5,8]
$ jq -n 'first([0,1] | recurse([last, add]) | first)'
0
$ jq -n '[0,1,2,6][] | nth(.; [0,1] | recurse([last, add]) | first)'
0
1
1
8
$ jq -nc '[0,1,2,6] | map(nth(.; [0,1] | recurse([last, add]) | first))'
[0,1,1,8]
```

这种无限列表不可以不加限定的使用，也不可以对其进行`last()`运算。下面将其定义为新的命名过滤器：

```python
def fac: nth(.; [0,1] | recurse([first+1, last*(first+1)]) | last);
def fib: nth(.; [0,1] | recurse([last, add]) | first);
```

共递归运算`recurse()`可以设置递推条件：

```console
$ jq -nc '[0 | recurse(.+1; . < 0)]'
[0]
$ jq -nc '[0 | recurse(select(. < 0) | .+1)]'
[0]
$ jq -nc '[0 | recurse(.+1; . <= 6)]'
[0,1,2,3,4,5,6]
$ jq -nc '[0 | recurse(select(. < 6) | .+1)]'
[0,1,2,3,4,5,6]
```

下面的例子展示如何定义参数化的命名过滤器，它格式化从2到36含二者的任何底数的整数：

```python
def tobase($b):
    def digit: "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ"[.:.+1];
    def mod: .%$b;
    def div: (.-mod)/$b;
    def place_values: recurse(select(. >= $b) | div) | mod;
    select(2 <= $b and $b <= 36)
    | [place_values | digit] | reverse | add;
```

这里的`tobase($b)`充当了库函数，所以为了应对使用者将`.`作为实际参数传递给它的潜在情况，而对其形式参数采用了变量形式。下面将它保存入`tobase.jq`文件，接着使用这个函数：

```console
$ echo '15 16' | jq 'include "./tobase"; tobase(16)'
"F"
"10"
```

下一个例子求解经典的覆面算数学游戏：

$$\begin{matrix} <pre> & & \text{S} & \text{E} & \text{N} &\text{D} \\ + & & \text{M} & \text{O} & \text{R} & \text{E} \\ \hline = & \text{M} & \text{O} & \text{N} & \text{E} & \text{Y} \\ </pre> \end{matrix}$$

从`M`是在最高位的进位可知：`M`为`1`，`S`为`8`或`9`，`O`为`0`，代码展示了基于`range()`和`.[]`的生成器：

```python
def send_more_money:
    def choose(m; n; k): . as $used
        | ([range(m; n+1)]-[$used[]])[] | $used+{(k):.};
    def num: reduce .[] as $i (0; 10*. + $i);
    {"m":1,"o":0}
    | choose(8; 9; "s") | choose(2; 9; "e")
    | choose(2; 9; "n") | choose(2; 9; "d")
    | choose(2; 9; "r") | choose(2; 9; "y") 
    | select(([.s,.e,.n,.d] | num) 
        +    ([.m,.o,.r,.e] | num)
        ==([.m,.o,.n,.e,.y] | num))
    | [.s,.e,.n,.d,"+",.m,.o,.r,.e,"=",.m,.o,.n,.e,.y];
send_more_money
```

将上述代码保存入`send_more_money.jq`文件，接着使用这个函数得到这个谜题仅有的一个解：

```console
$ jq -nc -f ./send_more_money.jq
[9,5,6,7,"+",1,0,8,5,"=",1,0,6,5,2]
```

## 解析表达式文法

在jq和解析表达式文法（PEG）形式化之间有密切关联。这种关联源于下列表格中展示的PEG七个基本运算与jq构造之间的等价性。

PEG运算名字｜PEG表示法｜jq运算或过滤器定义

序列有序选择零或多个一或多个可选

与断言｜def amp(E): . as $in `| E |` $in;

非断言

## 八皇后问题例子

回溯法求解八皇后问题，采用函数式编程风格的条件表达式和递归函数可以写为：

```python
def queens:
    def q(r): . as $pl
        | if r < 8 then
            $pl[3] as $cl | $cl[] | . as $c
            | (r+$c | tostring) as $k0
            | (r-$c | tostring) as $k1
            | def place:
                ($k0 | in($pl[1]) | not)
                and ($k1 | in($pl[2]) | not);
              select(place)
            | [$pl[0]+[$c], $pl[1]+{$k0:null},
                $pl[2]+{$k1:null}, $cl-[$c]]
            | q(r+1)
          else
            .[0] end;
    [[], {}, {}, [range(0; 8)]] | q(0)
    | map("abcdefgh"[.:.+1]) | to_entries
    | map(.value+(.key+1 | tostring)) | sort;
queens
```

将这段代码保存入`queens.jq`文件中，下面演示其执行结果并提取其`92`个解中的前两个解：

```console
$ jq -nc -f ./queens.jq | wc -l
92
$ jq -nc -f ./queens.jq | sed -n '1,2p'
["a1","b7","c5","d8","e2","f4","g6","h3"]
["a1","b7","c4","d6","e8","f2","g5","h3"]
```

在能采用可逆（reversible）赋值和静态变量的语言比如Icon的实现中，其3个位置列表共有`8+15+15 = 38`个元素，而这个存储传递风格实现对3个位置列表进行了Zip (计算机科学)变换，共有`3*8*(1+8)/2 = 108`个元素。

进一步采用隐式编程风格，上述代码可以写为：

```python
def queens:
   def q(r): . as $pl 
        | $pl[3] as $cl | $cl[] | . as $c
        | (r+$c | tostring) as $k0
        | (r-$c | tostring) as $k1
        | def place: 
            ($k0 | in($pl[1]) | not)
            and ($k1 | in($pl[2]) | not); 
          select(place)
        | [$pl[0]+[$c], $pl[1]+{$k0:null},
            $pl[2]+{$k1:null}, $cl-[$c]];
    def pipeline(i; n): 
        q(i) | if i+1 < n then pipeline(i+1; n) end;
    [[], {}, {}, [range(0; 8)]] | pipeline(0; 8) | .[0]
    | map("abcdefgh"[.:.+1]) | to_entries
    | map(.value+(.key+1 | tostring)) | sort;
queens
```

它还可以采用共递归运算`recurse()`写为：

```python
def queens:
    def q: . as $pl 
        | $pl[4] as $r 
        | $pl[3] as $cl | $cl[] | . as $c
        | ($r+$c | tostring) as $k0
        | ($r-$c | tostring) as $k1
        | def place: 
            ($k0 | in($pl[1]) | not)
            and ($k1 | in($pl[2]) | not); 
          select(place)
        | [$pl[0]+[$c], $pl[1]+{$k0:null}, 
            $pl[2]+{$k1:null}, $cl-[$c], $r+1];
    [[], {}, {}, [range(0; 8)], 0] | recurse(q) 
    | select(.[4] == 8) | .[0]
    | map("abcdefgh"[.:.+1]) | to_entries
    | map(.value+(.key+1 | tostring)) | sort;
queens
```

最后，通过旋转和反射将可行解归并为独立解：

```python
def queens(n):
    def q: . as $pl 
        | $pl[4] as $r 
        | $pl[3] as $cl | $cl[] | . as $c
        | ($r+$c | tostring) as $k0
        | ($r-$c | tostring) as $k1
        | def place: 
            ($k0 | in($pl[1]) | not)
            and ($k1 | in($pl[2]) | not); 
          select(place)
        | [$pl[0]+[$c], $pl[1]+{$k0:null},
            $pl[2]+{$k1:null}, $cl-[$c], $r+1];
    def pipeline(n): 
        q | if n > 1 then pipeline(n-1) end;
    def toletter: 
        "abcdefghijklmnopqrstuvwxyz"[.:.+1];
    def fund_solut(f):
        def inverse: . as $xl
            | reduce range(0; n) as $i
                ([]; .+[$xl | index($i)]);
        def variants:
            [., inverse] | map(., reverse)
            | map(., map(n-1-.)) 
            | map(map(toletter) | add);
        foreach f as $i 
            ([null, {}]; .[1] as $ml
            | ($i | variants) as $nl
            | if all($nl[]; in($ml) | not) then
                [$i, ($ml | .[$nl[]]=null)]
              else
                [null, $ml] end;
            .[0])
        | select (. != null);
    fund_solut([[], {}, {}, [range(0; n)], 0]
        | pipeline(n) | .[0]) 
    | map(toletter) | to_entries
    | map(.value+(.key+1 | tostring)) | sort;
queens(8)
```

下面演示其执行结果：

```console
$ jq -nc -f ./queens.jq | wc -l
12
$ jq -nc -f ./queens.jq 
["a1","b7","c5","d8","e2","f4","g6","h3"]
["a1","b7","c4","d6","e8","f2","g5","h3"]
["a6","b1","c5","d2","e8","f3","g7","h4"]
["a4","b1","c5","d8","e2","f7","g3","h6"]
["a5","b1","c8","d4","e2","f7","g3","h6"]
["a3","b1","c7","d5","e8","f2","g4","h6"]
["a5","b1","c4","d6","e8","f2","g7","h3"]
["a7","b1","c3","d8","e6","f4","g2","h5"]
["a5","b1","c8","d6","e3","f7","g2","h4"]
["a5","b3","c1","d7","e2","f8","g6","h4"]
["a5","b7","c1","d4","e2","f8","g6","h3"]
["a6","b3","c1","d8","e4","f2","g7","h5"]
```

## 外部链接

- jq homepage
- gojq - the Pure Go implementation
- jaq - the Rust implementation
- jqjq - the jq implementation
- jq FAQ
- Awesome jq - curated listing of jq-related resources
- The jq Programming Language page on the Rosetta Code comparative programming tasks project site

## 基本资料

- 日语原文：jq
- 域：jq官方图标
- 编程范型：纯函数式，面向JSON，隐式，管道
- 发行时间：2012年8月21日
- 设计者：Stephen Dolan
- 实作语言：jq：C，gojq：Go，jaq：Rust，jqjq：jq
- 平台：跨平台
- 类型系统：动态
- 作用域：词法
- 操作系统：跨平台
- 许可证：MIT
- 受影响于：Haskell，Icon，JSON，Unix shell，sed