JSONPath 解析JSON完整内容详解

妖狐艹你老母 2023-09-25 12:53 57阅读 0赞

**前言**  
对于JMeter，大家都知道我们在请求接口之后，都需要加断言去验证我们所请求的接口是否成功还是失败，JMeter就提供了断言的方法。今天我们主要讲的就是JMeter中的 Json 断言。Json断言是基于Jsonpath实现的，阿俏就去了解了一下Jsonpath的相关用法，自己总结整理出来，希望可以帮助到大家  
**jsonpath的介绍**

JsonPath是一种简单的方法来提取给定JSON文档的部分内容。 JsonPath有许多编程语言，如Javascript，Python和PHP，Java。

JsonPath提供的json解析非常强大，它提供了类似正则表达式的语法，基本上可以满足所有你想要获得的json内容。

*  JsonPath表达式总是以与XPath表达式结合使用XML文档相同的方式引用JSON结构。
 *  JsonPath中的“根成员对象”始终称为$，无论是对象还是数组。
 *  JsonPath表达式可以使用点表示法
 *  $.store.book \[0\].title
 *  或括号表示法 $\[‘store’\]\[‘book’\]\[0\]\[‘title’\]  
    **jsonpath操作符：**  
    ![在这里插入图片描述][4f49ffbfc7bb42fba70820ab53fff2fb.png]  
    **函数**

函数可以在路径的尾部调用，函数的输出是路径表达式的输出，该函数的输出是由函数本身所决定的。  
![在这里插入图片描述][aae83b94b1f04380873b332370ceb9f4.png]  
**过滤器运算符**  
过滤器是用于筛选数组的逻辑表达式。一个典型的过滤器将是\[?(@.age > 18)\]，其中@表示正在处理的当前项目。 可以使用逻辑运算符&&和||创建更复杂的过滤器。 字符串文字必须用单引号或双引号括起来(\[?(@.color == ‘blue’)\] 或者 \[?(@.color == “blue”)\]).  
![在这里插入图片描述][16c877a1094c40fdbe02a5a550a543e5.png]  
实践：引入maven依赖，

<dependency>
    			<groupId>com.jayway.jsonpath</groupId>
    			<artifactId>json-path</artifactId>
    			<version>2.2.0</version>
    		</dependency>

下面我们以 GitHub 上提供的 Json 数据为例

{
        
        "store": {
        
            "book": [
                {
        
                    "category": "reference",
                    "author": "Nigel Rees",
                    "title": "Sayings of the Century",
                    "price": 8.95
                },
                {
        
                    "category": "fiction",
                    "author": "Evelyn Waugh",
                    "title": "Sword of Honour",
                    "price": 12.99
                },
                {
        
                    "category": "fiction",
                    "author": "Herman Melville",
                    "title": "Moby Dick",
                    "isbn": "0-553-21311-3",
                    "price": 8.99
                },
                {
        
                    "category": "fiction",
                    "author": "J. R. R. Tolkien",
                    "title": "The Lord of the Rings",
                    "isbn": "0-395-19395-8",
                    "price": 22.99
                }
            ],
            "bicycle": {
        
                "color": "red",
                "price": 19.95
            }
        },
        "expensive": 10
    }

![在这里插入图片描述][54ab5c5663084b5ea1990938a979b66d.png]  
使用JsonPath的最简单的最直接的方法是通过静态读取API。

/**
     * 需要解析的json串
     */
    String json = "....";
     
     
    /**
     * 读取json，这样的弊端就是每次都读取json，如果仅使用一次可以这样，多次使用不推荐
     * $.store.book[*].author 获取store下的book中author属性的值
     * "$..author" 获取store中author属性的值
     */
     List<String> authorsBook = JsonPath.read(json, "$.store.book[*].author");
     List<String> authorsAll = JsonPath.read(json, "$..author");
     System.out.println("authorsBook = " + authorsBook);
     //结果：authorsBook = ["Nigel Rees", "Evelyn Waugh", "Herman Melville", "J. R. R. Tolkien"]
     System.out.println("authorsAll = " + authorsAll);
     //结果：authorsAll = ["Nigel Rees", "Evelyn Waugh", "Herman Melville", "J. R. R. Tolkien", "test"]

如果你只想读取一次，那么上面的代码就可以了。

如果你还想读取其他路径，现在上面不是很好的方法，因为他每次获取都需要再解析整个文档。所以，我们可以先解析整个文档，再选择调用路径。

/**
     * 需要解析的json串
     */
    String json = "....";
     
    /**
     * 获取需要解析的json多次处理
     */
    Object document = Configuration.defaultConfiguration().jsonProvider().parse(json);
     
    String author0 = JsonPath.read(document, "$.store.book[0].author");
    System.out.println("author0 = " + author0);
    //结果：author0 = Nigel Rees
    String author1 = JsonPath.read(document, "$.store.book[1].author");
    System.out.println("author1 = " + author1);
    //结果：author1 = Evelyn Waugh

JsonPath还提供流畅的API。 这也是最灵活的一个。

String json = "...";
    ReadContext ctx = JsonPath.parse(json);
    
    List<String> authorsOfBooksWithISBN = ctx.read("$.store.book[?(@.isbn)].author");
    
    List<Map<String, Object>> expensiveBooks = JsonPath
                                .using(configuration)
                                .parse(json)
                                .read("$.store.book[?(@.price > 10)]", List.class);

**返回值类型**

1.  返回值可以为List、对象及时间类型等
2.  当在java中使用JsonPath时，重要的是要知道你在结果中期望什么类型。 JsonPath将自动尝试将结果转换为调用者预期的类型。

String testJson = "{\"date_as_long\" : 1411455611975}";
    /**
     * 返回值类型是时间对象
     * 结果：date = Tue Sep 23 15:00:11 CST 2014
     */
    Date date = JsonPath.parse(testJson).read("$['date_as_long']", Date.class);
    System.out.println("date = " + date);
     
    /**
     * 返回类型为实体对象
     * "$.store.book[0]" 获取store的book中的第一个
     * 结果:book = {category='reference', author='Nigel Rees', title='Sayings of the Century', price=8}
     */
    Book book = JsonPath.parse(json).read("$.store.book[0]",Book.class);
    System.out.println("book = " + book);
    
       //返回值类型为List
            List<Object> arr1 = JsonPath.read(document2,"$.store.book[*].author");
            System.out.println("arr1" + arr1);
            //获取store下的book中category和title的属性的值
            List<Object> arr2 = JsonPath.read(document2,"$.store.book[*].['category','title']");
            System.out.println("arr2" + arr2);

运行结果：  
![在这里插入图片描述][ebc8b214bff442aaadc7aa11eb0af765.png]  
当评估路径时，你需要理解路径确定的概念。路径是不确定的，它包含

*  `* ..：`深层扫描操作
 *  `* ?(<expression>)`：表达式
 *  `[<number>, <number> (, <number>)]`：多个数组索引

**断言**  
创建断言有三种方式  
**方式一**

/**
     * 断言，大白话就是通过表达式筛选出自己想要的数据
     * "$.store.book[?(@.price > 10)]" 从store的book筛选出price大于10
     * 结果： [{"category":"fiction","author":"Evelyn Waugh","title":"Sword of Honour","price":12.99},
     * {"category":"fiction","author":"J. R. R. Tolkien","title":"The Lord of the Rings`在这里插入代码片`","isbn":"0-395-19395-8","price":22.99}]
     */
    List<Map<String, Object>> expensiveBooks = JsonPath.parse(json)
            .read("$.store.book[?(@.price > 10)]");
    System.out.println("expensiveBooks = " + expensiveBooks);

**方式二**  
注意占位符？ 为路径中的过滤器。 当提供多个过滤器时，它们按照占位符数量与提供的过滤器数量相匹配的顺序应用。 您可以在一个过滤器操作\[？，？\]中指定多个谓词占位符，这两个谓词都必须匹配。

/**
     * 过滤器器断言
     * filter(where("category").is("fiction").and("price").lte(10D) 过滤出category=fiction并且price<=10
     */
    Filter one = filter(
            where("category").is("fiction").and("price").lte(10D)
    );
     
    Filter two = filter(
            where("category").is("fiction").and("price").lte(8D)
    );
     
    /**
     * 结果：result1 = [{"category":"fiction","author":"Herman Melville","title":"Moby Dick","isbn":"0-553-21311-3","price":8.99}]
     */
    List<Map<String, Object>> result1 =
            JsonPath.parse(json).read("$.store.book[?]", one);
    System.out.println("result1 = " + result1);
     
    /**
     * 结果：result2 = []
     */
    List<Map<String, Object>> result2 =
            JsonPath.parse(json).read("$.store.book[?,?]", one,two);
    System.out.println("result2 = " + result2);

**方式三**

自定义断言。
    /**
     * 自定义断言
     * "$.store.book[?].isbn" 查找store的book中isbn的属性值
     * 结果：books = ["0-553-21311-3","0-395-19395-8"]
     */
    Predicate booksWithISBN = new Predicate() {
        
        @Override
        public boolean apply(PredicateContext ctx) {
        
            return ctx.item(Map.class).containsKey("isbn");
        }
    };
     
    List<Map<String, Object>> books =
            JsonPath.parse(json).read("$.store.book[?].isbn", List.class, booksWithISBN);
    System.out.println("books = " + books);

**JMeter Json断言示例**  
上面讲了这么多，到了项目实战的时候了，我们以公司的分类接口为例，我们需要断言分类接口中返回的第一个品牌的名称，是否为 `sellcount`  
![在这里插入图片描述][6167b25dcf9b4beda1bcb99534d0e76b.png]下面是我们jmeter 中json断言的配置，`$.data[0].sellcount`  
![在这里插入图片描述][2f725e7916ad457db74add2b76a7cf26.png]  
我们可以看到搜索接口请求成功啦~

[4f49ffbfc7bb42fba70820ab53fff2fb.png]: https://img-blog.csdnimg.cn/4f49ffbfc7bb42fba70820ab53fff2fb.png
[aae83b94b1f04380873b332370ceb9f4.png]: https://img-blog.csdnimg.cn/aae83b94b1f04380873b332370ceb9f4.png
[16c877a1094c40fdbe02a5a550a543e5.png]: https://img-blog.csdnimg.cn/16c877a1094c40fdbe02a5a550a543e5.png
[54ab5c5663084b5ea1990938a979b66d.png]: https://img-blog.csdnimg.cn/54ab5c5663084b5ea1990938a979b66d.png
[ebc8b214bff442aaadc7aa11eb0af765.png]: https://img-blog.csdnimg.cn/ebc8b214bff442aaadc7aa11eb0af765.png
[6167b25dcf9b4beda1bcb99534d0e76b.png]: https://img-blog.csdnimg.cn/6167b25dcf9b4beda1bcb99534d0e76b.png
[2f725e7916ad457db74add2b76a7cf26.png]: https://img-blog.csdnimg.cn/2f725e7916ad457db74add2b76a7cf26.png