JSON Path 介绍

JSONPath 至于 JSON,就如 XPath 之于 XML。JSONPath 可以方便对 JSON 数据结构进行内容提取。

一、概览

  1. 根对象使用$来表示,而无需区分是对象还是数组。
  2. 表达式可以使用.,也可以使用[]。如:
  3. $.store.book[0].title$['store']['book'][0]['title']
  4. 表达式()可用作显式名称或索引的替代,如:
  5. $.store.book[(@.length-1)].title 表示获取最后一个 book 的 title。
  6. 使用符号@表示当前对象。过滤器表达式通过语法支持,?()如:
  7. $.store.book[?(@.price < 10)].title 表示获取价格小于 10 的所有 book 的 title。

二、语法

要点:

  • $ 表示文档的根元素
  • @ 表示文档的当前元素
  • .node_name['node_name'] 匹配下级节点
  • [index] 检索数组中的元素
  • [start:end:step] 支持数组切片语法
  • * 作为通配符,匹配所有成员
  • .. 子递归通配符,匹配成员的所有子元素
  • () 使用表达式
  • ?()进行数据筛选

JSONPath 语法和 XPath 对比:

XPath

JsonPath

说明

/

$

文档根元素

.

@

当前元素

/

.[]

匹配下级元素

..

N/A

匹配上级元素,JsonPath不支持此操作符

//

..

递归匹配所有的元素

*

*

通配符,匹配下级元素

@

N/A

匹配属性,JsonPath不支持此操作符

[]

[]

下标运算符,根据索引获取元素,XPath索引从1开始,JsonPath索引从0开始

|

[,]

连接操作符,将多个结果拼接成数组返回,可以使用索引或别名

N/A

[start:end:step]

数据切片操作,XPath不支持

[]

?()

过滤表达式

N/A

()

脚本表达式,使用底层脚本引擎,XPath不支持

()

N/A

分组,JsonPath不支持

注意:

  • JsonPath 的索引从0开始计数
  • JsonPath 中字符串使用单引号表示,例如:$.store.book[?(@.category=='reference')]中的'reference'

三、JsonPath示例

下面是相应的JsonPath的示例,代码来源于
https://goessner.net/articles/JsonPath/,JSON文档如下:

{
    "store": {
        "book": [{
                "category": "reference",
                "author": "Nigel Rees",
                "title": "Sayings of the Century",
                "price": 8.95
            }, {
                "category": "fiction",
                "author": "Evelyn Waugh",
                "title": "Sword of Honour",
                "price": 12.99
            }, {
                "category": "fiction",
                "author": "Herman Melville",
                "title": "Moby Dick",
                "isbn": "0-553-21311-3",
                "price": 8.99
            }, {
                "category": "fiction",
                "author": "J. R. R. Tolkien",
                "title": "The Lord of the Rings",
                "isbn": "0-395-19395-8",
                "price": 22.99
            }
        ],
        "bicycle": {
            "color": "red",
            "price": 19.95
        }
    }
}

接下来我们看一下如何对这个文档进行解析:

XPath

JsonPath

Result

/store/book/author

$.store.book[*].author

所有book的author节点

//author

$..author

所有author节点

/store/*

$.store.*

store下的所有节点,book数组和bicycle节点

/store//price

$.store..price

store下的所有price节点

//book[3]

$..book[2]

匹配第3个book节点

//book[last()]

$..book[(@.length-1)],或 $..book[-1:]

匹配倒数第1个book节点

//book[position()<3]

$..book[0,1],或 $..book[:2]

匹配前两个book节点

//book[isbn]

$..book[?(@.isbn)]

过滤含isbn字段的节点

//book[price<10]

$..book[?(@.price<10)]

过滤price<10的节点

//*

$..*

递归匹配所有子节点

你可以在 http://jsonpath.com/ 站点进行验证JsonPath的执行效果。

参考文档:

  • https://goessner.net/articles/JsonPath/
  • https://www.newtonsoft.com/json/help/html/SelectToken.htm