JSONPath 解析 JSON 完整内容详解

Posted 2021-07-05 七月的小尾巴

前言

最近在玩JMeter，总所周知，大家都知道我们在请求接口之后，都需要加断言去验证我们所请求的接口是否成功还是失败，于是JMeter提供了断言的方法。今天我们主要讲的就是JMeter中的 Json 断言。Json断言是基于Jsonpath实现的，于是乎小余就去了解了一下Jsonpath的相关用法，以下是小余整理出来的一下资料，希望可以帮助到大家~

jsonpath的介绍

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

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

github上有它的应用: https://github.com/json-path/JsonPath

• JsonPath表达式总是以与XPath表达式结合使用XML文档相同的方式引用JSON结构。
• JsonPath中的“根成员对象”始终称为$，无论是对象还是数组。
• JsonPath表达式可以使用点表示法
• $.store.book [0].title
• 或括号表示法 $['store']['book'][0]['title']

jsonpath操作符：

操作	说明
$	查询根元素。这将启动所有路径表达式。
@	当前节点由过滤谓词处理。
*	通配符，必要时可用任何地方的名称或数字。
..	深层扫描。 必要时在任何地方可以使用名称。
.<name>	点，表示子节点
['<name>' (, '<name>')]	括号表示子项
[<number> (, <number>)]	数组索引或索引
[start:end]	数组切片操作
[?(<expression>)]	过滤表达式。 表达式必须求值为一个布尔值。

函数

函数可以在路径的尾部调用，函数的输出是路径表达式的输出，该函数的输出是由函数本身所决定的。

过滤器运算符
过滤器是用于筛选数组的逻辑表达式。一个典型的过滤器将是[?(@.age > 18)]，其中@表示正在处理的当前项目。 可以使用逻辑运算符&&和||创建更复杂的过滤器。 字符串文字必须用单引号或双引号括起来([?(@.color == ‘blue’)] 或者 [?(@.color == “blue”)]).

可能这么说有点抽象，下面我们以 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
}

阅读文档

使用JsonPath的最简单的最直接的方法是通过静态读取API。

String json = "...";
List<String> authors = JsonPath.read(json, "$.store.book[*].author");

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

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

String json = "...";
Object document = Configuration.defaultConfiguration().jsonProvider().parse(json);

String author0 = JsonPath.read(document, "$.store.book[0].author");
String author1 = JsonPath.read(document, "$.store.book[1].author");

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

何时返回

当在java中使用JsonPath时，重要的是要知道你在结果中期望什么类型。 JsonPath将自动尝试将结果转换为调用者预期的类型。

// 抛出 java.lang.ClassCastException 异常
List<String> list = JsonPath.parse(json).read("$.store.book[0].author")

// 正常
String author = JsonPath.parse(json).read("$.store.book[0].author")

当评估路径时，你需要理解路径确定的概念。路径是不确定的，它包含

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

不确定的路径总是返回一个列表（由当前的JsonProvider表示）。

默认情况下，MappingProvider SPI提供了一个简单的对象映射器。 这允许您指定所需的返回类型，MappingProvider将尝试执行映射。 在下面的示例中，演示了Long和Date之间的映射。

String json = "{\\"date_as_long\\" : 1411455611975}";
Date date = JsonPath.parse(json).read("$['date_as_long']", Date.class);

如果您将JsonPath配置为使用JacksonMappingProvider或GsonMappingProvider，您甚至可以将JsonPath输出直接映射到POJO中。

Book book = JsonPath.parse(json).read("$.store.book[0]", Book.class);

要获取完整的泛型类型信息，请使用TypeRef。

TypeRef<List<String>> typeRef = new TypeRef<List<String>>(){};
List<String> titles = JsonPath.parse(JSON_DOCUMENT).read("$.store.book[*].title", typeRef);

JMeter Json断言示例

上面讲了这么多，到了项目实战的时候了，我们以公司的分类接口为例，我们需要断言分类接口中返回的第一个品牌的名称，是否为 new_BRAND

下面是我们jmeter 中json断言的配置，
$.data[0].brandList[0].englishName

我们可以看到获取商品分类的接口请求成功啦~