转载:http://www.ibloger.net/article/2329.html
JsonPath是一种简单的方法来提取给定JSON文档的部分内容。 JsonPath有许多编程语言，如Javascript，Python和PHP，Java。
JsonPath提供的json解析非常强大，它提供了类似正则表达式的语法，基本上可以满足所有你想要获得的json内容。下面我把官网介绍的每个表达式用代码实现，可以更直观的知道该怎么用它。
GitHub：https://github.com/json-path/JsonPath
以下是从GitHub中用我蹩脚的英格利希，翻译过来的，将就着看吧，推荐去管网上面阅读。
JsonPath可在Central Maven存储库中找到。 Maven用户将其添加到您的POM。
com.jayway.jsonpath json-path 2.2.0
如果您需要帮助，请在Stack Overflow中提问。 标记问题'jsonpath'和'java'。
JsonPath表达式总是以与XPath表达式结合使用XML文档相同的方式引用JSON结构。
JsonPath中的“根成员对象”始终称为$，无论是对象还是数组。
JsonPath表达式可以使用点表示法
$.store.book [0].title
或括号表示法
$['store']['book'][0]['title']
操作符
| 操作 | 说明 |
|---|---|
$ |
查询根元素。这将启动所有路径表达式。 |
@ |
当前节点由过滤谓词处理。 |
* |
通配符，必要时可用任何地方的名称或数字。 |
.. |
深层扫描。 必要时在任何地方可以使用名称。 |
. |
点，表示子节点 |
[' |
括号表示子项 |
[ |
数组索引或索引 |
[start:end] |
数组切片操作 |
[?( |
过滤表达式。 表达式必须求值为一个布尔值。 |
函数
函数可以在路径的尾部调用，函数的输出是路径表达式的输出，该函数的输出是由函数本身所决定的。
| 函数 | 描述 | 输出 |
|---|---|---|
min() |
提供数字数组的最小值 | Double |
max() |
提供数字数组的最大值 | Double |
avg() |
提供数字数组的平均值 | Double |
stddev() |
提供数字数组的标准偏差值 | Double |
length() |
提供数组的长度 | Integer |
过滤器运算符
过滤器是用于筛选数组的逻辑表达式。一个典型的过滤器将是[?(@.age > 18)]，其中@表示正在处理的当前项目。 可以使用逻辑运算符&&和||创建更复杂的过滤器。 字符串文字必须用单引号或双引号括起来([?(@.color == 'blue')] 或者 [?(@.color == "blue")]).
| 操作符 | 描述 |
|---|---|
== |
left等于right（注意1不等于'1'） |
!= |
不等于 |
< |
小于 |
<= |
小于等于 |
> |
大于 |
>= |
大于等于 |
=~ |
匹配正则表达式[?(@.name =~ /foo.*?/i)] |
in |
左边存在于右边 [?(@.size in ['S', 'M'])] |
nin |
左边不存在于右边 |
size |
（数组或字符串）长度 |
empty |
（数组或字符串）为空 |
Java操作示例
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 |
获取json中store下book下的所有author值 |
$..author |
获取所有json中所有author的值 |
$.store.* |
所有的东西，书籍和自行车 |
$.store..price |
获取json中store下所有price的值 |
$..book[2] |
获取json中book数组的第3个值 |
$..book[-2] |
倒数的第二本书 |
$..book[0,1] |
前两本书 |
$..book[: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的所有值 |
$..book[?(@.price <= $['expensive'])] |
获取json中book数组中price<=expensive的所有值 |
$..book[?(@.author =~ /.*REES/i)] |
获取json中book数组中的作者以REES结尾的所有值（REES不区分大小写） |
$..* |
逐层列出json中的所有值，层级由外到内 |
$..book.length() |
获取json中book数组的长度 |
阅读文档
使用JsonPath的最简单的最直接的方法是通过静态读取API。
String json = "...";
List> 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");JsonPath还提供流畅的API。 这也是最灵活的一个。
String json = "...";
ReadContext ctx = JsonPath.parse(json); List> authorsOfBooksWithISBN = ctx.read("$.store.book[?(@.isbn)].author"); List, Object>> expensiveBooks = JsonPath .using(configuration) .parse(json) .read("$.store.book[?(@.price > 10)]", List.class); 何时返回
当在java中使用JsonPath时，重要的是要知道你在结果中期望什么类型。 JsonPath将自动尝试将结果转换为调用者预期的类型。
// 抛出 java.lang.ClassCastException 异常
List> list = JsonPath.parse(json).read("$.store.book[0].author") // 正常 String author = JsonPath.parse(json).read("$.store.book[0].author") 当评估路径时，你需要理解路径确定的概念。路径是不确定的，它包含
-
..：深层扫描操作 -
?(：表达式) -
[：多个数组索引, (, )]
不确定的路径总是返回一个列表（由当前的JsonProvider表示）。
默认情况下，MappingProvider SPI提供了一个简单的对象映射器。 这允许您指定所需的返回类型，MappingProvider将尝试执行映射。 在下面的示例中，演示了Long和Date之间的映射。
String json = "{\"date_as_long\" : 1411455611975}";
Date date = JsonPath.parse(json).read("$['date_as_long']", Date.class);如果您将JsonPath配置为使用JacksonMappingProvider或GsonMappingProvider，您甚至可以将JsonPath输出直接映射到POJO中。
Book book = JsonPath.parse(json).read("$.store.book[0]", Book.class);要获取完整的泛型类型信息，请使用TypeRef。
TypeRef>> typeRef = new TypeRef>>(){}; List> titles = JsonPath.parse(JSON_DOCUMENT).read("$.store.book[*].title", typeRef); 谓词
在JsonPath中创建过滤器谓词有三种不同的方法。
内联谓词
内联谓词是路径中定义的谓词。
List, Object>> books = JsonPath.parse(json).read("$.store.book[?(@.price < 10)]"); 你可以使用 && 和 || 结合多个谓词 [?(@.price < 10 && @.category == 'fiction')] , [?(@.category == 'reference' || @.price > 10)].
你也可以使用！否定一个谓词 [?(!(@.price < 10 && @.category == 'fiction'))].
过滤谓词
谓词可以使用Filter API构建，如下所示：
import static com.jayway.jsonpath.JsonPath.parse; import static com.jayway.jsonpath.Criteria.where; import static com.jayway.jsonpath.Filter.filter; ... ... Filter cheapFictionFilter = filter( where("category").is("fiction").and("price").lte(10D) ); List, Object>> books = parse(json).read("$.store.book[?]", cheapFictionFilter); 注意占位符？ 为路径中的过滤器。 当提供多个过滤器时，它们按照占位符数量与提供的过滤器数量相匹配的顺序应用。 您可以在一个过滤器操作[？，？]中指定多个谓词占位符，这两个谓词都必须匹配。
过滤器也可以与“OR”和“AND”
Filter fooOrBar = filter(
where("foo").exists(true)).or(where("bar").exists(true) ); Filter fooAndBar = filter( where("foo").exists(true)).and(where("bar").exists(true) );自定义
第三个选择是实现你自己的谓词
Predicate booksWithISBN = new Predicate() { @Override public boolean apply(PredicateContext ctx) { return ctx.item(Map.class).containsKey("isbn"); } }; List, Object>> books = reader.read("$.store.book[?].isbn", List.class, booksWithISBN); Path vs Value
在Goessner实现中，JsonPath可以返回Path或Value。 值是默认值，上面所有示例返回。 如果你想让我们查询的元素的路径可以通过选项来实现。
Configuration conf = Configuration.builder().options(Option.AS_PATH_LIST).build(); List> pathList = using(conf).parse(json).read("$..author"); assertThat(pathList).containsExactly( "$['store']['book'][0]['author']", "$['store']['book'][1]['author']", "$['store']['book'][2]['author']", "$['store']['book'][3]['author']"); 调整配置
选项创建配置时，有几个可以改变默认行为的选项标志。
DEFAULT_PATH_LEAF_TO_NULL
此选项使JsonPath对于缺少的叶子返回null。 考虑下面的json
[
{
"name" : "john",
"gender" : "male"
},
{
"name" : "ben"
}
]
Configuration conf = Configuration.defaultConfiguration(); // 正常 String gender0 = JsonPath.using(conf).parse(json).read("$[0]['gender']"); // 异常 PathNotFoundException thrown String gender1 = JsonPath.using(conf).parse(json).read("$[1]['gender']"); Configuration conf2 = conf.addOptions(Option.DEFAULT_PATH_LEAF_TO_NULL); // 正常 String gender0 = JsonPath.using(conf2).parse(json).read("$[0]['gender']"); // 正常 (返回 null) String gender1 = JsonPath.using(conf2).parse(json).read("$[1]['gender']");ALWAYS_RETURN_LIST
此选项配置JsonPath返回列表
Configuration conf = Configuration.defaultConfiguration(); // 正常 List> genders0 = JsonPath.using(conf).parse(json).read("$[0]['gender']"); // 异常 PathNotFoundException thrown List> genders1 = JsonPath.using(conf).parse(json).read("$[1]['gender']"); SUPPRESS_EXCEPTIONS
该选项确保不会从路径评估传播异常。 遵循这些简单的规则：
-
如果选项ALWAYS_RETURN_LIST存在，将返回一个空列表
-
如果选项ALWAYS_RETURN_LIST不存在返回null
JsonProvider SPI
JsonPath is shipped with three different JsonProviders:
-
JsonSmartJsonProvider(default) -
JacksonJsonProvider -
JacksonJsonNodeJsonProvider -
GsonJsonProvider -
JsonOrgJsonProvider
更改配置默认值只能在应用程序初始化时完成。 强烈不建议在运行时进行更改，尤其是在多线程应用程序中。
Configuration.setDefaults(new Configuration.Defaults() { private final JsonProvider jsonProvider = new JacksonJsonProvider(); private final MappingProvider mappingProvider = new JacksonMappingProvider(); @Override public JsonProvider jsonProvider() { return jsonProvider; } @Override public MappingProvider mappingProvider() { return mappingProvider; } @Override public Set> options() { return EnumSet.noneOf(Option.class); } }); 请注意，JacksonJsonProvider需要com.fasterxml.jackson.core：jackson-databind：2.4.5，GsonJsonProvider需要在您的类路径上使用com.google.code.gson：gson：2.3.1。
Cache SPI
在JsonPath 2.1.0中，引入了一种新的Cache SPI。 这允许API消费者以适合其需求的方式配置路径缓存。 缓存必须在首次访问之前配置，或者抛出JsonPathException。 JsonPath附带两个缓存实现
-
com.jayway.jsonpath.spi.cache.LRUCache（默认，线程安全）
-
com.jayway.jsonpath.spi.cache.NOOPCache（无缓存）
如果要实现自己的缓存，API很简单。
CacheProvider.setCache(new Cache() { //Not thread safe simple cache private Map, JsonPath> map = new HashMap, JsonPath>(); @Override public JsonPath get(String key) { return map.get(key); } @Override public void put(String key, JsonPath jsonPath) { map.put(key, jsonPath); } }); Java操作示例源码
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":"JavaWeb","author":"X-rapido","title":"Top-link","isbn":"0-553-211231-3","price":32.68},{"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}
java
import java.io.BufferedReader;
import java.io.FileReader; import java.util.Iterator; import java.util.List; import com.jayway.jsonpath.JsonPath; public class TestJsonPath { public static void main(String[] args) { String sjson = readtxt(); print("--------------------------------------getJsonValue--------------------------------------"); getJsonValue(sjson); } private static String readtxt() { StringBuilder sb = new StringBuilder(); try { FileReader fr = new FileReader("D:/books.txt"); BufferedReader bfd = new BufferedReader(fr); String s = ""; while((s=bfd.readLine())!=null) { sb.append(s); } } catch (Exception e) { e.printStackTrace(); } System.out.println(sb.toString()); return sb.toString(); } private static void getJsonValue(String json) { //The authors of all books：获取json中store下book下的所有author值 List> authors1 = JsonPath.read(json, "$.store.book[*].author"); //All authors：获取所有json中所有author的值 List> authors2 = JsonPath.read(json, "$..author"); //All things, both books and bicycles //authors3返回的是net.minidev.json.JSONArray：获取json中store下的所有value值，不包含key，如key有两个，book和bicycle List> authors3 = JsonPath.read(json, "$.store.*"); //The price of everything：获取json中store下所有price的值 List> authors4 = JsonPath.read(json, "$.store..price"); //The third book：获取json中book数组的第3个值 List> authors5 = JsonPath.read(json, "$..book[2]"); //The first two books：获取json中book数组的第1和第2两个个值 List> authors6 = JsonPath.read(json, "$..book[0,1]"); //All books from index 0 (inclusive) until index 2 (exclusive)：获取json中book数组的前两个区间值 List> authors7 = JsonPath.read(json, "$..book[:2]"); //All books from index 1 (inclusive) until index 2 (exclusive)：获取json中book数组的第2个值 List> authors8 = JsonPath.read(json, "$..book[1:2]"); //Last two books：获取json中book数组的最后两个值 List> authors9 = JsonPath.read(json, "$..book[-2:]"); //Book number two from tail：获取json中book数组的第3个到最后一个的区间值 List> authors10 = JsonPath.read(json, "$..book[2:]");