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。

相关文章

Python通用唯一标识符模块uuid使用案例详解

Python通用唯一标识符模块uuid使用案例详解

《Python通用唯一标识符模块uuid使用案例详解》Pythonuuid模块用于生成128位全局唯一标识符,支持UUID1-5版本,适用于分布式系统、数据库主键等场景,需注意隐私、碰撞概率及存储优... 目录简介核心功能1. UUID版本2. UUID属性3. 命名空间使用场景1. 生成唯一标识符2. 数
阅读更多...
SpringBoot中如何使用Assert进行断言校验

SpringBoot中如何使用Assert进行断言校验

《SpringBoot中如何使用Assert进行断言校验》Java提供了内置的assert机制,而Spring框架也提供了更强大的Assert工具类来帮助开发者进行参数校验和状态检查,下... 目录前言一、Java 原生assert简介1.1 使用方式1.2 示例代码1.3 优缺点分析二、Spring Fr
阅读更多...
Android kotlin中 Channel 和 Flow 的区别和选择使用场景分析

Android kotlin中 Channel 和 Flow 的区别和选择使用场景分析

《Androidkotlin中Channel和Flow的区别和选择使用场景分析》Kotlin协程中,Flow是冷数据流,按需触发,适合响应式数据处理；Channel是热数据流,持续发送,支持... 目录一、基本概念界定FlowChannel二、核心特性对比数据生产触发条件生产与消费的关系背压处理机制生命周期
阅读更多...
java使用protobuf-maven-plugin的插件编译proto文件详解

java使用protobuf-maven-plugin的插件编译proto文件详解

《java使用protobuf-maven-plugin的插件编译proto文件详解》：本文主要介绍java使用protobuf-maven-plugin的插件编译proto文件,具有很好的参考价... 目录protobuf文件作为数据传输和存储的协议主要介绍在Java使用maven编译proto文件的插件
阅读更多...
SpringBoot线程池配置使用示例详解

SpringBoot线程池配置使用示例详解

《SpringBoot线程池配置使用示例详解》SpringBoot集成@Async注解,支持线程池参数配置（核心数、队列容量、拒绝策略等）及生命周期管理,结合监控与任务装饰器,提升异步处理效率与系统... 目录一、核心特性二、添加依赖三、参数详解四、配置线程池五、应用实践代码说明拒绝策略（Rejected
阅读更多...
C++ Log4cpp跨平台日志库的使用小结

C++ Log4cpp跨平台日志库的使用小结

《C++Log4cpp跨平台日志库的使用小结》Log4cpp是c++类库,本文详细介绍了C++日志库log4cpp的使用方法,及设置日志输出格式和优先级,具有一定的参考价值,感兴趣的可以了解一下... 目录一、介绍1. log4cpp的日志方式2.设置日志输出的格式3. 设置日志的输出优先级二、Window
阅读更多...
Ubuntu如何分配​​未使用的空间

Ubuntu如何分配​​未使用的空间

《Ubuntu如何分配​​未使用的空间》Ubuntu磁盘空间不足,实际未分配空间8.2G因LVM卷组名称格式差异（双破折号误写）导致无法扩展,确认正确卷组名后,使用lvextend和resize2fs... 目录1：原因2：操作3：报错5：解决问题：确认卷组名称​6：再次操作7：验证扩展是否成功8：问题已解
阅读更多...
Qt使用QSqlDatabase连接MySQL实现增删改查功能

Qt使用QSqlDatabase连接MySQL实现增删改查功能

《Qt使用QSqlDatabase连接MySQL实现增删改查功能》这篇文章主要为大家详细介绍了Qt如何使用QSqlDatabase连接MySQL实现增删改查功能,文中的示例代码讲解详细,感兴趣的小伙伴... 目录一、创建数据表二、连接mysql数据库三、封装成一个完整的轻量级 ORM 风格类3.1 表结构
阅读更多...
使用Docker构建Python Flask程序的详细教程

使用Docker构建Python Flask程序的详细教程

《使用Docker构建PythonFlask程序的详细教程》在当今的软件开发领域,容器化技术正变得越来越流行,而Docker无疑是其中的佼佼者,本文我们就来聊聊如何使用Docker构建一个简单的Py... 目录引言一、准备工作二、创建 Flask 应用程序三、创建 dockerfile四、构建 Docker
阅读更多...
Python使用vllm处理多模态数据的预处理技巧

Python使用vllm处理多模态数据的预处理技巧

《Python使用vllm处理多模态数据的预处理技巧》本文深入探讨了在Python环境下使用vLLM处理多模态数据的预处理技巧,我们将从基础概念出发,详细讲解文本、图像、音频等多模态数据的预处理方法,... 目录1. 背景介绍1.1 目的和范围1.2 预期读者1.3 文档结构概述1.4 术语表1.4.1 核
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2