JSON Path 介绍

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

概览

  1. 根对象使用$来表示,而无需区分是对象还是数组。

  2. 表达式可以使用.,也可以使用[]。如:

    $.store.book[0].title$['store']['book'][0]['title']

  3. 表达式(<expr>)可用作显式名称或索引的替代,如:

    $.store.book[(@.length-1)].title 表示获取最后一个 book 的 title。

  4. 使用符号@表示当前对象。过滤器表达式通过语法支持,?(<boolean expr>)如:

    $.store.book[?(@.price < 10)].title 表示获取价格小于 10 的所有 book 的 title。

语法

要点:

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

JSONPath 语法和 XPath 对比:

XPathJsonPath说明
/$文档根元素
.@当前元素
/.[]匹配下级元素
..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 Path 介绍 - 图1,JSON文档如下:

  1. {
  2. "store": {
  3. "book": [{
  4. "category": "reference",
  5. "author": "Nigel Rees",
  6. "title": "Sayings of the Century",
  7. "price": 8.95
  8. }, {
  9. "category": "fiction",
  10. "author": "Evelyn Waugh",
  11. "title": "Sword of Honour",
  12. "price": 12.99
  13. }, {
  14. "category": "fiction",
  15. "author": "Herman Melville",
  16. "title": "Moby Dick",
  17. "isbn": "0-553-21311-3",
  18. "price": 8.99
  19. }, {
  20. "category": "fiction",
  21. "author": "J. R. R. Tolkien",
  22. "title": "The Lord of the Rings",
  23. "isbn": "0-395-19395-8",
  24. "price": 22.99
  25. }
  26. ],
  27. "bicycle": {
  28. "color": "red",
  29. "price": 19.95
  30. }
  31. }
  32. }

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

XPathJsonPathResult
/store/book/author$.store.book[].author所有book的author节点
//author$..author所有author节点
/store/$.store.store下的所有节点,book数组和bicycle节点
/store//price$.store..pricestore下的所有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/JSON Path 介绍 - 图2 站点进行验证JsonPath的执行效果。

参考文档: