基于 JMeter API 开发性能测试平台

2023-08-09 00:16 由空慧居士发表于 #其他

背景：

JMeter 是一个功能强大的性能测试工具，若开发一个性能测试平台，用它作为底层执行引擎在合适不过。如要使用其API，就不得不对JMeter 整个执行流程，常见的类有清楚的了解。

常用的 JMeter 类和功能的解释：

TestPlan 类：代表一个测试计划，它是性能测试的顶级元素。您可以使用它来设置全局的测试属性，如测试名称、线程组、监听器等。
ThreadGroup 类：代表线程组，它定义了并发执行的线程数、启动延迟时间、循环次数等。线程组是性能测试的基本单位，所有的线程都在线程组内执行。
LoopController 类：代表循环控制器，它定义了循环的次数或条件。可以将循环控制器添加到线程组中，以便在每个线程中执行多次循环。
HTTPSampler 类：代表 HTTP 请求采样器，用于发送 HTTP 请求。您可以设置请求的 URL、方法（GET、POST 等）、请求参数、请求头等。
StandardJMeterEngine 类：代表 JMeter 引擎，负责配置和执行测试计划。通过将测试计划配置给引擎，可以启动和执行性能测试。
JMeterUtils 类：提供了一些 JMeter 的实用方法和属性。通过加载 JMeter 属性文件并初始化本地设置，可以确保 JMeter API 的正确运行。

　　为了能够在代码中创建和配置测试计划、线程组、循环控制器和其他元素，以及执行性能测试，这些类的功能和方法是我们必须要熟悉的。掌握了这些类，那么利用jmeter如何编写性能测

试脚本是怎样的，我们也来回顾下：

JMeter 编写性能测试脚本的大致流程示意图：

创建测试计划（Test Plan） --> 添加线程组(Thread Group) --> 添加配置元件（Config Elements）--> 添加逻辑控制器（Logic Controllers) 

--> 添加取样器（Samplers）和断言（Assertions）--> 添加监听器（Listeners）--> 运行测试计划

源码实现方式：

(1) 环境初始化

需要在项目中引入上述JMeter核心API，这样我们才能使用 JMeter 提供的各种功能和类

import org.apache.jmeter.control.LoopController;
import org.apache.jmeter.engine.StandardJMeterEngine;
import org.apache.jmeter.protocol.http.sampler.HTTPSampler;
import org.apache.jmeter.testelement.TestPlan;
import org.apache.jmeter.threads.ThreadGroup;
import org.apache.jmeter.util.JMeterUtils;

(2) 环境初始化

JMeter API 在执行过程中，首先会读取 JMeter 软件安装目录文件下配置文件里的属性，所以我们要通过 JMeter API 读取指定的 JMeter 主配置文件的目录以及 JMeter 的安装目录，

其中环境初始化主要包括以下 2 个步骤：

通过 JMeterUtils.loadJMeterProperties 加载 JMeter 主配置文件 JMeter.properties，然后把 jmeter.properties 中的所有属性赋值给 JMeterUtils 对象，以便之后获取所需的配置；
设置 JMeter 的安装目录，JMeter API 会根据我们指定的目录加载脚本运行时需要的配置

JMeterUtils.loadJMeterProperties("jmeter.properties");
JMeterUtils.setJMeterHome(~/jemter)
JMeterUtils.initLocale();

(3) 创建测试计划

使用 TestPlan 类创建一个测试计划，并设置相关属性。

TestPlan testPlan = new TestPlan("My Test Plan");
testPlan.setProperty(TestElement.TEST_CLASS, TestPlan.class.getName());
testPlan.setProperty(TestElement.GUI_CLASS, TestPlanGui.class.getName());

(4) 创建 ThreadGroup

使用 ThreadGroup 类创建一个线程组，并设置相关属性，例如线程数、循环次数等

ThreadGroup threadGroup = new ThreadGroup();
threadGroup.setName("My Thread Group");
threadGroup.setNumThreads(10);
threadGroup.setRampUp(5);
threadGroup.setSamplerController(loopController);

(5) 创建循环控制器

这一步是一个可选项。我们在实际测试过程中，创建循环控制器是为了模拟一个用户多次进行同样操作的行为，不创建循环控制器则默认是只执行一次操作。循环控制器创建的代码如下：

    LoopController loopController = new LoopController();

    //设置循环次数，1 代表循环 1 次

    loopController.setLoops(1);

    loopController.setFirst(true);

    loopController.setProperty(TestElement.TEST_CLASS, LoopController.class.getName());

    loopController.setProperty(TestElement.GUI_CLASS, LoopControlPanel.class.getName());

    loopController.initialize()

(6) 创建 Sampler

使用 HTTPSampler 类创建一个 HTTP 请求采样器，并设置请求的 URL、方法等属性

HTTPSampler httpSampler = new HTTPSampler();
httpSampler.setDomain("example.com");
httpSampler.setPort(80);
httpSampler.setPath("/api/endpoint");
httpSampler.setMethod("GET");

(7) 创建结果收集器

结果收集器可以保存每次 Sampler 操作完成之后的结果的相关数据，例如，每次接口请求返回的状态、服务器响应的数据。

ResultCollector resultCollector = new ResultCollector();

resultCollector.setName(ResultCollector.class.getName());

(8) 构建 tree，生成 jmx 脚本

以上步骤其实都是为了创建了一个 HashTree 节点做准备。把创建都添加到子 HashTree 节点中，然后把子 HashTree 加到 testplan 中，最后再把 tesplan 节点加到构建好的父 HashTree 节点，这样就生成了我们的脚本可执行文件 jmx。代HashTree subTree = new HashTree(

    subTree.add(httpSamplerProxy);

    subTree.add(loopController);

    subTree.add(threadGroup);

    subTree.add(resultCollector);

    HashTree tree = new HashTree();

    tree.add(testPlan,subTree);

    SaveService.saveTree(tree, new FileOutputStream("test.jmx"));

} catch (IOException e) {

    e.printStackTrace();

}

通过以上代码就可以创建出 JMeter 可识别的 HashTree 结构，并且可以通过 saveTree 保存为 test.jmx 文件。如果是现成的jmx文件，可直接通过 HashTree jmxTree =

SaveService.loadTree(file); loadTree 会把 jmx 文件转成内存对象，并返回内存对象中生成的 HashTree。

(9) 测试执行

通过脚本文件的执行（测试执行），我们便可以开始对服务器发起请求，进行性能测试。测试执行主要包括 2 个步骤：

把可执行的测试文件加载到 StandardJMeterEngine；
通过 StandardJMeterEngine 的 run 方法执行，便实现了 Runable 的接口，其中 engine.run 执行的便是线程的 run 方法

StandardJMeterEngine engine = new StandardJMeterEngine();

engine.configure(jmxTree);

engine.run();

(10) 结果收集

　　JMeter API 提供了一个结果收集器（ResultCollector），用于收集和处理性能测试结果。它是 SampleListener 接口的一个实现类，可以监听每个测试样本的事件，并对测试结果进行

处理。我们可以重写 sampleOccurred 方法来收集每次 loop 的结果。该方法的参数 SampleEvent 中包含相应的测试结果。然后把测试结果数据存到消息队列里面，比如kafka ，后端获取存

储的实时采集数据，进行相应的计算，生成的数据返回给前端进行绘制展示。