JsonPath使用(转载)
目录
警告
本文最后更新于 2023-03-09，文中内容可能已过时，请谨慎使用。
JsonPath
JsonPath官方仓库: https://github.com/json-path/JsonPath
JsonPath表达式总是以与XPath表达式结合使用XML文档相同的方式引用JSON结构。
JsonPath中的根成员对象始终称为$，无论是对象还是数组。
JsonPath表达式可以使用点表示法
$.store.book[0].title
或括号表示法
$['store']['book'][0]['title']
操作符
| 操作符 | 描述 |
|---|---|
$ |
查询表达式的根元素 |
@ |
过滤谓词正在处理的当前节点 |
* |
通配符，可替换任何name和number出现的位置 |
.. |
深层查询，可替换任何name出现的位置 |
.<name> |
查找为name的子节点 |
['<name>' (, '<name>')] |
查询子节点，比如$['store']['bicycle']['color'] |
[<number> (, <number>)] |
括号中可添加多个索引，比如[0,1,2] |
[start:end] |
数组切片 |
[?(<expression>)] |
表达式为真时返回对应结果 |
函数
| 函数 | 描述 | 输出 |
|---|---|---|
min() |
提供数字数组的最小值 | Double |
max() |
提供数字数组的最大值 | Double |
avg() |
提供数字数组的平均值 | Double |
stddev() |
提供数字数组的标准偏差值 | Double |
length() |
提供数组的长度 | Integer |
过滤器运算符(Filter Operators)
| 操作符 | 描述 |
|---|---|
== |
left等于right（注意1不等于'1’） |
!= |
不等于 |
< |
小于 |
<= |
小于等于 |
> |
大于 |
>= |
大于等于 |
=~ |
匹配正则表达式[?(@.name =~ /foo.*?/i)] |
in |
左边存在于右边 [?(@.size in ['S', 'M'])] |
nin |
左边不存在于右边 |
size |
(数组或字符串)长度 |
empty |
(数组或字符串)为空 |
样例中的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
}
快速使用
导入依赖
<dependency>
<groupId>com.jayway.jsonpath</groupId>
<artifactId>json-path</artifactId>
<version>2.7.0</version>
</dependency>
使用JsonPath的最简单的最直接的方法是通过静态读取API。
String json = "...";
List<String> authors = JsonPath.read(json, "$.store.book[*].author");
如果你只想读取一次，那么上面的代码就可以了
如果你还想读取其他路径，现在上面不是很好的方法，因为他每次获取都需要再解析整个文档。所以，我们可以先解析整个文档，再选择调用路径。
String json = "...";
Object document = Configuration.defaultConfiguration().jsonProvider().parse(json);
String author0 = JsonPath.read(document, "$.store.book[0].author");
String author1 = JsonPath.read(document, "$.store.book[1].author");
javaPath还提供了一种fluent API，这也是最灵活的一种写法
String json = "...";
ReadContext ctx = JsonPath.parse(json);
List<String> authorsOfBooksWithISBN = ctx.read("$.store.book[?(@.isbn)].author");
List<Map<String, Object>> expensiveBooks = JsonPath
.using(configuration)
.parse(json)
.read("$.store.book[?(@.price > 10)]", List.class);
返回值
当在java中使用JsonPath时，重要的是要知道你在结果中期望什么类型。 JsonPath将自动尝试将结果转换为调用者预期的类型。
// 抛出 java.lang.ClassCastException 异常
List<String> list = JsonPath.parse(json).read("$.store.book[0].author")
// 正常
String author = JsonPath.parse(json).read("$.store.book[0].author")
当评估路径时，你需要理解路径确定的概念。路径是不确定的，它包含
..：深层扫描操作?(<expression>)：表达式[<number>, <number> (, <number>)]：多个数组索引
不确定的路径总是返回一个列表（由当前的JsonProvider表示）
一些样例
| JsonPath | 结果 |
|---|---|
$.store.book[*].author |
获取json中store下book下的所有author值 |
$..author |
获取所有json中所有author的值 |
$.store.* |
所有的东西，书籍和自行车 |
$.store..price |
获取json中store下所有price的值 |
$..book[2] |
获取json中book数组的第3个值 |
$..book[-2] |
倒数的第二本书 |
$..book[0,1] |
前两本书 |
$..book[0:2] |
从索引0（包括）到索引2（排除）的所有图书 |
$..book[1:2] |
从索引1（包括）到索引2（排除）的所有图书 |
$..book[:2] |
获取json中book数组的最后两个值 |
$..book[2:] |
获取json中book数组的第3个到最后一个的区间值 |
$..book[?(@.isbn)] |
结果获取json中book数组中包含isbn的所有值 |
$.store.book[?(@.price<=10)] |
获取json中book数组中price<=10的所有值 |
$.store.book[?(@.price<=$.expensive)] |
获取json中book数组中price<=expensive的所有值 |
$..book[?(@.author =~ /.*REES/i)] |
获取json中book数组中的作者以REES结尾的所有值（REES不区分大小写） |
$..* |
逐层列出json中的所有值，层级由外到内 |
$..book.length() |
获取json中book数组的长度 |
样例代码
示例1:
public class JsonPathStudy {
public static void main(String[] args) {
String myJson = readJson();
print("----------------------------getJsonValue------------------------------");
getJsonValue(myJson);
}
private static String readJson() {
StringBuilder sb = new StringBuilder();
try {
FileReader fr = new FileReader("src/main/resources/static/data.json");
BufferedReader bfd = new BufferedReader(fr);
String s = "";
while((s=bfd.readLine())!=null) {
sb.append(s);
}
} catch (Exception e) {
e.printStackTrace();
}
System.out.println(sb);
return sb.toString();
}
private static void getJsonValue(String json) {
//The authors of all books：获取json中store下book下的所有author值
List<String> authors1 = JsonPath.read(json, "$.store.book[*].author");
//All authors：获取所有json中所有author的值
List<String> authors2 = JsonPath.read(json, "$..author");
//All things, both books and bicycles
//authors3返回的是net.minidev.json.JSONArray：获取json中store下的所有value值，不包含key，如key有两个，book和bicycle
List<Object> authors3 = JsonPath.read(json, "$.store.*");
//The price of everything：获取json中store下所有price的值
List<Object> authors4 = JsonPath.read(json, "$.store..price");
//The third book：获取json中book数组的第3个值
List<Object> authors5 = JsonPath.read(json, "$..book[2]");
//The first two books：获取json中book数组的第1和第2两个个值
List<Object> authors6 = JsonPath.read(json, "$..book[0,1]");
//All books from index 0 (inclusive) until index 2 (exclusive)：获取json中book数组的前两个区间值
List<Object> authors7 = JsonPath.read(json, "$..book[:2]");
//All books from index 1 (inclusive) until index 2 (exclusive)：获取json中book数组的第2个值
List<Object> authors8 = JsonPath.read(json, "$..book[1:2]");
//Last two books：获取json中book数组的最后两个值
List<Object> authors9 = JsonPath.read(json, "$..book[-2:]");
//Book number two from tail：获取json中book数组的第3个到最后一个的区间值
List<Object> authors10 = JsonPath.read(json, "$..book[2:]");
//All books with an ISBN number：获取json中book数组中包含isbn的所有值
List<Object> authors11 = JsonPath.read(json, "$..book[?(@.isbn)]");
//All books in store cheaper than 10：获取json中book数组中price<10的所有值
List<Object> authors12 = JsonPath.read(json, "$.store.book[?(@.price < 10)]");
//All books in store that are not "expensive"：获取json中book数组中price<=expensive的所有值
List<Object> authors13 = JsonPath.read(json, "$..book[?(@.price <= $.expensive)]");
//All books matching regex (ignore case)：获取json中book数组中的作者以REES结尾的所有值（REES不区分大小写）
List<Object> authors14 = JsonPath.read(json, "$..book[?(@.author =~ /.*REES/i)]");
//Give me every thing：逐层列出json中的所有值，层级由外到内
List<Object> authors15 = JsonPath.read(json, "$..*");
//The number of books：获取json中book数组的长度
Integer authors16 = JsonPath.read(json, "$..book.length()");
print("**********authors1**********");
print(authors1);
print("**********authors2**********");
print(authors2);
print("**********authors3**********");
printOb(authors3);
print("**********authors4**********");
printOb(authors4);
print("**********authors5**********");
printOb(authors5);
print("**********authors6**********");
printOb(authors6);
print("**********authors7**********");
printOb(authors7);
print("**********authors8**********");
printOb(authors8);
print("**********authors9**********");
printOb(authors9);
print("**********authors10**********");
printOb(authors10);
print("**********authors11**********");
printOb(authors11);
print("**********authors12**********");
printOb(authors12);
print("**********authors13**********");
printOb(authors13);
print("**********authors14**********");
printOb(authors14);
print("**********authors15**********");
printOb(authors15);
print("**********authors16**********");
System.out.println(authors16);
print("************end**************");
}
private static void print(List<String> list) {
for(Iterator<String> it = list.iterator();it.hasNext();) {
System.out.println(it.next());
}
}
private static void printOb(List<Object> list) {
for(Iterator<Object> it = list.iterator();it.hasNext();) {
System.out.println(it.next());
}
}
private static void print(String s) {
System.out.println("\n"+s);
}
}
示例2：
public class TestJsonPath {
public static void main(String[] args) {
String myJson = readJson();
print("-----------------------getJsonValue0-----------------------");
getJsonValue0(myJson);
print("-----------------------getJsonValue1-----------------------");
getJsonValue1(myJson);
print("-----------------------getJsonValue2-----------------------");
getJsonValue2(myJson);
print("-----------------------getJsonValue3-----------------------");
getJsonValue3(myJson);
print("-----------------------getJsonValue4-----------------------");
getJsonValue4(myJson);
}
private static String readJson() {
StringBuilder sb = new StringBuilder();
try {
FileReader fr = new FileReader("src/main/resources/static/data.json");
BufferedReader bfd = new BufferedReader(fr);
String s = "";
while ((s = bfd.readLine()) != null) {
sb.append(s);
}
} catch (Exception e) {
e.printStackTrace();
}
System.out.println(sb);
return sb.toString();
}
/**
* 读取json的一种写法，得到匹配表达式的所有值
*/
private static void getJsonValue0(String json) {
List<String> authors = JsonPath.read(json, "$.store.book[*].author");
print(authors);
}
/**
* 读取JSON得到某个具体值（推荐使用这种方法，一次解析多次调用）
*/
private static void getJsonValue1(String json) {
Object document = Configuration.defaultConfiguration().jsonProvider().parse(json);
String author0 = JsonPath.read(document, "$.store.book[0].author");
String author1 = JsonPath.read(document, "$.store.book[1].author");
print(author0);
print(author1);
}
/**
* 读取json的一种写法
*/
private static void getJsonValue2(String json) {
ReadContext ctx = JsonPath.parse(json);
// 获取json中book数组中包含isbn的作者
List<String> authorsOfBooksWithISBN = ctx.read("$.store.book[?(@.isbn)].author");
// 获取json中book数组中价格大于10的对象
List<Map<String, Object>> expensiveBooks = JsonPath
.using(Configuration.defaultConfiguration())
.parse(json)
.read("$.store.book[?(@.price > 10)]", List.class);
print(authorsOfBooksWithISBN);
print("********Map********");
printListMap(expensiveBooks);
}
/**
* 读取JSON得到的值是一个String，所以不能用List存储
*/
private static void getJsonValue3(String json) {
//Will throw an java.lang.ClassCastException
//List<String> list = JsonPath.parse(json).read("$.store.book[0].author");
//由于会抛异常，暂时注释上面一行，要用的话，应使用下面的格式
String author = JsonPath.parse(json).read("$.store.book[0].author");
print(author);
}
/**
* 读取json的一种写法，支持逻辑表达式，&&和||
*/
private static void getJsonValue4(String json) {
List<Map<String, Object>> books1 = JsonPath.parse(json).read("$.store.book[?(@.price < 10 && @.category == 'fiction')]");
List<Map<String, Object>> books2 = JsonPath.parse(json).read("$.store.book[?(@.category == 'reference' || @.price > 10)]");
print("********books1********");
printListMap(books1);
print("********books2********");
printListMap(books2);
}
private static void print(List<String> list) {
for (Iterator<String> it = list.iterator(); it.hasNext(); ) {
System.out.println(it.next());
}
// System.out.println(list);
}
private static void printListMap(List<Map<String, Object>> list) {
for (Iterator<Map<String, Object>> it = list.iterator(); it.hasNext(); ) {
Map<String, Object> map = it.next();
for (Iterator iterator = map.entrySet().iterator(); iterator.hasNext(); ) {
System.out.println(iterator.next());
}
}
// System.out.println(list);
}
private static void print(String s) {
System.out.println("\n" + s);
}
}
