(全网最详细) FastJson解析器JsonPath的使用

一、JsonPath定义

        JsonPath是一种查询和导航JSON文档的路径表达式语言，类似于XPath在XML文档中的作用，用于从JSON数据结构中选取和提取数据。在FastJson中，通过JsonPath可以很方便的对JSON文档获取指定的路径数据。

在我们实际使用中，JsonPath可以方便日常开发中对于JSON文档的解析，减少层层的get和转JSON对象的转换，可以通过简洁的JsonPath表达式精准的获取需要的部分。

二、快速使用

引入依赖

这里引用的是FastJson2的依赖，FastJson2与FastJson1相比，性能有很大的提升，并且解决了之前autoType功能因为兼容和白名单的安全性问题。

<!-- https://github.com/alibaba/fastjson2 -->
<dependency>
    <groupId>com.alibaba.fastjson2</groupId>
    <artifactId>fastjson2-extension-spring5</artifactId>
    <version>2.0.48</version>
</dependency>

基本使用

使用JSONPath读取部分数据

String text = ...;
JSONPath path = JSONPath.of("$.id"); // 缓存起来重复使用能提升性能

JSONReader parser = JSONReader.of(text);
Object result = path.extract(parser);

使用JSONPath读取部分byte[]的数据

byte[] bytes = ...;
JSONPath path = JSONPath.of("$.id"); // 缓存起来重复使用能提升性能

JSONReader parser = JSONReader.of(bytes);
Object result = path.extract(parser);

使用JSONPath读取部分byte[]的数据

byte[] bytes = ...;
JSONPath path = JSONPath.of("$.id"); // 缓存起来重复使用能提升性能

JSONReader parser = JSONReader.ofJSONB(bytes); // 注意这里使用ofJSONB方法
Object result = path.extract(parser);

FastJson2 JSONPath语法

JSONPATH	描述
$	根对象，例如$.name
[num]	数组访问，其中num是数字，可以是负数。例如$[0].leader.departments[-1].name
[num0,num1,num2…]	数组多个元素访问，其中num是数字，可以是负数，返回数组中的多个元素。例如$[0,3,-2,5]
[start:end]	数组范围访问，其中start和end是开始小表和结束下标，可以是负数，返回数组中的多个元素。例如$[0:5]
[start:end :step]	数组范围访问，其中start和end是开始小表和结束下标，可以是负数；step是步长，返回数组中的多个元素。例如$[0:5:2]
[?(@.key)]	对象属性非空过滤，例如$.departs[?(@.name)]
[?(@.key > 123)]	数值类型对象属性比较过滤，例如$.departs[id >= 123]，比较操作符支持=,!=,>,>=,<,<=
[?(@.key = ‘123’)]	字符串类型对象属性比较过滤，例如$.departs[?(@..name = ‘123’)]，比较操作符支持=,!=,>,>=,<,<=
[?(@.key like ‘aa%’)]	字符串类型like过滤， 例如$.departs[?(@..name like ‘sz*’)]，通配符只支持%支持not like
[?(@.key rlike ‘regexpr’)]	字符串类型正则匹配过滤，	例如departs[name rlike ‘aa(.)*’]，正则语法为jdk的正则语法，支持not rlike
[?(@.key in (‘v0’, ‘v1’))]	IN过滤, 支持字符串和数值类型 例如: $.departs[?(@.name in (‘wenshao’,’Yako’))] $.departs[id not in (101,102)]
[?(@.key between 234 and 456)]	BETWEEN过滤, 支持数值类型，支持not between 例如: $.departs[?(@.id between 101 and 201)] $.departs[?(@.id not between 101 and 201)]
length() 或者 size()	数组长度。例如$.values.size() 支持类型java.util.Map和java.util.Collection和数组
.	属性访问，例如$.name
..	deepScan属性访问，例如$..name
*	对象的所有属性，例如$.leader.*
[‘key’]	属性访问。例如$[‘name’]
[‘key0’,’key1’]	多个属性访问。例如$[‘id’,’name’]

语义举例

JSONPath	语义
$	根对象
$[-1]	最后元素
$[:-2]	第1个至倒数第2个
$[1:]	第2个之后所有元素
$[1,2,3]	集合中1,2,3个元素

FastJson JSONPath函数使用

示例代码

public class JsonPathDemo {
    public static void main(String[] args) {
        String jsonStr = getJsonStr();
        JSONPath jsonPath = JSONPath.of("$.userInfo");
        JSONReader parser = JSONReader.of(jsonStr);
        Object jsonObject = jsonPath.extract(parser);
        System.out.println("使用extract解析：" + jsonObject);

        Object evalString = JSONPath.eval(jsonStr, "$.userInfo");
        System.out.println("使用eval解析：" + evalString);

        String removeStr = JSONPath.remove(jsonStr, "$.userInfo");
        System.out.println("使用remove删除节点：" + removeStr);

        String insertStr = JSONPath.set(jsonStr, "$.userInfo.addData", "sinder");
        System.out.println("使用set插入节点：" + insertStr);

    }

    public static String getJsonStr() {
        return "{\"name\":\"sinder\",\"age\":\"18\", \"userList\": [1, 2, 3, 4], \"userInfo\": {\"username\": \"sinder\"}}";
    }
}

更多操作，亲自体验！！！

---

常用的方式：

JSONPath.eval(jsonStr, "$.")来解析json节点的数据

JSONPath.remove(jsonStr, "$.")删除对应的节点数据

JSONPath.set(jsonStr, "$.userInfo.addData", "sinder")为json数据插入指定的值，甚至可以直接操作json中的数组或者对象数据。