JsonPath | FastJson的JSONPath使用

2024-06-09 17:08
文章标签 使用 fastjson jsonpath

本文主要是介绍JsonPath | FastJson的JSONPath使用，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

一. 简介

JSONPath - 用于JSON的XPath

用来解析多层嵌套的json数据;JsonPath 是一种信息抽取类库，是从JSON文档中抽取指定信息的工具.

 JsonPath有许多编程语言，如Javascript、Python、PHP、Java等

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

 JSONPath GitHub: https://github.com/json-path/JsonPath 

JsonPath表达式始终引用JSON结构，其方式与XPath表达式与XML文档结合使用的方式相同。$无论是对象还是数组，JsonPath中的“根成员对象”始终被称为。

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

$.store.book[0].title

或括号表示法

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

 二、API

使用的时候建议缓存JSONPath对象，这样能够提高求值的性能。

package com.alibaba.fastjson;public class JSONPath {          //  求值，静态方法public static Object eval(Object rootObject, String path);// 计算Size，Map非空元素个数，对象非空元素个数，Collection的Size，数组的长度。其他无法求值返回-1public static int size(Object rootObject, String path);// 是否包含，path中是否存在对象public static boolean contains(Object rootObject, String path) { }// 是否包含，path中是否存在指定值，如果是集合或者数组，在集合中查找value是否存在public static boolean containsValue(Object rootObject, String path, Object value) { }// 修改制定路径的值，如果修改成功，返回true，否则返回falsepublic static boolean set(Object rootObject, String path, Object value) {}// 在数组或者集合中添加元素public static boolean array_add(Object rootObject, String path, Object... values);
}

三、支持语法

JSONPATH描述
</td><td>根对象，例如.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 like ‘aa(.)*’]，
正则语法为jdk的正则语法，支持not rlike
[key in (‘v0’, ‘v1’)]IN过滤, 支持字符串和数值类型 
例如: 
.departs[namein(′wenshao′,′Yako′)]<br/>.departs[id not in (101,102)]
[key between 234 and 456]BETWEEN过滤, 支持数值类型，支持not between 
例如: 
.departs[idbetween101and201]<br/>.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’]

以下两种写法的语义是相同的：

$.store.book[0].title

和

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

四、语法示例

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

五、API示例

5.1 基础例子

public void test_entity() throws Exception {Entity entity = new Entity(123, new Object());Assert.assertSame(entity.getValue(), JSONPath.eval(entity, "$.value")); Assert.assertTrue(JSONPath.contains(entity, "$.value"));Assert.assertTrue(JSONPath.containsValue(entity, "$.id", 123));Assert.assertTrue(JSONPath.containsValue(entity, "$.value", entity.getValue())); Assert.assertEquals(2, JSONPath.size(entity, "$"));Assert.assertEquals(0, JSONPath.size(new Object[], "$")); 
}public static class Entity {private Integer id;private String name;private Object value;public Entity() {}public Entity(Integer id, Object value) { this.id = id; this.value = value; }public Entity(Integer id, String name) { this.id = id; this.name = name; }public Entity(String name) { this.name = name; }public Integer getId() { return id; }public Object getValue() { return value; }        public String getName() { return name; }public void setId(Integer id) { this.id = id; }public void setName(String name) { this.name = name; }public void setValue(Object value) { this.value = value; }
}

5.2 读取集合多个元素的某个属性

List<Entity> entities = new ArrayList<Entity>();
entities.add(new Entity("wenshao"));
entities.add(new Entity("ljw2083"));List<String> names = (List<String>)JSONPath.eval(entities, "$.name"); // 返回enties的所有名称
Assert.assertSame(entities.get(0).getName(), names.get(0));
Assert.assertSame(entities.get(1).getName(), names.get(1));

5.3 返回集合中多个元素

List<Entity> entities = new ArrayList<Entity>();
entities.add(new Entity("wenshao"));
entities.add(new Entity("ljw2083"));
entities.add(new Entity("Yako"));List<Entity> result = (List<Entity>)JSONPath.eval(entities, "[1,2]"); // 返回下标为1和2的元素
Assert.assertEquals(2, result.size());
Assert.assertSame(entities.get(1), result.get(0));
Assert.assertSame(entities.get(2), result.get(1));

 5.4 按范围返回集合的子集

List<Entity> entities = new ArrayList<Entity>();
entities.add(new Entity("wenshao"));
entities.add(new Entity("ljw2083"));
entities.add(new Entity("Yako"));List<Entity> result = (List<Entity>)JSONPath.eval(entities, "[0:2]"); // 返回下标从0到2的元素
Assert.assertEquals(3, result.size());
Assert.assertSame(entities.get(0), result.get(0));
Assert.assertSame(entities.get(1), result.get(1));
Assert.assertSame(entities.get(2), result.get(1));

5.5 通过条件过滤，返回集合的子集

List<Entity> entities = new ArrayList<Entity>();
entities.add(new Entity(1001, "ljw2083"));
entities.add(new Entity(1002, "wenshao"));
entities.add(new Entity(1003, "yakolee"));
entities.add(new Entity(1004, null));List<Object> result = (List<Object>) JSONPath.eval(entities, "[id in (1001)]");
Assert.assertEquals(1, result.size());
Assert.assertSame(entities.get(0), result.get(0));

5.6 根据属性值过滤条件判断是否返回对象，修改对象，数组属性添加元素

Entity entity = new Entity(1001, "ljw2083");
Assert.assertSame(entity , JSONPath.eval(entity, "[id = 1001]"));
Assert.assertNull(JSONPath.eval(entity, "[id = 1002]"));JSONPath.set(entity, "id", 123456); //将id字段修改为123456
Assert.assertEquals(123456, entity.getId().intValue());JSONPath.set(entity, "value", new int[0]); //将value字段赋值为长度为0的数组
JSONPath.arrayAdd(entity, "value", 1, 2, 3); //将value字段的数组添加元素1,2,3

5.7 具体用例测试


@RunWith(SpringRunner.class)
@SpringBootTest
@Slf4j
public class JSONpathControllerTest {@Testpublic void test() {User user = new User("itguang", "123456", "123@qq.com");String username = (String) JSONPath.eval(user, "$.username");log.info("$.username = {}", username);Entity entity = new Entity(123, user);User user1 = (User) JSONPath.eval(entity, "$.value");log.info("user={}", user1.toString());}@Testpublic void test2() {User user = new User("itguang", "123456", "123@qq.com");Entity entity = new Entity(123, user);//判断entity中是否有 databoolean contains = JSONPath.contains(entity, "$.data");Assert.assertTrue(contains);//判断 entity.data.username 属性值是否为 itguangboolean containsValue = JSONPath.containsValue(entity, "$.data.username", "itguang");Assert.assertTrue(containsValue);Assert.assertEquals(2, JSONPath.size(entity, "$"));}@Testpublic void test3() {List<Entity> entities = new ArrayList<Entity>();entities.add(new Entity("逻辑"));entities.add(new Entity("叶文杰"));entities.add(new Entity("程心"));//返回集合中多个元素List<String> names = (List<String>) JSONPath.eval(entities, "$.name");log.info("返回集合中多个元素names={}", names);//返回下标 0 和 2 的元素List<Entity> result = (List<Entity>) JSONPath.eval(entities, "[0,2]");log.info("返回下标 0 和 2 的元素={}", result);// 返回下标从0到2的元素List<Entity> result2 = (List<Entity>) JSONPath.eval(entities, "[0:2]");log.info("返回下标从0到2的元素={}", result2);}@Testpublic void test4() {List<Entity> entities = new ArrayList<Entity>();entities.add(new Entity(1001, "逻辑"));entities.add(new Entity(1002, "程心"));entities.add(new Entity(1003, "叶文杰"));entities.add(new Entity(1004, null));//通过条件过滤，返回集合的子集List<Entity> result = (List<Entity>) JSONPath.eval(entities, "[id in (1001)]");log.info("通过条件过滤，返回集合的子集={}", result);}/*** 使用JSONPrase 解析JSON字符串或者Object对象* <p>* read(String json, String path)//直接使用json字符串匹配* <p>* eval(Object rootObject, String path) //直接使用 对象匹配* <p>* <p>* {"store":{"bicycle":{"color":"red","price":19.95},"book":[{"author":"Nigel Rees","price":8.95,"category":"reference","title":"Sayings of the Century"},{"author":"Evelyn Waugh","price":12.99,"isbn":"0-553-21311-3","category":"fiction","title":"Sword of Honour"}]}}*/@Testpublic void test5() {String jsonStr = "{\n" +"    \"store\": {\n" +"        \"bicycle\": {\n" +"            \"color\": \"red\",\n" +"            \"price\": 19.95\n" +"        },\n" +"        \"book\": [\n" +"            {\n" +"                \"author\": \"刘慈欣\",\n" +"                \"price\": 8.95,\n" +"                \"category\": \"科幻\",\n" +"                \"title\": \"三体\"\n" +"            },\n" +"            {\n" +"                \"author\": \"itguang\",\n" +"                \"price\": 12.99,\n" +"                \"category\": \"编程语言\",\n" +"                \"title\": \"go语言实战\"\n" +"            }\n" +"        ]\n" +"    }\n" +"}";JSONObject jsonObject = JSON.parseObject(jsonStr);log.info(jsonObject.toString());//得到所有的书List<Book> books = (List<Book>) JSONPath.eval(jsonObject, "$.store.book");log.info("books={}", books);//得到所有的书名List<String> titles = (List<String>) JSONPath.eval(jsonObject, "$.store.book.title");log.info("titles={}", titles);//第一本书titleString title = (String) JSONPath.read(jsonStr, "$.store.book[0].title");log.info("title={}", title);//price大于10元的bookList<Book> list = (List<Book>) JSONPath.read(jsonStr, "$.store.book[price > 10]");log.info("price大于10元的book={}",list);//price大于10元的titleList<String> list2 =(List<String>) JSONPath.read(jsonStr, "$.store.book[price > 10].title");log.info("price大于10元的title={}",list2);//category(类别)为科幻的bookList<Book> list3 = (List<Book>) JSONPath.read(jsonStr,"$.store.book[category = '科幻']");log.info("category(类别)为科幻的book={}",list3);//bicycle的所有属性值Collection<String> values = (Collection<String>) JSONPath.eval(jsonObject, "$.store.bicycle.*");log.info("bicycle的所有属性值={}",values);//bicycle的color和price属性值List<String> read =(List<String>) JSONPath.read(jsonStr, "$.store.bicycle['color','price']");log.info("bicycle的color和price属性值={}",read);}}

源码地址: https://github.com/itguang/gitbook-smile/blob/master/springboot-fastjson/fastjson%E4%B9%8BJSONPath%E4%BD%BF%E7%94%A8.md

这篇关于JsonPath | FastJson的JSONPath使用的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/1045782。

相关文章

Java中流式并行操作parallelStream的原理和使用方法

Java中流式并行操作parallelStream的原理和使用方法

《Java中流式并行操作parallelStream的原理和使用方法》本文详细介绍了Java中的并行流（parallelStream）的原理、正确使用方法以及在实际业务中的应用案例,并指出在使用并行流... 目录Java中流式并行操作parallelStream0. 问题的产生1. 什么是parallelS
阅读更多...
Linux join命令的使用及说明

Linux join命令的使用及说明

《Linuxjoin命令的使用及说明》`join`命令用于在Linux中按字段将两个文件进行连接,类似于SQL的JOIN,它需要两个文件按用于匹配的字段排序,并且第一个文件的换行符必须是LF,`jo... 目录一. 基本语法二. 数据准备三. 指定文件的连接key四.-a输出指定文件的所有行五.-o指定输出
阅读更多...
Linux jq命令的使用解读

Linux jq命令的使用解读

《Linuxjq命令的使用解读》jq是一个强大的命令行工具,用于处理JSON数据,它可以用来查看、过滤、修改、格式化JSON数据,通过使用各种选项和过滤器,可以实现复杂的JSON处理任务... 目录一. 简介二. 选项2.1.2.2-c2.3-r2.4-R三. 字段提取3.1 普通字段3.2 数组字段四.
阅读更多...
Linux kill正在执行的后台任务 kill进程组使用详解

Linux kill正在执行的后台任务 kill进程组使用详解

《Linuxkill正在执行的后台任务kill进程组使用详解》文章介绍了两个脚本的功能和区别,以及执行这些脚本时遇到的进程管理问题,通过查看进程树、使用`kill`命令和`lsof`命令,分析了子... 目录零. 用到的命令一. 待执行的脚本二. 执行含子进程的脚本，并kill2.1 进程查看2.2 遇到的
阅读更多...
详解SpringBoot+Ehcache使用示例

详解SpringBoot+Ehcache使用示例

《详解SpringBoot+Ehcache使用示例》本文介绍了SpringBoot中配置Ehcache、自定义get/set方式,并实际使用缓存的过程,文中通过示例代码介绍的非常详细,对大家的学习或者... 目录摘要概念内存与磁盘持久化存储：配置灵活性：编码示例引入依赖：配置ehcache.XML文件：配置
阅读更多...
Java 虚拟线程的创建与使用深度解析

Java 虚拟线程的创建与使用深度解析

《Java虚拟线程的创建与使用深度解析》虚拟线程是Java19中以预览特性形式引入,Java21起正式发布的轻量级线程,本文给大家介绍Java虚拟线程的创建与使用,感兴趣的朋友一起看看吧... 目录一、虚拟线程简介1.1 什么是虚拟线程？1.2 为什么需要虚拟线程？二、虚拟线程与平台线程对比代码对比示例：三
阅读更多...
k8s按需创建PV和使用PVC详解

k8s按需创建PV和使用PVC详解

《k8s按需创建PV和使用PVC详解》Kubernetes中,PV和PVC用于管理持久存储,StorageClass实现动态PV分配,PVC声明存储需求并绑定PV,通过kubectl验证状态,注意回收... 目录1.按需创建 PV（使用 StorageClass）创建 StorageClass2.创建 PV
阅读更多...
Redis 基本数据类型和使用详解

Redis 基本数据类型和使用详解

《Redis基本数据类型和使用详解》String是Redis最基本的数据类型,一个键对应一个值,它的功能十分强大,可以存储字符串、整数、浮点数等多种数据格式,本文给大家介绍Redis基本数据类型和... 目录一、Redis 入门介绍二、Redis 的五大基本数据类型2.1 String 类型2.2 Hash
阅读更多...
Redis中Hash从使用过程到原理说明

Redis中Hash从使用过程到原理说明

《Redis中Hash从使用过程到原理说明》RedisHash结构用于存储字段-值对,适合对象数据,支持HSET、HGET等命令,采用ziplist或hashtable编码,通过渐进式rehash优化... 目录一、开篇：Hash就像超市的货架二、Hash的基本使用1. 常用命令示例2. Java操作示例三
阅读更多...
Linux创建服务使用systemctl管理详解

Linux创建服务使用systemctl管理详解

《Linux创建服务使用systemctl管理详解》文章指导在Linux中创建systemd服务,设置文件权限为所有者读写、其他只读,重新加载配置,启动服务并检查状态,确保服务正常运行,关键步骤包括权... 目录创建服务 /usr/lib/systemd/system/设置服务文件权限：所有者读写js，其他
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2