Python中使用JsonPath

Python中使用JsonPath

JsonPath是解析Json字符串用的，类似于Xpath，使用JsonPath可以根据语法提取Json串中的关键信息和相关键值，无论嵌套了多少层，都能提取出来，省去了先反序列化成对象再取值的麻烦，堪称一项伟大的发明。

1. JsonPath语法

1.1 常用语法

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

1.2 与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’

2. 官方使用实例

下面是示范用的Json字符串，使用的官方文档中的例子，https://goessner.net/articles/JsonPath/

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

使用JsonPath解析实例

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的节点
//*	$…*	递归匹配所有子节点

3. python使用实例

在python使用及其简单，只需要用pip安装一下：pip install jsonpath，之后导入这个包：import jsonpath，就可以使用了。这里引用一位大哥写的例子来说明：

d={
	"error_code": 0,
		"stu_info": [
				{
						"id": 2059,
						"name": "小白",
						"sex": "男",
						"age": 28,
						"addr": "河南省济源市北海大道32号",
						"grade": "天蝎座",
						"phone": "18378309272",
						"gold": 10896,
						"info":{
							"card":434345432,
							"bank_name":'中国银行'
						}

				},
				{
						"id": 2067,
						"name": "小黑",
						"sex": "男",
						"age": 28,
						"addr": "河南省济源市北海大道32号",
						"grade": "天蝎座",
						"phone": "12345678915",
						"gold": 100
				}
		]
}
#取某个学生姓名的原始方法:通过查找字典中的key以及list方法中的下标索引
res= d["stu_info"][1]['name'] print(res) #输出结果是：小黑

import jsonpath

#嵌套n层也能取到所有学生姓名信息,$表示最外层的{}，..表示模糊匹配
res1=jsonpath.jsonpath(d,'$..name') 
print(res1) #输出结果是list：['小白', '小黑']

res2= jsonpath.jsonpath(d,'$..bank_name')
print(res2) #输出结果是list：['中国银行']

res3=jsonpath.jsonpath(d,'$..name123') #当传入不存在的key(name)时,返回False
print(res3) #输出结果是：False

4. 官方文档

https://goessner.net/articles/JsonPath/

5. Newtonsoft.Json参考

此外.net中的Newtonsoft.Json也支持Jsonpath，详见官方文档：https://www.newtonsoft.com/json/help/html/SelectToken.htm