前言
JMeter为用户提供了AbstractJavaSamplerClient扩展类。用户只需继承该类，并重写相关的方法，理论上可以自定义任何请求的sampler。
参考资料：AbstractJavaSamplerClient(Apache JMeter API)
摘要
编写一个基于AbstractJavaSamplerClient扩展类的Java Sampler ，需要依赖5个来自JMeter接口：
Arguments ，
AbstractJavaSamplerClient，
JavaSamplerContext，
SampleResult，
JavaSamplerClient
AbstractJavaSamplerClient 接口
这是一个JavaSamplerClient接口的抽象类，以简化实现JavaSamplerClient接口功能的开发工作。在JavaSamplerClient接口中声明的的runTest（）方法没有写逻辑，因此要想实现自定义的java请求，必须要在AbstractJavaSamplerClient类上对runTest（）方法加入运行逻辑。为满足测试需求，必要时改写其他方法也很有帮助，涉及其他3个方法：getDefaultParameters()、setupTest()，teardownTest()。
getDefaultParameters()：用于设置传入的参数，可以设置多个，已设置的参数会显示到Java Sampler组件的请求参数列表中；
setupTest()：初始化方法，用于初始化性能测试时的每个线程，实际运行时每个线程仅执行一次；
runTest()：从JavaSamplerClient类继承的方法，性能测试时的线程执行的循环体，循环次数受所在线程组的设置决定，每次迭代此方法返回一个SampleResult对象；
teardownTest()：从JavaSamplerClient类继承的方法，测试结束方法，用于结束性能测试中的每个线程，实际运行时，每个线程仅执行一次。
JavaSamplerClient 接口
这个接口定义了JavaSampler和外部Java程序之间的交互，任何希望作为JMeter测试执行的Java类都可以引用这个接口或间通过AbstractJavaSamplerClient类。 Java测试应该扩展AbstractJavaSamplerClient类，而不是直接实现JavaSamplerClient类，以免将来JavaSamplerClient接口被官方更改。
JMeter会为测试执行中的每个用户/线程创建一个JavaSamplerClient实例，供JMeter内部使用。当JMeter测试脚本启动时，将在每个线程的JavaSamplerClient实例上调用setupTest（）方法来进行初始化工作，然后每个迭代调用runTest（）方法，最后调用teardownTest（）进行任何必要的清理。
通过getDefaultParameters（）方法定义默认参数列表中的参数和与这些参数相关联的任何默认值，都将显示在JMeter JavaSampler GUI中，并通过Java Sampler上下文传递给各种测试方法。
接口下常用方法：getDefaultParameters()、setupTest()、runTest()，teardownTest()。
JavaSamplerClient类源码：
package org.apache.jmeter.protocol.java.sampler;
import org.apache.jmeter.config.Arguments;
import org.apache.jmeter.samplers.SampleResult;
public interface JavaSamplerClient {
void setupTest(JavaSamplerContext var1);
SampleResult runTest(JavaSamplerContext var1);
void teardownTest(JavaSamplerContext var1);
Arguments getDefaultParameters();
}
SampleResult 接口
该接口封装了处理JMeter测试执行过程中各种返回信息的功能，
SampleResult有许多可以使用的字段，测试脚本至少应使用SampleResult.sampleStart和SampleResult.sampleEnd设置测试执行开始和结束时间，通过sampleLabel设置事务名，通过successful设置成功标志。
常用方法：，setResponseData() ，setDataType(SampleResult.TEXT)， SampleResult.sampleStart() ， SampleResult.sampleEnd()，SampleResult.setSuccessful(boolean)，SampleResult.setSampleLabel(String) 。
更多详情点击 SampleResult 了解。
Arguments 接口
该接口提供了一系列对参数对象进行操作的方法。
常用方法有addArgument()，getParameter()，更多详细描述点击Arguments 。
Arguments类源码：
该接口提供了一系列对参数对象进行操作的方法。
常用方法有addArgument()，getParameter()，更多详细描述点击Arguments 。
实例
把java 脚本打成jar包拷贝到JMeter的安装目录lib/ext下，启动JMeter即可通过Java Sampler使用，下图为一个java sampler的实例，在请求参数中按测试需求填写参数后，用法与JMeter常规的sampler一样。
image.png
参考模板
引入依赖：
<!-- JMeter Dependencies -->
<dependency>
<groupId>org.apache.jmeter</groupId>
<artifactId>ApacheJMeter_core</artifactId>
<version>3.3</version>
</dependency>
<dependency>
<groupId>org.apache.jmeter</groupId>
<artifactId>ApacheJMeter_java</artifactId>
<version>3.3</version>
</dependency>
实例参考模板：
import org.apache.jmeter.config.Arguments;
import org.apache.jmeter.protocol.java.sampler.AbstractJavaSamplerClient;
import org.apache.jmeter.protocol.java.sampler.JavaSamplerContext;
import org.apache.jmeter.samplers.SampleResult;
public class Test extends AbstractJavaSamplerClient {
// SampleResult类封装了从入口样本返回的各种信息
private SampleResult results;
private static long start = 0;
private static long end = 0;
//定义参数
private String request;
private String response;
/** 自定义java方法入参及默认值。 */
public Arguments getDefaultParameters() {
Arguments params = new Arguments(); // 声明定义对象名为params的Arguments类
params.addArgument("request", ""); // 新增一个名为request的参数
return params;
}
/** 每个线程执行前，进行一次初始化。 */
public void setupTest(JavaSamplerContext jsc) {
inNum = jsc.getParameter("request"); // 以String形式获取指定参数的值，或者如果未指定该值，则返回指定的默认值
}
/** 定义循环执行的压测功能。 */
public SampleResult runTest(JavaSamplerContext jsc) {
SampleResult result = new SampleResult(); // 定义SampleResult类
results.sampleStart(); // 开始计时
{
... //满足测试需求的执行逻辑
}
result.setSamplerData("Request : " + this.request, "utf-8"); //结果树中展示请求报文
result.setResponseData("Response : " + this.response, "utf-8"); //结果树中展示响应报文
return result;
}
// 测试结束方法，用于结束性能测试中的每个线程，实际运行时，每个线程仅执行一次，在测试方法运行结束后执行
public void teardownTest(JavaSamplerContext jsc) {
results.sampleEnd(); // 结束计时
super.teardownTest(jsc);
}
//可以添加main(String[] args)方法，在本地调试无误后，再把代码打成jar包放入JMeter的安装目录lib/ext下
}
网友评论