JsonPath 教程

JsonPath 教程

JsonPath 的介绍

JsonPath 是一种简单的方法来提取给定 JSON 文档的部分内容。 JsonPath 有许多编程语言,如 Javascript、Python、PHP 和 Java。

JsonPath 提供的 json 解析能力非常强大,它提供了类似正则表达式的语法,基本上可以满足所有你想要获得的 json 内容。

github 上有 JsonPath 的应用:JsonPath

JsonPath 可以在 Central Maven 仓库中找到,可以看到最新版本已经到了2.4.0。

在这里插入图片描述

JsonPath 的使用

类似于 XPath 在 xml 文档中的定位,JsonPath 表达式通常是用路径检索或设置 Json 的。

JsonPath 中的 “根成员对象” 始终称为$,无论是对象还是数组。

JsonPath表达式可以使用点表示法

$.store.book[0].title

或括号表示法

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

JsonPath 操作符

符号 描述
$ 查询的根节点对象,用于表示一个json数据,可以是数组或对象
@ 过滤器断言(filter predicate)处理的当前节点对象,类似于java中的this字段
* 通配符,必要时可用任何地方的名称或数字
可以理解为递归搜索,必要时在任何地方可以使用名称
. 表示一个子节点
[‘’ (, ‘’)] 表示一个或多个子节点
[ (, )] 表示一个或多个数组下标
[start:end] 数组片段,区间为[start,end),不包含end
[?()] 过滤器表达式,表达式结果必须是boolean

JsonPath 函数

函数可以在路径的尾部调用,函数的输出是路径表达式的输出,该函数的输出是由函数本身所决定的。

名称 描述 输出
min() 获取数值类型数组的最小值 Double
max() 获取数值类型数组的最大值 Double
avg() 获取数值类型数组的平均值 Double
stddev() 获取数值类型数组的标准差 Double
length() 获取数值类型数组的长度 Integer

JsonPath 过滤器运算符

过滤器是用于筛选数组的逻辑表达式。一个典型的过滤器将是[?(@.age > 18)],其中@表示正在处理的当前项目。 可以使用逻辑运算符&&和||创建更复杂的过滤器。 字符串文字必须用单引号或双引号括起来([?(@.color == ‘blue’)] 或者 [?(@.color == “blue”)]).

操作符 描述
== left等于right(注意1不等于’1’)
!= 不等于
< 小于
<= 小于等于
> 大于
>= 大于等于
=~ 匹配正则表达式[?(@.name =~ /foo.*?/i)]
in 左边存在于右边 [?(@.size in [‘S’, ‘M’])]
nin 左边不存在于右边
size (数组或字符串)长度
empty (数组或字符串)为空

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
        }
    },
    "expensive": 10
}
JsonPath表达式 结果
$.store.book[*].author 或 $…author [ “Nigel Rees”, “Evelyn Waugh”, “Herman Melville”, “J. R. R. Tolkien” ]
$.store.* 显示所有叶子节点值 [ [ { ”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 } ], { ”color” : “red”, ”price” : 19.95 } ]
$.store…price [ 8.95, 12.99, 8.99, 22.99, 19.95 ]
$…book[0,1] 或 $…book[:2] [ { ”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 } ]
$…book[-2:] 获取最后两本书
$…book[2:] [ { ”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 } ]
$…book[?(@.isbn)] 所有具有isbn属性的书
$.store.book[?(@.price < 10)] 所有价格小于10的书
$…book[?(@.price <= $[‘expensive’])] 所有价格低于expensive字段的书
$…book[?(@.author =~ /.*REES/i)] 所有符合正则表达式的书 [ { ”category” : “reference”, ”author” : “Nigel Rees”, ”title” : “Sayings of the Century”, ”price” : 8.95 } ]
$…* 返回所有
$…book.length() [ 4 ]

测试请点击**测试地址**

JsonPath 常见方法

使用 JsonPath 的最简单的最直接的方法是通过静态读取API。

在这里插入图片描述

如果你只想读取一次,那么上面的代码就可以了

如果你还想读取其他路径,现在上面不是很好的方法,因为他每次获取都需要再解析整个文档。所以,我们可以先解析整个文档,再选择调用路径。

在这里插入图片描述

JsonPath还提供流畅的API。

在这里插入图片描述

JsonPath 调整配置

DEFAULT_PATH_LEAF_TO_NULL

当检索不到时返回null对象,否则如果不配置这个,会直接抛出异常PathNotFoundException

在这里插入图片描述

ALWAYS_RETURN_LIST

如果可以获取到结果则总是返回list,即便是一个确定的非list类型,也会被包装成list;

如果获取不到结果则会报PathNotFoundException异常。

在这里插入图片描述

SUPPRESS_EXCEPTIONS

不抛出异常,需要判断如下:

  • ALWAYS_RETURN_LIST开启,则返回空list

在这里插入图片描述

  • ALWAYS_RETURN_LIST关闭,则返回null

在这里插入图片描述

AS_PATH_LIST

返回path

REQUIRE_PROPERTIES

如果设置,则不允许使用通配符,比如$[*].b,会抛出PathNotFoundException异常。

参考文献:
使用 JSONPath 解析 JSON 完整内容详解

猜你喜欢

转载自blog.csdn.net/ToBeMaybe_/article/details/109495151