Jmeter函数分类及自定义开发

package org.apache.jmeter.functions;

import java.util.Collection;
import java.util.LinkedList;
import java.util.List;

import org.apache.jmeter.engine.util.CompoundVariable;
import org.apache.jmeter.samplers.SampleResult;
import org.apache.jmeter.samplers.Sampler;

public class MyFrisFuncion extends AbstractFunction{
	private static final List<String> desc = new LinkedList<String>();
	public static void main(String[] args) {
		// TODO Auto-generated method stub

	}

	@Override
	public List<String> getArgumentDesc() {
		/**
		* Return a list of strings briefly describing each parameter your function
		* takes. Please use JMeterUtils.getResString(resource_name) to grab a
		* resource string. Otherwise, your help text will be difficult to
		* internationalize.
		*
		* This list is not optional. If you don't wish to write help, you must at
		* least return a List containing the correct number of blank strings, one
		* for each argument.
		* @return List with brief descriptions for each parameter the function takes
		*/
		//本方法简要描述函数的每个参数，使用JMeterUtils.getResString可获取中文资源字符串
		//中文描述资源文件路径为 bin/core/org/apache/jmeter/resources/messages_zh_CN.properties
		return desc;
	}
	
	@Override
	public String execute(SampleResult arg0, Sampler arg1) throws InvalidVariableException {
		/**
		* Given the previous SampleResult and the current Sampler, return a string
		* to use as a replacement value for the function call. Assume
		* "setParameter" was previously called.
		*
		* This method must be threadsafe - multiple threads will be using the same
		* object.
		* @param previousResult The previous {@link SampleResult}
		* @param currentSampler The current {@link Sampler}
		* @return The replacement value, which was generated by the function
		* @throws InvalidVariableException - when the variables for the function call can't be evaluated
		*/
		//本方法是提供一个在Jmeter调用的函数入口
		return "Jmeter函数";
	}
	
	@Override
	public String getReferenceKey() {
		/**
		* Return the name of your function. Convention is to prepend "__" to the
		* name (ie "__regexFunction")
		* @return The name of the function
		*/
		//本方法是提供一个在Jmeter函数助手显示的函数名称
		return "__NewFunction";
	}

	@Override
	public void setParameters(Collection<CompoundVariable> arg0) throws InvalidVariableException {
		/**
		* A collection of the parameters used to configure your function. Each
		* parameter is a CompoundVariable and can be resolved by calling the
		* execute() method of the CompoundVariable (which should be done at
		* execution.)
		*
		* @param parameters The parameters for the function call
		* @throws InvalidVariableException - when the variables for the function call can't be evaluated
		*/
		//本方法是设置函数参数使用的！checkParameterCount是校验参数数量
		//以下第2个参数为MIN_PARAM_COUNT，第3个参数为MAX_PARAM_COUNT，两者差值就是可选参数数量
		checkParameterCount(arg0, 0, 0); // 都是0表示无入参
	}	
}

package org.smooth.jmeter.functions;

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 org.smooth.jmeter.functions.core.RandomString;

import java.util.Collection;
import java.util.LinkedList;
import java.util.List;

/**
 * 随机生成电子邮箱
 * @author smooth
 * @date 2019-12-02 13:15
 */
@SuppressWarnings("unchecked")
public class RandomEmail extends AbstractFunction {

    @Override
    public String execute(SampleResult sampleResult, Sampler sampler) throws InvalidVariableException {
        return RandomString.getEmail();
    }

    @Override
    public void setParameters(Collection<CompoundVariable> collection) throws InvalidVariableException {
        checkParameterCount(collection, 0, 0);
    }
    /**
     * 提供jmeter函数助手显示的下来选项名称
     **/
    @Override
    public String getReferenceKey() {
        return "__RandomEmail";
    }

    public List<String> getArgumentDesc() {
        return new LinkedList();
    }
}

package org.smooth.jmeter.functions.core;

/**
 * @author smooth00
 * @date 2019-12-02 11:21
 */
public class RandomString {

    /** 普遍随机字符串来源 */
    private static final String[] SOURCE_STRING = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789".split("|");
    /** 常用邮箱后缀 */
    private static final String EMAIL_SUFFIX = "@gmail.com, @yahoo.com, @msn.com, @hotmail.com, @aol.com, @ask.com, @live.com, @qq.com, @0355.net, @163.com, @163.net, @263.net, @3721.net, @yeah.net, @googlemail.com, @126.com, @sina.com, @sohu.com, @yahoo.com.cn";

     /**
     * 获取0到指定数值间的随机数，内部使用
     * @param max
     * @return
     */
    private static int getRandomNum(int max) {
        if (max < 0) {
            throw new RuntimeException("最大值需要大于或等于0");
        }
        return (int) (Math.random() * max);
    }

    /**
     * 返回[0-9,a-z,A-Z]的随机字符串
     * @param len 字符串长度
     * @return
     */
    public static String getFixed(int len) {
        StringBuilder resBuf = new StringBuilder();
        for (int i = 0; i < len; i++) {
            int randIndex = getRandomNum(SOURCE_STRING.length);
            resBuf.append(SOURCE_STRING[randIndex]);
        }
        return resBuf.toString();
    }

    /**
     * 生成随机指定范围的定长字符串
     *
     * @param src 产生随机字符串来源，使用英文逗号分开
     * @param len 返回字符串长度
     * @return
     */
    public static final String getRange(String src, int len) {
        if (src == null || src.length() == 0) {
            throw new RuntimeException("来源字符串为空");
        }
        if (len < 1) {
            throw new RuntimeException("返回字符串长度需要大于0");
        }
        String[] arr = src.split(",");
        StringBuffer buf = new StringBuffer();
        for (int i = 0; i < len; i++) {
            int index = getRandomNum(arr.length);
            buf.append(arr[index].trim());
        }
        return buf.toString();
    }

    /**
     * 生成随机电子邮箱
     * @return
     */
    public static String getEmail() {
        // 生成用户名 6-16 位长度
        int len = getRandomNum(10) + 6;
        String userName = getFixed(len).toLowerCase();
        String email = getRange(EMAIL_SUFFIX, 1);
        return userName + email;
    }
}

jmeter-ExtraFunc-plugins
├─src
│  └─main
│     ├─java
│     └─resources
├─pom.xml

/** 函数执行逻辑，并返回值 */
public String execute(SampleResult sampleResult, Sampler sampler);
/** 接受处理入参 */
public void setParameters(Collection<CompoundVariable> collection);
/** 定义返回函数名称 */
public String getReferenceKey();
/** 定义函数入参说明 */
public List<String> getArgumentDesc();