Fastjson 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. 支援語法

##描述$根對象，例如$.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過濾，[key rlike 'regexpr']字串類型正規匹配過濾，[key in ('v0', 'v1')]IN過濾, 支援字串和數值類型 [key between 234 and 456]BETWEEN過濾, 支援數值類型，支援not between ##...##*#物件的所有屬性，例如$.leader.*['key']屬性存取。例如$['name']['key0','key1']多個屬性存取。例如$['id','name']#

以下兩種寫法的語意是相同的：

$.store.book[0].title

和

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

JSONPATH
例如$.departs[name like 'sz*']，通配符只支援% 
支援not like
例如departs[name like 'aa(.)*']，
正規語法為jdk的正規語法，支持not rlike
例如: 
$.departs[name in ('wenshao','Yako')] 
$.departs[id not in (101,102)]
例如: 
$.departs[id between 101 and 201]
$.departs[id not between 101 and 201]
$.departs[id not between 101 and 201]
#length() 或size()陣列長度。例如$.values.size() 
支援類型java.util.Map和java.util.Collection和數組
##屬性訪問，例如$ .name
deepScan屬性訪問，例如$..name
JSONPath語意#$ $[-1]$[:-2]$[1:]#$[1,2,3]
##根物件
最後元素
第1個至倒數第2個
第2個之後所有元素
#集合中1,2,3個元素

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; }
}

讀取集合多個元素的某個屬性

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));

傳回集合中多個元素

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));

以範圍傳回集合的子集

#

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));

透過條件過濾，傳回集合的子集

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));

根據屬性值過濾條件判斷是否返回對象，修改對象，數組屬性添加元素

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

Map root = Collections.singletonMap("company", //
                                    Collections.singletonMap("departs", //
                                                             Arrays.asList( //
                                                                            Collections.singletonMap("id",
                                                                                                     1001), //
                                                                            Collections.singletonMap("id",
                                                                                                     1002), //
                                                                            Collections.singletonMap("id", 1003) //
                                                             ) //
                                    ));

List<Object> ids = (List<Object>) JSONPath.eval(root, "$..id");
assertEquals(3, ids.size());
assertEquals(1001, ids.get(0));
assertEquals(1002, ids.get(1));
assertEquals(1003, ids.get(2));

←
→