JSON Path 语法介绍和使用场景

Posted 2022-07-14 小雨青年

文章目录

• • 一、什么是JSON Path
  • 二、语法介绍
  • 三、哪里可以用的到呢？
  • • 1. Java
    • 2. PHP
    • 3. JavaScript
    • 4. Python
    • 5. Go
  • 四、总结

一、什么是JSON Path

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

下面是一个JSON Path语法的举例：

$.store.book[0].title

二、语法介绍

JsonPath	说明
$	文档根元素
@	当前元素
.或[]	匹配下级元素
N/A	匹配上级元素，JsonPath不支持此操作符
..	递归匹配所有子元素
*	通配符，匹配下级元素
N/A	匹配属性，JsonPath不支持此操作符
[]	下标运算符，根据索引获取元素，XPath索引从1开始，JsonPath索引从0开始
[,]	连接操作符，将多个结果拼接成数组返回，可以使用索引或别名
[start:end:step]	数据切片操作，XPath不支持
?()	过滤表达式
()	脚本表达式，使用底层脚本引擎，XPath不支持
N/A	分组，JsonPath不支持

这是一个非常经典的案例，你几乎可以在任何介绍JSON Path的地方看到它，但是很实用。

 "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
    
  

配合示例，对应上面表格的语法，下面的举例更好理解。

JsonPath	Result
$.store.book[*].author	所有book的author节点
$..author	所有author节点
$.store.*	store下的所有节点，book数组和bicycle节点
$.store..price	store下的所有price节点
$..book[2]	匹配第3个book节点
$..book[(@.length-1)]，或 $..book[-1:]	匹配倒数第1个book节点
$..book[0,1]，或 $..book[:2]	匹配前两个book节点
$..book[?(@.isbn)]	过滤含isbn字段的节点
$..book[?(@.price<10)]	过滤price<10的节点
$..*	递归匹配所有子节点

这个地址可以在线运行 http://jsonpath.com/

三、哪里可以用的到呢？

光有语法可操作意义不大，那么哪里可以用到JSON Path呢？

1. Java

Jayway JsonPath ，用于读取 JSON 文档的 Java DSL。

项目地址： https://github.com/json-path/JsonPath

2. php

JsonPath，JsonPath的PHP实现。

项目地址： https://github.com/Galbar/JsonPath-PHP

3. javascript

jsonpath， 使用 JSONPath 表达式查询 JavaScript 对象。 用于 Node.js 的强大/安全的 JSONPath 引擎。

项目地址： https://github.com/dchester/jsonpath

4. Python

jsonpath-ng，旨在符合标准的 Python JSONPath 的最终实现，包括算术和二进制比较运算符，并为元编程提供清晰的 AST。

项目地址：https://pypi.org/project/jsonpath-ng/

5. Go

Jsonpath，JsonPath的PHP实现。

项目地址：https://github.com/yalp/jsonpath

四、总结

JSON Path 作为一个语法标准，实现了对JSON的便捷读取。另外，各种语言的JSON Path实现的项目名称都差不多。