关于fastjson中JSONPath的使用

在项目中, 经常会涉及到对json字符串,进行查询, 添加,删除的处理操作. 传统方法需要一步一步进行处理,并且处理完需要将值进行封装. 而fastjson中提供的JSONPath, 可以更加简单的实现上述功能.

1 简介

JsonPath是一种简单的方法来提取给定JSON文档的部分内容, 提供的json解析非常强大，它提供了类似正则表达式的语法，基本上可以满足所有想要获得的json内容, 可以在java框架中当作对象查询语言来使用.

fastjson的jar包版本中,1.2.0之后的版本支持JSONPath。

2 API

package com.alibaba.fastjson;

public class JSONPath {          
     //  求值，静态方法
     public static Object eval(Object rootObject, String path);

     //  求值，静态方法，按需计算，性能更好
     public static Object extract(String json, 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 arrayAdd(Object rootObject, String path, Object... values);
     
     // 获取，Map的KeySet，对象非空属性的名称。数组、Collection等不支持类型返回null。
     public static Set<?> keySet(Object rootObject, String path);
}

如json串较多时,可考虑缓存JSONPath对象，能够提高求值的性能.

3 语法

格式	说明
$	根对象，例如$.id
[num]	数组访问，其中num是数字，可以是负数。例如$[0].id
[num0,num1,num2…]	数组多个元素访问，其中num是数字，可以是负数，返回数组中的多个元素。例如$[0,1,2]
[start:end]	数组范围访问，其中start和end是开始小表和结束下标，可以是负数，返回数组中的多个元素。例如$[0:2]
[start:end :step]	数组范围访问，其中start和end是开始小表和结束下标，可以是负数；step是步长，返回数组中的多个元素。例如$[0:4:2]
[?(key)]	对象属性非空过滤，例如$.student[?(id)]
[key = ‘123’]	字符串类型对象属性比较过滤，例如$.student[id = ‘123’]，比较操作符支持=,!=,>,>=,<,<=
[key > 123]	数值类型对象属性比较过滤，例如$.student[id >= 123]，比较操作符支持=,!=,>,>=,<,<=
[key like ‘aa%’]	字符串类型like过滤， 例如$.student[name like ‘sz*’]，通配符只支持% 支持not like
[key rlike ‘regexpr’]	字符串类型正则匹配过滤， 例如student[name rlike ‘aa(.)*’]， 正则语法为jdk的正则语法，支持not rlike
[key in (‘v0’, ‘v1’)]	IN过滤, 支持字符串和数值类型 例如: $.student[namein{(}^{\prime }wensha{o}^{\prime }{,}^{\prime }Yak{o}^{\prime })]<br/>$.student[id not in (101,102)]
[key between 234 and 456]	BETWEEN过滤, 支持数值类型，支持not between 例如: $.student[idbetween101and201]<br/>$.student[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’]

4 案例

json数据源

{
  "学校": {
    "清华": {
        "数学学院": {
          "学生": [
                          {"姓名": "李白",
                           "年龄": "26"},
                          {"姓名": "王维",
                           "年龄": "27"}
                       ],
         "老师": [
                          {"姓名": "老李",
                           "年龄": "62"},
                          {"姓名": "老王",
                           "年龄": "63"}
                       ]
        },
        "行政部门":{"部长": "老陈"}
      }
  }
}

测试案例:

public class MyJsonPathDemo {
    public static void main(String[] args) {
        // 自定义JSON字符串
        String str = "{\n" +
                "  \"学校\": {\n" +
                "    \"清华\": {\n" +
                "        \"数学学院\": {\n" +
                "          \"学生\": [\n" +
                "                          {\"姓名\": \"李白\",\n" +
                "                           \"年龄\": \"26\"},\n" +
                "                          {\"姓名\": \"王维\",\n" +
                "                           \"年龄\": \"27\"}\n" +
                "                       ],\n" +
                "         \"老师\": [\n" +
                "                          {\"姓名\": \"老李\",\n" +
                "                           \"年龄\": \"62\"},\n" +
                "                          {\"姓名\": \"老王\",\n" +
                "                           \"年龄\": \"63\"}\n" +
                "                       ]\n" +
                "        },\n" +
                "        \"行政部门\":{\"部长\": \"老陈\"}\n" +
                "      }\n" +
                "  }\n" +
                "}";

        JSONObject jsonObject = JSONObject.parseObject(str);
        System.out.println(jsonObject);

        // 设置值
        JSONPath.set(jsonObject,"$.学校.清华.行政部门.部长","老赵");
        System.out.println(jsonObject);

        // 是否包含值
        // 包含
        System.out.println(JSONPath.contains(jsonObject, "$.学校.清华.行政部门.部长"));
        // 不包含
        System.out.println(JSONPath.contains(jsonObject, "$.学校.清华.行政部门.部长.姓名"));

        // 删除值
        JSONPath.remove(jsonObject, "$.学校.清华.行政部门.部长");
        System.out.println(jsonObject);
        
        
    /*
    运行结果:
    {"学校":{"清华":{"行政部门":{"部长":"老陈"},"数学学院":{"学生":[{"姓名":"李白","年龄":"26"},{"姓名":"王维","年龄":"27"}],"老师":[{"姓名":"老李","年龄":"62"},{"姓名":"老王","年龄":"63"}]}}}}
    {"学校":{"清华":{"行政部门":{"部长":"老赵"},"数学学院":{"学生":[{"姓名":"李白","年龄":"26"},{"姓名":"王维","年龄":"27"}],"老师":[{"姓名":"老李","年龄":"62"},{"姓名":"老王","年龄":"63"}]}}}}
    true
    false
    {"学校":{"清华":{"行政部门":{},"数学学院":{"学生":[{"姓名":"李白","年龄":"26"},{"姓名":"王维","年龄":"27"}],"老师":[{"姓名":"老李","年龄":"62"},{"姓名":"老王","年龄":"63"}]}}}}
     */
    }

}