技术必备：推荐一款接口自动化测试数据校验神器

Posted 2021-06-24

大家好，我是狂师。

在之前分享中，给大家介绍过一篇：如何快速审核接口返回值全部字段解决方案，详见原文：接口自动化测试，一键快速校验接口返回值全部字段 。当时，提到解决这类问题，市面上常见的解决方案有两种：

• 根据业务校验需求，自定义开发校验规则库
• 借助现有的第三方库

而文章中介绍到的方案，就是借助现有的第三方库来实现：DeepDiff 。对于一些特殊业务或者复杂的测试场景来说，这类通用方案，总会有一些需求无法满足。因此往往还需要根据这类业务校验需求，自定义开发校验规则库。

我们今天不讲如何开发一款自定义开发校验规则库，而是给大家分享一款在开发自定义校验规则库或者常规的接口自动化测试时，经常会用到的一款数据提取神器：JSonPath。

1. JSonPath介绍

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

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

项目地址：

https://github.com/json-path/JsonPath

一句话概括：JsonPath就是用来解析提取Json数据用的。

2. JSonPath语法

JSONPath 是参照，Xpath表达式来解析XML文档的方式，JSON数据结构通常是匿名的并且不一定需要有根元素。JSONPaht 用一个抽象的名字$来表示最外层对象，即$ 代表整个JSON数据的值。

JSonpath的语法如下：jsonpath.jsonpath()

• 参数：json对象，jsonpath表达式

• 返回值：列表

JSONPath 表达式可以使用. 符号如下：

$.store.book[0].title

或者使用[] 符号

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

JSONPath 允许使用通配符 * 表示所以的子元素名和数组索引，还允许使用 \'..\' 。

表达式在下面的脚本语言中可以使用显示的名称或者索引：

$.store.book[(@.length-1)].title

使用\'@\'符号表示当前的对象，?(<判断表达式>) 使用逻辑表达式来过滤。

$.store.book[?(@.price > 100)].title

其中XPath和JSONPath语法区别如下:

需要额外注意的是：

• []在xpath表达式总是从前面的路径来操作数组，索引是从1开始。
• 使用JOSNPath的[]操作符操作一个对象或者数组，索引是从0开始。

3. JsonPath实战使用

安装：

pip install jsonpath

例如：待提取的json数据变量名为: json_datas。

json_datas = {"store": {
    "book": [
      { "category": "测试开发技术",
        "author": "狂师",
        "title": "关注公众号：测试开发技术",
        "price": 129
      },
      { "category": "自动化测试",
        "author": "狂师1",
        "title": "《自动化测试实战宝典》",
        "price": 109
      },
      { "category": "Python",
        "author": "狂师2",
        "title": "Python实战教程",
        "isbn": "0-110-234567-30",
        "price": 99
      },
      { "category": "Java",
        "author": "狂师3",
        "title": "小白学Java",
        "isbn": "0-13095-19295-8",
        "price": 89
      }
    ],
    "info": {
      "color": "red",
      "price": 88
    }
  }
}

1. 查找book下面所有的author

import jsonpath
datas = jsonpath.jsonpath(json_datas, \'$.store.book[*].author\')
print(datas)

输出结果为：[\'狂师\', \'狂师1\', \'狂师2\', \'狂师3\']

上述提取表达式，可以改为如下：

datas = jsonpath.jsonpath(json_datas, \'$..author\')
print(datas)

具备同等效果，输出所有author，结果同样为:[\'狂师\', \'狂师1\', \'狂师2\', \'狂师3\']

2. 查找store下面book所有节点数据

datas = jsonpath.jsonpath(json_datas, \'$.store.book.*\')
print(datas)

输出结果为：

[{\'category\': \'测试开发技术\', \'author\': \'狂师\', \'title\': \'关注公众号：测试开发技术\', \'price\': 129}, {\'category\': \'自动化测试\', \'author\': \'狂师1\', \'title\': \'《自动化测试实战宝典》\', \'price\': 109}, {\'category\': \'Python\', \'author\': \'狂师2\', \'title\': \'Python实战教程\', \'isbn\': \'0-110-234567-30\', \'price\': 99}, {\'category\': \'Java\', \'author\': \'狂师3\', \'title\': \'小白学Java\', \'isbn\': \'0-13095-19295-8\', \'price\': 89}]

3. 查找book下面第三个book

datas = jsonpath.jsonpath(json_datas, \'$.store.book[2]\')
print(datas)

输出结果为:

[{\'category\': \'Python\', \'author\': \'狂师2\', \'title\': \'Python实战教程\', \'isbn\': \'0-110-234567-30\', \'price\': 99}]

4. 查找book下面最后个book,返回的是一个列表

datas = jsonpath.jsonpath(json_datas, \'$.store.book[(@.length-1)]\')
print(datas)

输出结果：

[{\'category\': \'Java\', \'author\': \'狂师3\', \'title\': \'小白学Java\', \'isbn\': \'0-13095-19295-8\', \'price\': 89}]

5.查找 book下面前3本书

datas = jsonpath.jsonpath(json_datas, \'$.store.book[0,2]\')
print(datas)

输出结果为:

[{\'category\': \'测试开发技术\', \'author\': \'狂师\', \'title\': \'关注公众号：测试开发技术\', \'price\': 129}, {\'category\': \'Python\', \'author\': \'狂师2\', \'title\': \'Python实战教程\', \'isbn\': \'0-110-234567-30\', \'price\': 99}]

6. 查找所有的包含isbn这个键的所有book

datas = jsonpath.jsonpath(json_datas, \'$.store.book[?(@.isbn)]\')
print(datas)

输出结果为:

[{\'category\': \'Python\', \'author\': \'狂师2\', \'title\': \'Python实战教程\', \'isbn\': \'0-110-234567-30\', \'price\': 99}, {\'category\': \'Java\', \'author\': \'狂师3\', \'title\': \'小白学Java\', \'isbn\': \'0-13095-19295-8\', \'price\': 89}]

7. 查找价格大于100的所有书

datas = jsonpath.jsonpath(json_datas, \'$.store.book[?(@.price>100)]\')
print(datas)

输出结果：

[{\'category\': \'测试开发技术\', \'author\': \'狂师\', \'title\': \'关注公众号：测试开发技术\', \'price\': 129}, {\'category\': \'自动化测试\', \'author\': \'狂师1\', \'title\': \'《自动化测试实战宝典》\', \'price\': 109}]

4. 最后，JsonPath小技巧

最后再给大家推荐一个技巧，如果一开始对JSONPath表达式不太熟悉，可以将需要提取的JSON数据，通过jsonpath在线解析工具测试一下，在线解析JSONPath网址很多，例如：

http://www.e123456.com/aaaphp/online/jsonpath/

在接口自动化测试中，只有你懂得利用好JSONPath，那么至少可以让你在自动化测试数据提取这块，随心所欲的提取自己要想的数据。

好了，今天的干货分享就到这了，你学会了吗?