JMeter BeanShell Sampler与JMeter BeanShell断言

布满荆棘的人生 2023-10-18 20:24 142阅读 0赞

#### JMeter BeanShell Sampler与JMeter BeanShell断言 ####

*  前言
 *  1 BeanShell操作变量
 *  2 BeanShell引用外部资源
 *   *  2.1 引用java文件
     *  2.2 addClassPath
     *  2.3 引用jar包
 *  3 BeanShell断言
 *   *  3.1 校验JSONObject
     *  3.2 校验含JSONArray的JSON

## 前言 ##

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

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

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

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

<table> 
 <thead> 
  <tr> 
   <th>序号</th> 
   <th>名称</th> 
   <th>作用</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>1</td> 
   <td>vars.get(“variableName”)</td> 
   <td>根据变量名获取内存中的变量值，前提是这个值在脚本前文中已经定义并赋值</td> 
  </tr> 
  <tr> 
   <td>2</td> 
   <td>vars.put(“variableName”,“variableValue”)</td> 
   <td>将一个值存储到变量中，脚本下文中可以通过<code>${variableName}</code>引用</td> 
  </tr> 
  <tr> 
   <td>3</td> 
   <td>prev.getResponseDataAsString()</td> 
   <td>获取sampler（取样器）的响应数据并以String类型接收，用在【后置处理器】的【BeanShell PostProcessor中】</td> 
  </tr> 
  <tr> 
   <td><font>更多内置方法见：<a href="http://jmeter.apache.org/api/org/apache/jmeter/samplers/package-summary.html" rel="nofollow">JMeter API文档</a></font></td> 
   <td></td> 
   <td></td> 
  </tr> 
 </tbody> 
</table>

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

*  **JMeter逻辑控制器**：[https://blog.csdn.net/mu\_wind/article/details/91879280][https_blog.csdn.net_mu_wind_article_details_91879280]
 *  **JMeter配置元件**：[https://blog.csdn.net/mu\_wind/article/details/92796646][https_blog.csdn.net_mu_wind_article_details_92796646]
 *  **JMeter操作Mysql数据库**： [https://blog.csdn.net/mu\_wind/article/details/93312052][https_blog.csdn.net_mu_wind_article_details_93312052]
 *  **JMeter关联：正则表达式提取器与JSON提取器**：[https://blog.csdn.net/mu\_wind/article/details/93124113][https_blog.csdn.net_mu_wind_article_details_93124113]
 *  **JMeter Linux下执行测试**：[https://blog.csdn.net/mu\_wind/article/details/95733081][https_blog.csdn.net_mu_wind_article_details_95733081]
 *  **JMeter自定义日志与日志分析**：[https://blog.csdn.net/mu\_wind/article/details/95752633][https_blog.csdn.net_mu_wind_article_details_95752633]

## 1 BeanShell操作变量 ##

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

首先创建一个脚本，【用户定义的变量】中定义了一个变量，变量名为`paramIn`，值为`Mu`。  
![在这里插入图片描述][20200612123935730.png]  
【BeanShell Sampler】中写入下面语句：  
![在这里插入图片描述][20200612124107610.png]  
HTTP请求对【BeanShell Sampler】中`put`出的变量进行引用：  
![在这里插入图片描述][20200612124151981.png]  
运行脚本，查看结果树，可以看到变量引用成功：![在这里插入图片描述][20200612124529776.png]  
![在这里插入图片描述][20200612124649554.png]  
在BeanShell中直接写代码，方便快捷，在代码量不大的情况下十分便利。如果出于规范化考虑，尤其代码量较大时，为了使`BeanShell`看起来更清晰，可以按下面的方式写，效果是一样的：  
![在这里插入图片描述][20200612124942926.png]

// 定义一个方法
    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文件。  
![在这里插入图片描述][20200612140226731.png]

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

运行结果：  
![在这里插入图片描述][20200612140355297.png]  
要注意的是，如果引用的java文件中，又依赖了其他jar包，那么也需要将相应的jar包导入JMeter的安装目录的/lib/etc中并重启JMeter，引用.class和.jar也是同理。

### 2.2 addClassPath ###

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

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

### 2.3 引用jar包 ###

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

上面步骤完成后，BeanShell中直接import即可使用：  
![在这里插入图片描述][20200612151849268.png]

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

## 3 BeanShell断言 ##

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

例如下面的例子，登录失败，但没有添加断言，且接口响应码是200，所以接口被JMeter判定为成功。  
![在这里插入图片描述][2020061215225254.png]  
根据接口定义（一般由开发提供的接口文档定义），登录成功后，返回内容的message是“操作成功”，于是我们给接口添加一个【响应断言】  
![在这里插入图片描述][20200612152754177.png]  
再次运行，可以看到接口被判定为失败：  
![在这里插入图片描述][20200612152833829.png]  
对于这种校验比较简单的接口，【响应断言】能够满足要求，但遇到结果校验很复杂的接口，【响应断言】就无法胜任了，这时候就要用到【BeanShell断言】了。

### 3.1 校验JSONObject ###

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

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

1、首先，我们用BeanShell取样器模拟接口返回特定响应结果：  
![在这里插入图片描述][20200612193505332.png]  
假如这个数据是根据id=1（id是接口的一个入参）的条件获取的，那么我们就可以编写sql语句去数据库查询数据了。  
数据库中的数据：  
![在这里插入图片描述][20190625203936267.png]  
2、构造【JDBC Request】去获取数据库数据：  
![在这里插入图片描述][20200612204214177.png]  
【BeanShell断言】，**JSON处理用得是阿里的fastjson，jar包自行下载后放入JMeter的安装目录的/lib/etc中并重启JMeter**：  
![在这里插入图片描述][20200612193744704.png]  
运行后，查看结果：  
![在这里插入图片描述][20200612202832615.png]  
附上【BeanShell断言】代码

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}]}";

上面的数据，对应数据库里status=1的数据：  
![在这里插入图片描述][20190625212809523.png]  
针对这种需求，sql语句要修改一下：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L211X3dpbmQ_size_16_color_FFFFFF_t_70]  
这个接口结果校验的难点在于，接口数据与数据库数据的顺序不对应，且无法事先确定其顺序，如果直接对比两个JSONObject，由于JSONArray中元素顺序不同，会导致对比返回false，尽管两个JSONObject中的数据除了顺序，其他都相同。

要解决顺序问题，我想到的方案是对数据进行进一步加工，将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;
    }

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

1.  数据处理异常，可以人为将sql写错，例如：select price,size from test.goods where status=1（缺少name字段）;  
    ![在这里插入图片描述][20200612213457439.png]
2.  接口数据与数据库数据的数量不一致，可以将数据库数据篡改一下：  
    ![在这里插入图片描述][20190626110350718.png]  
    ![在这里插入图片描述][20200612213616671.png]
3.  数据库数据和接口响应数据数量一致，但内容不同  
    ![在这里插入图片描述][20190626110546474.png]  
    ![在这里插入图片描述][20200612221139759.png]
4.  数据库数据与接口响应数据一致，断言通过。  
    ![在这里插入图片描述][20200612221310266.png]  
    以上，是BeanShell的相关知识，后续还会更新更多的使用场景。

[https_blog.csdn.net_mu_wind_article_details_91879280]: https://blog.csdn.net/mu_wind/article/details/91879280
[https_blog.csdn.net_mu_wind_article_details_92796646]: https://blog.csdn.net/mu_wind/article/details/92796646
[https_blog.csdn.net_mu_wind_article_details_93312052]: https://blog.csdn.net/mu_wind/article/details/93312052
[https_blog.csdn.net_mu_wind_article_details_93124113]: https://blog.csdn.net/mu_wind/article/details/93124113
[https_blog.csdn.net_mu_wind_article_details_95733081]: https://blog.csdn.net/mu_wind/article/details/95733081
[https_blog.csdn.net_mu_wind_article_details_95752633]: https://blog.csdn.net/mu_wind/article/details/95752633
[20200612123935730.png]: https://img-blog.csdnimg.cn/20200612123935730.png
[20200612124107610.png]: https://img-blog.csdnimg.cn/20200612124107610.png
[20200612124151981.png]: https://img-blog.csdnimg.cn/20200612124151981.png
[20200612124529776.png]: https://img-blog.csdnimg.cn/20200612124529776.png
[20200612124649554.png]: https://img-blog.csdnimg.cn/20200612124649554.png
[20200612124942926.png]: https://img-blog.csdnimg.cn/20200612124942926.png
[20200612140226731.png]: https://img-blog.csdnimg.cn/20200612140226731.png
[20200612140355297.png]: https://img-blog.csdnimg.cn/20200612140355297.png
[20200612151257915.png]: https://img-blog.csdnimg.cn/20200612151257915.png
[20200612151849268.png]: https://img-blog.csdnimg.cn/20200612151849268.png
[2020061215225254.png]: https://img-blog.csdnimg.cn/2020061215225254.png
[20200612152754177.png]: https://img-blog.csdnimg.cn/20200612152754177.png
[20200612152833829.png]: https://img-blog.csdnimg.cn/20200612152833829.png
[20200612193505332.png]: https://img-blog.csdnimg.cn/20200612193505332.png
[20190625203936267.png]: https://img-blog.csdnimg.cn/20190625203936267.png
[20200612204214177.png]: https://img-blog.csdnimg.cn/20200612204214177.png
[20200612193744704.png]: https://img-blog.csdnimg.cn/20200612193744704.png
[20200612202832615.png]: https://img-blog.csdnimg.cn/20200612202832615.png
[20190625212809523.png]: https://img-blog.csdnimg.cn/20190625212809523.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L211X3dpbmQ_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20200612213356296.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L211X3dpbmQ=,size_16,color_FFFFFF,t_70
[20200612213457439.png]: https://img-blog.csdnimg.cn/20200612213457439.png
[20190626110350718.png]: https://img-blog.csdnimg.cn/20190626110350718.png
[20200612213616671.png]: https://img-blog.csdnimg.cn/20200612213616671.png
[20190626110546474.png]: https://img-blog.csdnimg.cn/20190626110546474.png
[20200612221139759.png]: https://img-blog.csdnimg.cn/20200612221139759.png
[20200612221310266.png]: https://img-blog.csdnimg.cn/20200612221310266.png