如何通过自己编写Jmeter函数

在Jmeter的函数助手里，有很多内置的函数，比如Random、UUID、time等等。使用这些函数可以快速帮我们生成某些数据，进行一些逻辑处理。用起来非常的方便。

但是在实际接口测试过程中，有很多的需求，Jmeter内置的函数可能并不能满足我们的需求。这个时候我们可以通过自己编写代码，扩展Jmeter的内置函数。

比如现在想在Jmeter里添加一个简单的求和的函数，代码逻辑非常简单，大体代码如下：

public int sum(int a, int b){
return a + b;
}

接下来来看下如何把自定义的逻辑封装为Jmeter的内置函数。

01、创建新建工程

在idea中新建Java工程，然后把Jmeter的核心jar包ApacheJMeter_core.jar（在jmeter的lib/ext目录下可以找到）导入到工程中
在这里插入图片描述
在src目录下新建package，需要注意的是package的名字必须包含".functions"，比如"com.mtx.jmeter.functions"，JMeter设计让一些核心的类可以在非UI的方式下运行的时候能被加载进来，这些类会被优先加载。加载这些类的时候是通过命名规则来实现的。所有实现function的类必需包含".functions"，否则自定义的函数不会生效。

02、创建自定义函数类

新建一个类，继承Jmeter的抽象类AbstractFunction。在函数类里，需要定义以下属性和方法：

属性

自定义函数的参数名称列表，List类型

自定义函数的名称，String类型

保存用户输入数据的数组，CompoundVariable[]类型

方法

execute：执行函数的逻辑

setParameters：获取用户输入的参数

getReferenceKey：返回自定义函数的名称

getArgumentDesc：返回自定义函数所有的参数名描述

具体代码如下

import org.apache.jmeter.engine.util.CompoundVariable;

import org.apache.jmeter.functions.AbstractFunction;
import org.apache.jmeter.functions.InvalidVariableException;
import org.apache.jmeter.samplers.SampleResult;
import org.apache.jmeter.samplers.Sampler;
import java.util.Collection;
import java.util.LinkedList;
import java.util.List;


public class CalcFunction extends AbstractFunction {
    // 函数助手展示出来的参数列表
    private static final List<String> desc = new LinkedList<String>();


    // 在函数助手中展示出来的名字
    private static final String KEY = "__sum";


    // 定义数组接收jmeter函数助手输入的参数
    private CompoundVariable[] values;


    // 静态代码块，定义每个参数的描述，类加载的时候执行
    static {
        desc.add("数字1");
        desc.add("数字2");
    }


    /**
     * 自定义函数逻辑处理
     * @param sampleResult
     * @param sampler
     * @return
     * @throws InvalidVariableException
     */


    @Override
    public String execute(SampleResult sampleResult, Sampler sampler) throws InvalidVariableException {
        String numStr1 =  values[0].execute().trim();
        String numStr2 = values[1].execute().trim();
        int result = Integer.parseInt(numStr1) + Integer.parseInt(numStr2);
        return String.valueOf(result);
    }


    /**
     * 获取用户输入的参数值，并保存至CompoundVariable[]中
     * @param collection
     * @throws InvalidVariableException
     */


    @Override
    public void setParameters(Collection<CompoundVariable> collection) throws InvalidVariableException {


        // 检查用户输入参数是否正确，(2,2)代表参数数量最少为2个，最大也是2个
        checkParameterCount(collection,2,2);
        values = collection.toArray(new CompoundVariable[collection.size()]);


    }


    /**
     * 给Jmeter返回自定义函数的名称
     * @return
     */


    @Override
    public String getReferenceKey() {
        return KEY;
    }
    /**
     * 给Jmeter返回自定义函数的参数名称描述
     * @return
     */
    @Override
    public List<String> getArgumentDesc() {
        return desc;
    }
}

03、将代码导出为jar包

在idea中设置工程的归档品artifacts，然后通过build，将代码导出为jar包，然后放到Jmeter的lib/ext目录下，再启动Jmeter。

函数助手中可以看到刚才的函数名称和参数。
在这里插入图片描述
输入参数，运行函数，就可以看到计算结果。