JOSNPath 是一个非常强大的工具,对于处理 json 对象非常方便。

官方地址:https://github.com/alibaba/fastjson/wiki/JSONPath

基本用法:https://blog.csdn.net/itguangit/article/details/78764212

1. JSONPath介绍

fastjson 1.2.0之后的版本支持JSONPath。这是一个很强大的功能,可以在java框架中当作对象查询语言(OQL)来使用。

2. API

  1. package com.alibaba.fastjson;
  2.  
  3. public class JSONPath {
  4. // 求值,静态方法
  5. public static Object eval(Object rootObject, String path);
  6.  
  7. // 求值,静态方法,按需计算,性能更好
  8. public static Object extract(String json, String path);
  9.  
  10. // 计算Size,Map非空元素个数,对象非空元素个数,Collection的Size,数组的长度。其他无法求值返回-1
  11. public static int size(Object rootObject, String path);
  12.  
  13. // 是否包含,path中是否存在对象
  14. public static boolean contains(Object rootObject, String path) { }
  15.  
  16. // 是否包含,path中是否存在指定值,如果是集合或者数组,在集合中查找value是否存在
  17. public static boolean containsValue(Object rootObject, String path, Object value) { }
  18.  
  19. // 修改制定路径的值,如果修改成功,返回true,否则返回false
  20. public static boolean set(Object rootObject, String path, Object value) {}
  21.  
  22. // 在数组或者集合中添加元素
  23. public static boolean arrayAdd(Object rootObject, String path, Object... values);
  24.  
  25. // 获取,Map的KeySet,对象非空属性的名称。数组、Collection等不支持类型返回null。
  26. public static Set<?> keySet(Object rootObject, String path);
  27. }

建议缓存JSONPath对象,这样能够提高求值的性能。

3. 支持语法

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 like '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和数组
keySet() 获取Map的keySet或者对象的非空属性名称。例如$.val.keySet() 
支持类型:Map和普通对象
不支持:Collection和数组(返回null)
. 属性访问,例如$.name
.. deepScan属性访问,例如$..name
* 对象的所有属性,例如$.leader.*
['key'] 属性访问。例如$['name']
['key0','key1'] 多个属性访问。例如$['id','name']

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

  1. $.store.book[0].title

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

4. 语法示例

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

5. API 示例

5.1 例1

  1. public void test_entity() throws Exception {
  2. Entity entity = new Entity(123, new Object());
  3.  
  4. Assert.assertSame(entity.getValue(), JSONPath.eval(entity, "$.value"));
  5. Assert.assertTrue(JSONPath.contains(entity, "$.value"));
  6. Assert.assertTrue(JSONPath.containsValue(entity, "$.id", 123));
  7. Assert.assertTrue(JSONPath.containsValue(entity, "$.value", entity.getValue()));
  8. Assert.assertEquals(2, JSONPath.size(entity, "$"));
  9. Assert.assertEquals(0, JSONPath.size(new Object[], "$"));
  10. }
  11.  
  12. public static class Entity {
  13. private Integer id;
  14. private String name;
  15. private Object value;
  16.  
  17. public Entity() {}
  18. public Entity(Integer id, Object value) { this.id = id; this.value = value; }
  19. public Entity(Integer id, String name) { this.id = id; this.name = name; }
  20. public Entity(String name) { this.name = name; }
  21.  
  22. public Integer getId() { return id; }
  23. public Object getValue() { return value; }
  24. public String getName() { return name; }
  25.  
  26. public void setId(Integer id) { this.id = id; }
  27. public void setName(String name) { this.name = name; }
  28. public void setValue(Object value) { this.value = value; }
  29. }

5.2 例2

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

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

5.3 例3

返回集合中多个元素

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

5.4 例4

按范围返回集合的子集

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

5.5 例5

通过条件过滤,返回集合的子集

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

5.6 例6

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

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

5.7 例7

  1. Map root = Collections.singletonMap("company", //
  2. Collections.singletonMap("departs", //
  3. Arrays.asList( //
  4. Collections.singletonMap("id",
  5. 1001), //
  6. Collections.singletonMap("id",
  7. 1002), //
  8. Collections.singletonMap("id", 1003) //
  9. ) //
  10. ));
  11.  
  12. List<Object> ids = (List<Object>) JSONPath.eval(root, "$..id");
  13. assertEquals(3, ids.size());
  14. assertEquals(1001, ids.get(0));
  15. assertEquals(1002, ids.get(1));
  16. assertEquals(1003, ids.get(2));

5.8 例8 keySet

使用keySet抽取对象的属性名,null值属性的名字并不包含在keySet结果中,使用时需要注意,详细可参考示例。

  1. Entity e = new Entity();
  2. e.setId(null);
  3. e.setName("hello");
  4. Map<String, Entity> map = Collections.singletonMap("e", e);
  5. Collection<String> result;
  6.  
  7. // id is null, excluded by keySet
  8. result = (Collection<String>)JSONPath.eval(map, "$.e.keySet()");
  9. assertEquals(1, result.size());
  10. Assert.assertTrue(result.contains("name"));
  11.  
  12. e.setId(1L);
  13. result = (Collection<String>)JSONPath.eval(map, "$.e.keySet()");
  14. Assert.assertEquals(2, result.size());
  15. Assert.assertTrue(result.contains("id")); // included
  16. Assert.assertTrue(result.contains("name"));
  17.  
  18. // Same result
  19. Assert.assertEquals(result, JSONPath.keySet(map, "$.e"));
  20. Assert.assertEquals(result, new JSONPath("$.e").keySet(map));

alibaba/fastjson 之 JSONPath的更多相关文章

  1. fastJson 之 JSONPath使用

    1. JSONPath介绍 官网地址: https://github.com/alibaba/fastjson/wiki/JSONPath fastjson 1.2.0之后的版本支持JSONPath. ...

  2. Alibaba FastJson 常用方法使用指南

    介绍 FastJson是阿里巴巴的开源JSON解析库,它可以解析JSON格式的字符串,支持将Java Bean序列化为JSON字符串,也可以从JSON字符串反序列化到JavaBean. FastJso ...

  3. alibaba fastjson List<Map<String, String>>2Str

    import java.util.ArrayList;import java.util.HashMap;import java.util.List;import java.util.Map; impo ...

  4. Alibaba FastJson

    import com.alibaba.fastjson.JSON import com.alibaba.fastjson.JSONObject class Test { static main(arg ...

  5. 全解史上最快的JOSN解析库 - alibaba Fastjson

    JSON,全称:JavaScript Object Notation,作为一个常见的轻量级的数据交换格式,应该在一个程序员的开发生涯中是常接触的.简洁和清晰的层次结构使得 JSON 成为理想的数据交换 ...

  6. JAVA中使用alibaba fastjson实现JSONObject、Object、Json字符串的转换

    JAVA中使用alibaba fastjson实现JSONObject.Object.Json字符串的转换 Object转JSON字符串:String jsonStr = JSONObject.toJ ...

  7. 探索RequestBody报com.alibaba.fastjson.JSONObject cannot be cast to xxx

    今天使用RequestBody接受前端传过来的参数,以前接受字符串数组非常成功,这次把形参改成了List<User>,原本以为顺利接受参数并映射成User的list结构,结果竟然在我取us ...

  8. 42-字符串到json 的错误 com.alibaba.fastjson.JSONObject cannot be cast to java.lang.String

    json: {"updated_at":1551780617,"attr":{"uptime_h":3,"uptime_m&quo ...

  9. com.alibaba.fastjson.JSON对类对象的序列化与反序列化

    1. 目标 把类的对象存储到字符串可存储 2. 类定义 public interface JsonInterface { } mport com.alibaba.fastjson.JSON; impo ...

随机推荐

  1. vue建项目并使用

    今天来回顾下vue项目的建立和使用,好久不用感觉不会用了. 下面两个都要全局安装 首先安装git,地址  https://gitforwindows.org/ 安装node, 地址 https://n ...

  2. (33)zabbix proxy分布式监控配置

    概述 zabbix proxy可以代替zabbix server检索客户端的数据,然后把数据汇报给zabbix server,并且在一定程度上分担了zabbix server的压力.zabbix pr ...

  3. (11)zabbix item types监控类型

    1. 什么是item types item types是由zabbix提供的各种类型的检查器(这样翻译很奇怪),大致就是Zabbix agent, Simple checks, SNMP, Zabbi ...

  4. python爬虫基础06-常见加密算法

    Python与常见加密方式 前言 数据加密与解密通常是为了保证数据在传输过程中的安全性,自古以来就一直存在,古代主要应用在战争领域,战争中会有很多情报信息要传递,这些重要的信息都会经过加密,在发送到对 ...

  5. 【转】怎么把本地项目和远程git仓库相连通

    1. 打开在你的项目文件夹,输入下面的命令 git init 输完上面的命令,文件夹中会出现一个.git文件夹,如下图所示,其他的的文件也会出现蓝色小问号的标志 2. 添加所有文件 git add . ...

  6. BIOM Table-codes

    import numpy from biom.table import Table ========================================================== ...

  7. (转)浅谈测试驱动开发(TDD)

    测试驱动开发(TDD)是极限编程的重要特点,它以不断的测试推动代码的开发,既简化了代码,又保证了软件质量.本文从开发人员使用的角度,介绍了 TDD 优势.原理.过程.原则.测试技术.Tips 等方面. ...

  8. Linux下平滑升级nginx

    一.升级前准备 1.对nginx的配置文件nginx.conf做备份: 2.新建目录/root/nginx,将安装包和脚本上传到该目录下: 二.平滑升级nginx 1.开始编译新版本的nginx cd ...

  9. 00036_private

    1.私有private 描述人.Person: 属性:年龄: 行为:说话:说出自己的年龄. class Person { int age; String name; public void show( ...

  10. Cocoa-Cocoa对象

    2.Cocoa对象 2.1 Objective-C是面向对象的语言 Objective-C和Java C++一样,有封装,继承,多态,重用.但是它不像C++那样有重载操作法.模版和多继承,也没有Jav ...