后置处理器之JSON提取器
测试环境
JMeter 5.4.1
插件介绍
JSON后置处理器(PostProcessor)允许使用 JSON Path 语法从JSON格式的响应中提取数据。类似正则表达式提取器,必须位于HTTP采样器、或者其它可以返回JSON数据的采样器下,作为子结点。
插件参数
Name
显示在脚本树结构中的名称
Apply to:
这用于可以生成子采样器的采样器,比如携带嵌套资源的HTTP采样器、邮件读取器或者由事务控制器控制的采样。
- Main sample only
仅适用于主采样 - Sub-samples only
仅适用于子采样 - Main sample and sub-samples
适用于主采样和子采样 - JMeter Variable Name to use
提取适用于命名变量的内容。
Names of created variables
由英文分号 ;分隔的变量名称,这些变量分别用于存储对应JSON-PATH表达提取的结果(必须匹配JSON-PATH表达式数量)。
JSON Path Expressions
由分号分号 ;分割的JSON-PATH表达式 (必须匹配变量的数量)
Default Values
如果对应变量的JSON-PATH表达式不返回任何结果时,对应变量的默认值,由英文分号 ;分隔(必须匹配变量的数量)
Match Numbers
对于每个JSON-PATH表达式,如果表达式查询到多个结果时,你可以选择提取那个值作为变量值。
- 0 表示随机(匹配数字的默认值)
- -1 提取所有结果,这些结果将存储到名为
<variable name>_N
的变量(N取值从1到提取结果的数量) - X 表示提取第X个结果。如果第X个结果不存在,则不会返回任何值,直接使用对应默认值作为变量。
这些匹配数字必须使用英文分号相隔,且匹配JSON-PATH表达式的数量。如果不配置匹配数字,默认使用0作为每个表达式的默认值。
注意:不管对应的JSON-PATH表达式能否查询到结果,程序都会将结果数(如果查询不到结果则设置为 0 )存储到变量 <variable name>_matchNr
中
Compute concatenation var
如果勾选,则表示如果对应表达式查询到多个结果,插件将使用 , 连接这些值并存储为命名为<variable name>_ALL
的变量中。
插件使用示例
其中登录请求返回类似如下信息
{"token":"73ab6c33c39a46c1b27ae314b7a7eb1e","userName":"测试","warehouseList":[{"warehouseCode":"001DSC","warehouseName":"测试仓库","areas":[{"zonegroupCode":"A1","zonegroupdescr":"A1区"},{"zonegroupCode":"A2","zonegroupdescr":"A2区"},{"zonegroupCode":"A3","zonegroupdescr":"A3区"},{"zonegroupCode":"A4","zonegroupdescr":"A4区"}]}],errorMsgPrams":["SUCCESS"]}
通过Debug PostProcessor观察到提取的相关变量值如下
JMeterVariables: areas=[{"zonegroupCode":"A1","zonegroupdescr":"A1区"},{"zonegroupCode":"A2","zonegroupdescr":"A2区"},{"zonegroupCode":"A3","zonegroupdescr":"A3区"},{"zonegroupCode":"A4","zonegroupdescr":"A4区"}] areas_matchNr=1 token=d50350c345824a95ba8e1e4d43270fff token_matchNr=1 zonegroupCode_1=A1 zonegroupCode_2=A2 zonegroupCode_3=A3 zonegroupCode_4=A4 zonegroupCode_5=A5 zonegroupCode_matchNr=5
JSON-PATH表达式介绍
JsonPath表达式可以使用点标记
$.store.book[0].title
或者括号标记
$['store']['book'][0]['title']
操作符
操作符 | 描述 |
$ |
需要查找的根元素。所有JSON PATH表达式都以这个开头 |
@ |
正被某个过滤谓词处理的当前节点(The current node being processed by a filter predicate) |
* |
通配符。可以表示一个名称或者数字 |
.. |
深度扫描。可以表示一个名称 |
.<name> |
获取子节点。 |
['<name>' (, '<name>')] |
括号标记的子结点或者子孙结点 |
[<number> (, <number>)] |
单个或多个数组索引。 |
[start:end] |
数组切片操作符。注意,不含end |
[?(<expression>)] |
过滤表达式,必须为boolean表达式 |
函数
可以在path表达式末尾调用函数--表达式输出即为函数的输入。常见函数如下
函数 | 描述 | 输出类型 |
min() | 获取数字数组的最小值。 | Double |
max() | 获取数字数组的最大值。 | Double |
avg() | 获取数字数组的平均值。 | Double |
stddev() | 获取数字数组的标准方差。 | Double |
length() | 获取数组长度 | Integer |
sum() | 获取数字数组的总和。 | Double |
append(X) | 添加一个元素到JSON-PATH表达式输出数组中 | 同输入 |
过滤器操作符
过滤器为用于过滤数组的逻辑表达式,一个典型的过滤器 [?(@.age > 18)]
,这里 @
代表正被处理的当前项。可以使用逻辑操作符 &&
和 ||
创建更复杂的过滤器。字符串文字必须用单引号或者双引号引起来,形如 ([?(@.color == 'blue')]
或者 [?(@.color == "blue")]
)
操作符 | 描述 |
== |
等于 |
!= |
不等于 |
< |
小于 |
<= |
小于等于 |
> |
大于 |
>= |
大于等于 |
=~ |
匹配正则表达式,形如[?(@.name =~ /foo.*?/i)] |
in |
包含于,形如 [?(@.size in ['S', 'M'])] |
nin |
不包含于 |
subsetof |
子集,形如 [?(@.sizes subsetof ['S', 'M', 'L'])] |
anyof |
操作符左侧值必须和右侧有交集(left has an intersection with right),形如[?(@.sizes anyof ['M', 'L'])] |
noneof |
操作符左侧值和右侧无交集 |
size |
操作符左侧数组或者字符串长度必须匹配右侧 |
empty |
操作符左侧必须为空数组或者字符串 |
JSON PATH示例
给定如下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 | 结果 |
$.store.book[*].author |
表示所有书籍的作者。 |
$..author |
表示所有作者 |
$.store.* |
所有东西--所有书籍和自行车。 |
$.store..price |
所有东西的价格 |
$..book[2] |
第三本书 |
$..book[-2] |
倒数第二本书 |
$..book[0,1] |
The first two books |
$..book[:2] |
索引为0到2(不含2)的所有书籍 |
$..book[1:2] |
索引为1到2(不含2)的所有书籍 |
$..book[-2:] |
最后两本书 |
$..book[2:] |
索引为2及其往后的所有书籍。 |
$..book[?(@.isbn)] |
携带isbn号的所有书籍 an ISBN number |
$.store.book[?(@.price < 10)] |
商店中价格低于10的所有书籍。 |
$..book[?(@.price <= $['expensive'])] |
所有非 "expensive"的书籍 |
$..book[?(@.author =~ /.*REES/i)] |
所有匹配正则表达式(忽略大小写)的书籍 |
$..* |
返回所有东西 |
$..book.length() |
书籍数量 |
参考连接
https://github.com/json-path/JsonPath
https://jmeter.apache.org/usermanual/component_reference.html#JSON_Extractor