JSONPath

1. JSONPath介绍

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

2. API

 package com.alibaba.fastjson;
 
 public class JSONPath {          
      //  求值，静态方法
      public static Object eval(Object rootObject, String path);
      
      // 计算Size，Map非空元素个数，对象非空元素个数，Collection的Size，数组的长度。其他无法求值返回-1
      public 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，否则返回false
      public static boolean set(Object rootObject, String path, Object value) {}

      // 在数组或者集合中添加元素
      public static boolean array_add(Object rootObject, String path, Object... values);
 }

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

3. 支持语法

JSONPATH	描述
$	根对象，例如$.name
@	当前对象，例如@.id
[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和数组
.	属性访问，例如$.name
*	对象的所有属性，例如$.leader.*
['key']	属性访问。例如$['name']
['key0','key1']	多个属性访问。例如$['id','name']

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

$.store.book[0].title

和

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

4. 语法示例

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

5. API 示例

5.1 例1

public void test_entity() throws Exception {
    Entity entity = new Entity(123, new Object());
    
   Assert.assertSame(entity.getValue(), JSON.eval(entity, "$.value")); 
   Assert.assertTrue(JSON.contains(entity, "$.value"));
   Assert.assertTrue(JSON.containsValue(entity, "$.id", 123));
   Assert.assertTrue(JSON.containsValue(entity, "$.value", entity.getValue())); 
   Assert.assertEquals(2, JSON.size(entity, "$"));
   Assert.assertEquals(0, JSON.size(new Object[], "$")); 
}

public static class Entity {
    private Integer id;
    private String name;
    private Object value;

    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 例2

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

    List<Entity> entities = new ArrayList<Entity>();
    entities.add(new Entity("wenshao"));
    entities.add(new Entity("ljw2083"));

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

5.3 例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("[1,2]", entities); // 返回下标为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 例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("[0:2]", entities); // 返回下标从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 例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 例6

根据属性值过滤条件判断是否返回对象

    Entity entity = new Entity(1001, "ljw2083");
    Assert.assertSame(entity , JSONPath.eval(entity, "[id = 1001]"));
    Assert.assertNull(JSONPath.eval(entity, "[id = 1002]"));

6. ODPS UDF

fastjson直接内置提供了可以注册到阿里ODPS的UDF函数。

6.1 json_extract

STRING json_extract(STRING jsonStr, STRING jsonPath);

6.2 json_contains

BOOLEAN json_contains(STRING jsonStr, STRING jsonPath);

6.3 json_contains_value

BOOLEAN json_contains_value(STRING jsonStr, STRING jsonPath, BIGINT value);
BOOLEAN json_contains_value(STRING jsonStr, STRING jsonPath, DOUBLE value);
BOOLEAN json_contains_value(STRING jsonStr, STRING jsonPath, STRING value);
BOOLEAN json_contains_value(STRING jsonStr, STRING jsonPath, BOOLEAN value);

6.4 json_size

BIGINT json_size(STRING jsonStr, STRING jsonPath);

6.5 json_set

STRING json_set(STRING jsonStr, STRING jsonPath, BIGINT value);
STRING json_set(STRING jsonStr, STRING jsonPath, DOUBLE value);
STRING json_set(STRING jsonStr, STRING jsonPath, STRING value);
STRING json_set(STRING jsonStr, STRING jsonPath, BOOLEAN value);

6.6 json_array_add

STRING json_array_add(STRING jsonStr, STRING jsonPath, BIGINT... values);
STRING json_array_add(STRING jsonStr, STRING jsonPath, DOUBLE... values);
STRING json_array_add(STRING jsonStr, STRING jsonPath, STRING... values);
STRING json_array_add(STRING jsonStr, STRING jsonPath, BOOLEAN... values);