JMeter BeanShell Sampler与JMeter BeanShell断言

前言
1 BeanShell操作变量
2 BeanShell引用外部资源
3 BeanShell断言
- 3.1 校验JSONObject
- 3.2 校验含JSONArray的JSON

前言

BeanShell是一种完全符合Java语法规范的脚本语言，但又拥有一些独有的语法和方法。（当然，也有一些不一样的地方，比如 BeanShell就不支持Java中的泛型，当初也是一个深坑）。

BeanShell应用在JMeter的四个组件中：

BeanShell Sampler：BeanShell取样器，位于 Sampler（取样器）中，与常用的【HTTP请求】取样器性质类似，也是一个独立的取样器，会被【聚合报告】所统计。
BeanShell PreProcessor：BeanShell前置处理器，位于【前置处理器】中，作用于一个取样器上，且在取样器执行前执行，一般用于对取样器入参进行处理。
BeanShell PostProcessor：BeanShell前置处理器，位于【后置处理器】中，作用于一个取样器上，且在该取样器执行后执行，一般用于对取样器结果进行处理。
Beanshell Assertion：Beanshell 断言，位于【断言】中，作用于取样器上，且在该取样器执行后执行，用于对取样器响应结果进行断言。

介绍几个BeanShell常用的独有方法：

序号	名称	作用
1	vars.get(“variableName”)	根据变量名获取内存中的变量值，前提是这个值在脚本前文中已经定义并赋值
2	vars.put(“variableName”,“variableValue”)	将一个值存储到变量中，脚本下文中可以通过`${variableName}`引用
3	prev.getResponseDataAsString()	获取sampler（取样器）的响应数据并以String类型接收，用在【后置处理器】的【BeanShell PostProcessor中】
更多内置方法见：JMeter API文档

关于JMeter的使用，我花费一些精力写了JMeter的一系列文章，有图有案例，一方面总结起来作为备忘，一方面希望能给初学者一些帮助。觉得有所帮助的朋友，请点个赞，对于疏漏之处也欢迎指教。

JMeter逻辑控制器：https://blog.csdn.net/mu_wind/article/details/
JMeter配置元件：https://blog.csdn.net/mu_wind/article/details/
JMeter操作Mysql数据库： https://blog.csdn.net/mu_wind/article/details/
JMeter关联：正则表达式提取器与JSON提取器：https://blog.csdn.net/mu_wind/article/details/
JMeter Linux下执行测试：https://blog.csdn.net/mu_wind/article/details/
JMeter自定义日志与日志分析：https://blog.csdn.net/mu_wind/article/details/

1 BeanShell操作变量

前面说到了BeanShell的独有方法，vars.get和vars.put了，BeanShell对变量的操作主要就是依赖这两个方法。

首先创建一个脚本，【用户定义的变量】中定义了一个变量，变量名为paramIn，值为Mu。

【BeanShell Sampler】中写入下面语句：

HTTP请求对【BeanShell Sampler】中put出的变量进行引用：

运行脚本，查看结果树，可以看到变量引用成功：

在BeanShell中直接写代码，方便快捷，在代码量不大的情况下十分便利。如果出于规范化考虑，尤其代码量较大时，为了使BeanShell看起来更清晰，可以按下面的方式写，效果是一样的：
在这里插入图片描述

// 定义一个方法 public void test(){ 
    // vars.get 获取paramIn的值 String paramIn = vars.get("paramIn"); // 一个简单的字符串拼接 String string = "Hello," + paramIn; // vars.put()生成一个变量且赋值 vars.put("param",string); vars.put("paramOut",string + ",Welcome"); } // 需要主动调用函数，否则函数不会自动起作用 test();

2 BeanShell引用外部资源

如果JMeter脚本的代码量比较小，那么直接在将代码写在Beanshell中就可以了。如果代码量比较大，在Beanshell里写起来就比较困难，这时候可以考虑引用外部资源，包括引用.java文件、.class文件、.jar文件三种方式。

首先，我们写好这么一个类，类内的md5Encryption方法，是将一个字符串转化为一个经过MD5加密过的新字符串。

import java.security.MessageDigest; import java.security.NoSuchAlgorithmException; public class Md5Encryption { 
    public static String md5Encryption(String string) { 
    try { 
    MessageDigest md = MessageDigest.getInstance("MD5"); md.update(string.getBytes()); byte[] b = md.digest(); int i; StringBuffer buf = new StringBuffer(""); for (int offset = 0; offset < b.length; offset++) { 
    i = b[offset]; if (i < 0) i += 256; if (i < 16) buf.append("0"); buf.append(Integer.toHexString(i)); } return buf.toString(); } catch (NoSuchAlgorithmException e) { 
    e.printStackTrace(); return null; } } }

2.1 引用java文件

上面的代码在Md5Encryption.java文件中，JMeter支持直接引用java文件。
在这里插入图片描述

// 引用外部.java文件，注意路径中要使用"/" source("D:/Md5Encryption.java"); String passwordIni = ""; // 调用加密方法 String passwordEncryp = new Md5Encryption().md5Encryption(passwordIni); vars.put("passwordEncryp",passwordEncryp);

2.2 addClassPath

如果一个java文件不满足需求，那么可以把引用范围扩大到整个项目，如下，整个mutest项目src目录下的所有类都可以通过 import 方式引用：
在这里插入图片描述

// 添加路径：类所在项目的目录 addClassPath("E:/project/workspace/mutest/src"); // 引入 import mutest.Md5Encryption; String passwordIni = ""; // 调用加密方法 String passwordEncryp = new Md5Encryption().md5Encryption(passwordIni); vars.put("passwordEncryp",passwordEncryp);

2.3 引用jar包

前面两种方式呢，受外部影响太大，比如Md5Encryption被修改了，或者路径发生变化了，JMeter脚本都会受影响。为了规避这种影响，我们可以将项目打成jar包，导入JMeter安装目录\lib\etc中，并重启JMeter。

// import时带上类的包名 import mutest.Md5Encryption; String passwordIni = ""; // 调用加密方法 String passwordEncryp = new Md5Encryption().md5Encryption(passwordIni); vars.put("passwordEncryp",passwordEncryp);

3 BeanShell断言

接口测试中，所谓断言，是指用一定的判断规则对接口响应数据进行校验，不匹配则判定接口测试失败。在JMeter中，不加断言的话，默认校验接口的响应码。

3.1 校验JSONObject

首先使用【BeanShell Sampler】作为mock server返回这样的预期结果：

{ 
    "code" : 0, "goodsInfo" : { 
    "name" : "computer", "price" : 4500, "size" : 60 } }

import com.alibaba.fastjson.JSON; import com.alibaba.fastjson.JSONObject; // prev.getResponseDataAsString()方法获取接口响应数据 String goodsDataRes = prev.getResponseDataAsString(); // 将String解析成JSONObject并获取goodsInfo JSONObject goodsInfoRes = JSON.parseObject(goodsDataRes).getJSONObject("goodsInfo"); // 定义一个新的JSONObject用来存储数据库数据 JSONObject goodsInfoDb = new JSONObject(); try{ 
    goodsInfoDb.put("name",vars.get("name_1")); // 这里注意将数字转为int类型 goodsInfoDb.put("price",Integer.valueOf(vars.get("price_1"))); goodsInfoDb.put("size",Integer.valueOf(vars.get("size_1"))); if(!goodsInfoRes.equals(goodsInfoDb)){ 
    Failure = true; String message = "接口返回数据与数据库数据不一致！\n"; FailureMessage = message + "数据库内容: " + goodsInfoDb + "\n响应内容: " + goodsInfoRes; } }catch(Exception e){ 
    Failure = true; String message = "数据库数据为空！\n"; FailureMessage = message + "数据库内容: \n" + goodsInfoDb + "\n" + "响应内容: \n" + goodsInfoRes; }

3.2 校验含JSONArray的JSON

我们将问题复杂化一些，假如接口返回的是包含JSONArray的数据，如下：

{ 
    "code" : 0, "data" : [{ 
    "name" : "iphone", "price" : 6000, "size" : 55 }, { 
    "name" : "watch", "price" : 500, "size" : 35 },{ 
    "name" : "computer", "price" : 4500, "size" : 60 } ] }

return "{\"code\" : 0,\"data\" : [{\"name\" : \"iphone\",\"price\" : 6000,\"size\" : 55}, {\"name\" : \"watch\",\"price\" : 500,\"size\" : 35},{\"name\" : \"computer\",\"price\" : 4500,\"size\" : 60}]}";

要解决顺序问题，我想到的方案是对数据进行进一步加工，将JSONArray处理成JSONObject格式，这样就消除了顺序的影响（不含JSONArray的JSONObject的对比是不受元素顺序影响的），【BeanShell断言】内代码贴上：

import com.alibaba.fastjson.JSON; import com.alibaba.fastjson.JSONObject; import com.alibaba.fastjson.JSONArray; String goodsDataRes = prev.getResponseDataAsString(); JSONArray goodsListRes = JSON.parseObject(goodsDataRes).getJSONArray("data"); vars.put("goodsListRes",goodsListRes.toString()); JSONObject goodsInfoDb = new JSONObject(); JSONObject goodsInfoRes = new JSONObject(); try{ 
    for(int i = 1;i <= Integer.parseInt(vars.get("name_#"));i++){ 
    JSONObject goods = new JSONObject(); goods.put("name",vars.get("name_" + i)); goods.put("price",Integer.parseInt(vars.get("price_" + i))); goods.put("size",Integer.parseInt(vars.get("size_" + i))); goodsInfoDb.put(vars.get("name_" + i),goods); } for(int i = 0; i < goodsListRes.size();i++){ 
    JSONObject goods = goodsListRes.getJSONObject(i); goodsInfoRes.put(goods.getString("name"), goods); } if(goodsInfoRes.size() != goodsInfoDb.size()){ 
    Failure = true; String message = "接口返回数据与数据库数据的数量不一致！\n"; FailureMessage = message + "数据库数据数量: " + goodsInfoDb.size() + "\n响应数据数量: " + goodsInfoRes.size() + "\n数据库内容: " + goodsInfoDb + "\n响应内容: " + goodsInfoRes; }else if(!goodsInfoRes.equals(goodsInfoDb)){ 
    Failure = true; String message = "接口返回数据与数据库数据的内容不一致！\n"; FailureMessage = message + "数据库内容: " + goodsInfoDb + "\n响应内容: " + goodsInfoRes; } }catch(Exception e){ 
    Failure = true; String message = "数据处理异常！\n"; FailureMessage = message + "数据库内容: \n" + goodsInfoDb + "\n" + "响应内容: \n" + goodsInfoRes; }

使用这个断言，我们测试一下：

数据处理异常，可以人为将sql写错，例如：select price,size from test.goods where status=1（缺少name字段）;
接口数据与数据库数据的数量不一致，可以将数据库数据篡改一下：
数据库数据和接口响应数据数量一致，但内容不同
数据库数据与接口响应数据一致，断言通过。

以上，是BeanShell的相关知识，后续还会更新更多的使用场景。