Jmeter函数分类及自定义开发

       Jmeter强大之处是其开源性和可扩展性，所以Jmeter拥有大量丰富的插件和元件，还有各种好用的函数，如果能巧妙应用函数助手里的函数，就能让性能测试脚本插上翅膀，实现各种复杂的计算和逻辑应用场景。

       以下是我整理的各个版本所启用的函数（可能也会有一点出入，欢迎大家指正），这些函数在不同的jmeter版本中启用，所以jmx脚本的兼容性一定要考虑到这些因素（如果函数一但不能被解析，就会出问题），以下列表只是说明了函数的作用，具体使用方法可以见Jmeter函数助手（主要是参数及相关格式要搞清楚）：

     除了Jmeter原装的函数，大家还喜欢用到第三方的JMeterPlugins插件，比如JMeterPlugins-ExtrasLibs，这里面还带一些扩展的函数，一般使用率不高，但是其中的__env获取环境变量，__chooseRandom随机选取值，我们用的也比较多：

      除了用到Jmeter自带的函数，以及JMeterPlugins插件所带有的函数，我们还可以进行自定义函数的开发：

      在package org.apache.jmeter.functions;中增加自定义函数，代码模板如下：

  

   

    

     

    
    

     

      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表示无入参
     
    
   

    

     

    
    

     

      	}	
     
    
   

    

     

    
    

     

      }
     
    
  

2、重构以上代码并打成jar包

（1）创建自定义函数__RandomEmail

  

   

    

     

    
    

     

      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;
     
    
   

    

     

    
    

     

          }
     
    
   

    

     

    
    

     

      }
     
    
  

（2）Maven Build生成jar包，

（3）将jar包拷贝至$JMETER__HOME/lib/ext目录下，重启Jmeter

3、在Jmeter的函数助手中看到新增的函数，并调试通过

4、具体代码我已发布，可以参考 https://gitee.com/smooth00/jmeter-ExtraFunc-plugins

代码结构：

  

   

    

     

    
    

     

      jmeter-ExtraFunc-plugins
     
    
   

    

     

    
    

     

      ├─src
     
    
   

    

     

    
    

     

      │  └─main
     
    
   

    

     

    
    

     

      │     ├─java
     
    
   

    

     

    
    

     

      │     └─resources
     
    
   

    

     

    
    

     

      ├─pom.xml
     
    
  

开发说明：

• 1、Jmeter插件必须在包含.functions包下
• 2、创建一个类，继承org.apache.jmeter.functions.AbstractFunction，重写下面方法：

  

   

    

     

    
    

     

      /** 函数执行逻辑，并返回值 */
     
    
   

    

     

    
    

     

      public String execute(SampleResult sampleResult, Sampler sampler);
     
    
   

    

     

    
    

     

      /** 接受处理入参 */
     
    
   

    

     

    
    

     

      public void setParameters(Collection
      <CompoundVariable> collection);
     
    
   

    

     

    
    

     

      /** 定义返回函数名称 */
     
    
   

    

     

    
    

     

      public String getReferenceKey();
     
    
   

    

     

    
    

     

      /** 定义函数入参说明 */
     
    
   

    

     

    
    

     

      public List
      <String> getArgumentDesc();