编写JMeter插件并不难,JMeter为开发者提供了一系列不同功能的抽象类和不同阶段的接口,我们只要继承或实现它们,重写对应的方法实现自定义的逻辑和功能,打包成jar包后放入ext目录下即能完成一个自定义的插件。
在启动JMeter的时候,JMeter会扫描ext目录下的jar包,并加载继承或实现了JMeter提供的抽象类和接口的自定义类,在各个运行阶段执行,从而实现JMeter的插件自定义功能。
在开发插件之前,我们先了解一下JMeter提供的常用抽象类和接口。
一、JMeter组件介绍
JMeter的组件大致可以分为GUI类组件和非GUI的逻辑功能类组件。
1. GUI类组件
我们在JMeter GUI中能够在测试计划(TestPlan)下添加的组件就是GUI类的组件,包括:
- ThreadGroup(线程组)
- Config(配置元件)
- Timer(定时器)
- PreProcessor(前置处理器)
- PostProcessor(后置处理器)
- Controller(逻辑控制器)
- Sampler(测试抽样器)
- Assertion(断言)
- Listener(监听器)
2. 非GUI的逻辑功能类组件
我们在JMeter中使用的Function(功能函数)就是属于这类组件。
二、插件的实现
一个GUI类的插件的实现一般包含两部分,第一部分为GUI的实现代码,另一部分为TestElement的实现代码,接下来将详细说明。
1. 插件的GUI实现
JMeter为GUI扩展提供了如下抽象类:
- AbstractSamplerGui
- AbstractAssertionGui
- AbstractConfigGui
- AbstractControllerGui
- AbstractPostProcessorGui
- AbstractPreProcessorGui
- AbstractVisualizer
- AbstractTimerGui
继承以上指定类别的一个GUI抽象类后,再重写以下的方法:
(1)getStaticLabel() / getResourceLabel()
此方法应返回表示插件的标题。
(2)创建GUI布局init()
例如:
private void init() {
setLayout(new BorderLayout());
setBorder(makeBorder());
Box box = Box.createVerticalBox();
box.add(makeTitlePanel());
box.add(makeSourcePanel());
add(box,BorderLayout.NORTH);
add(makeParameterPanel(),BorderLayout.CENTER);
}
其中setBorder(makeBorder())为设置标准的JMeter边界,makeTitlePanel()为添加标题窗格,通常这是添加到GUI中的第一件事。
(3)configure(TestElement el)
此方法是将数据设置到您的GUI元素中。其中此方法必须调用super.configure(el)。,这将为您填充一些数据,例如元素的名称等。例如:
public void configure(TestElement el) {
super.configure(el);
useHeaders.setSelected(el.getPropertyAsBoolean(RegexExtractor.USEHEADERS));
useBody.setSelected(!el.getPropertyAsBoolean(RegexExtractor.USEHEADERS));
regexField.setText(el.getPropertyAsString(RegexExtractor.REGEX));
templateField.setText(el.getPropertyAsString(RegexExtractor.TEMPLATE));
defaultField.setText(el.getPropertyAsString(RegexExtractor.DEFAULT));
matchNumberField.setText(el.getPropertyAsString(RegexExtractor.MATCH_NUM));
refNameField.setText(el.getPropertyAsString(RegexExtractor.REFNAME));
}
(4)modifyTestElement(TestElement el)
此方法是将数据从GUI元素移动到TestElement中。其中此方法必须调用super.configureTestElement(el)。,这将为您处理一些默认数据。例如:
public void modifyTestElement(TestElement el) {
super.configureTestElement(el);
el.setProperty(new BooleanProperty(RegexExtractor.USEHEADERS, useHeaders.isSelected()));
el.setProperty(RegexExtractor.MATCH_NUMBER, matchNumberField.getText());
if (el instanceof RegexExtractor) {
RegexExtractor regex = (RegexExtractor)el;
regex.setRefName(refNameField.getText());
regex.setRegex(regexField.getText());
regex.setTemplate(templateField.getText());
regex.setDefaultValue(defaultField.getText());
}
}
(5)createTestElement()
此方法是创建一个TestElement类的新实例,然后将它传递给modifyTestElement(TestElement el)方法,例如:
public TestElement createTestElement() {
RegexExtractor extractor = new RegexExtractor();
modifyTestElement(extractor);
return extractor;
}
完成以上五个步骤即已完成一个GUI代码的开发工作,接下来说明一下逻辑功能的实现部分。
2. 插件的逻辑功能实现
逻辑功能实现的类就是在GUI类中createTestElement()方法里创建的实例的TestElement类。GUI类和TestElement类就是通过createTestElement()、modifyTestElement()和configure()三个方法进行数据交互的。
不同类型的插件需要继承或实现不同的抽象类和接口,以下逐一讲解:
- ThreadGroup(线程组)
ThreadGroup插件需要继承AbstractThreadGroup抽象类,目的是控制线程的行为。
- Config(配置元件)
Config插件需要继承ConfigTestElement抽象类,目的是实现一些信息配置功能。
- Timer(定时器)
Timer插件需要继承AbstractTestElement抽象类,目的是实现对时间的控制功能。
- PreProcessor(前置处理器)
PreProcessor插件需要继承AbstractTestElement抽象类,目的是控制Sampler执行前的行为。
- PostProcessor(后置处理器)
PostProcessor插件需要继承AbstractTestElement抽象类,目的是控制Sampler执行后的行为。
- Controller(逻辑控制器)
Controller插件需要继承GenericController类,目的是控制Sampler的行为。
- Sampler(测试抽样器)
Sampler插件需要继承AbstractSampler抽象类,目的是实现Sampler的标题、测试数据、测试时间、测试结果等一系列测试过程中涉及的信息进行收集的功能。
- Assertion(断言)
Assertion插件需要继承AbstractTestElement抽象类,目的是实现对Sampler测试结果的断言功能。
- Listener(监听器)
Listener插件需要继承AbstractTestElement抽象类,目的是实现数据采集的功能。
我们自定义的TestElement子类只是继承对应的抽象类,往往还是不能满足我们自定义的功能实现,为了实现更多的特性和测试过程中不同阶段的行为控制,JMeter还为开发者提供了一系列接口,只要在继承TestElement抽象类的同时实现这些接口即能实现高自由度的功能定制。
三、TestElement子类可实现的常用接口说明
- ThreadListener
实现ThreadListener接口并重写threadStarted()方法和threadFinished()方法,可以分别控制线程开始时和线程结束后的行为。
- TestStateListener
实现TestStateListener接口并重写testStarted()方法和testEnded()方法,可以分别控制测试计划开始时和测试计划结束后的行为。
- SampleListener
实现SampleListener接口并重写sampleStarted(SampleEvent e)方法和sampleStopped(SampleEvent e)方法,可以分别控制Sampler执行开始时和Sampler执行结束后的行为;还有重写sampleOccurred(SampleEvent e),可以控制Sampler执行开始时和执行结束后的相同的行为。
- LoopIterationListener
实现LoopIterationListener接口并重写iterationStart(LoopIterationEvent iterEvent)方法,可以控制循环开始时的行为。
除了以上抽象类和接口外,JMeter还提供了一些公共方法来获取或设置部分数据。
四、Jmeter的一些公共方法
1. JmeterContextService
(1)JMeterContextService.getContext().getVariables():用过BeanShell或Groovy脚本的应该都非常熟悉vars.set()和vars.get()方法,此方法就是vars线程变量存取的代码版。
(2)JMeterContextService.getContext().getThread().getThreadName():获取当前运行的线程组的名称。
2. JMeterUtils
JMeterUtils.getJMeterHome():获取JmeterHome路径。
3. FileServer
FileServer.getFileServer().getScriptName():获取脚本的名称。
以上是我开开发插件中最常用的公共方法,当然Jmeter还有很多公共方法有待发掘。最后让我们来了解一下Jmeter的运行过程中都发生了什么吧。
五、Jmeter运行过程简述
- 通过jmeter.bat、jmeter.sh或直接通过jmeter命令启动jmeter,其实是通过java命令执行jmeter.jar包,入口文件就是org.apache.jmeter.NewDriver;
- 首先解析命令行参数,加载各种配置信息和各种初始化动作;
- 加载配置信息完成后,开始读取jmx脚本,将jmx文件解析为HashTree的一种数据结构的类;
- 随后创建JmeterEngine(其实就是一个线程),由JmeterEngine去执行测试,在执行测试前会先执行一系列的前置动作,其中就包括将 ${keyName} 和 ${functionName} 占位符替换为真实值的动作(也就是所说的参数化),前置动作执行完后就开始真正的测试执行,JMeter收集数据,大概的运行过程就是这样子了。