扩展JMeter实现自定义的函数

作者: XMeter性能测试云服务 | 来源:发表于2016-09-16 19:24 被阅读2723次

本文版权归xmeter.net 所有。欢迎转载，转载请注明出处。

简介###

JMeter作为Apache的项目允许使用者对其进行扩展，比如用户可以扩展自定义的function（function是可以让用户在编辑测试脚本的时候插入到任何Sampler或者测试元素中，可以执行一些任务，比如取得Agent所在机器的名字，IP地址，或者得到一个随机的字符串等，完整的JMeter提供的内置function列表，请参考官方文档）。

本文将以扩展一个返回随机偶数function的例子来了解整个过程。总体来说，扩展JMeter的function可以分成下面几个步骤：

在Eclipse中新建Maven项目，引入扩展JMeter function所需的依赖
编写实现自定义function的代码，并对其编译打包
将编译好的包拷贝至JMeter的扩展目录，编辑测试脚本，使用自定义function
运行查看自定义的function是否正确

创建扩展JMeter项目

在Eclipse中新建一个Maven项目，File > New > Project，选择Maven Project，如下图所示。

创建Maven项目--第一步

在向导的第二页里，选择"Create a simple project (skip archetype selection)，并点击下一步

创建Maven项目--第二步
在向导的第三页，输入Group Id和Artifact Id。点击Finish，完成向导。

创建Maven项目

通过Maven引入相应的JMeter库

打开pom.xml，加入JMeter的ApacheJMeter_core和ApacheJMeter_functions库依赖，如下图所示。

    <dependencies>
        <dependency>
            <groupId>org.apache.jmeter</groupId>
            <artifactId>ApacheJMeter_core</artifactId>
            <version>2.13</version>
        </dependency>
        <dependency>
            <groupId>org.apache.jmeter</groupId>
            <artifactId>ApacheJMeter_functions</artifactId>
            <version>2.13</version>
        </dependency>
    </dependencies>

保存pom.xml后，Maven开始下载相关的库文件，但是你可能会发现完成之后项目无法编译，无法编译的原因如下。

Maven报错
这是JMeter2.13里引入的一个bug，具体可以参考这个网址
解决的办法有两种，方法一是在你的Maven repository所在的目录，手工将commons-math3和commons-pool2所需要的文件拷贝到相应的目录下；方法二是在你的pom.xml文件里取消对两个JAR的引用，如果采用第二种方法，你的depency的配置如下：

<dependencies>
    <dependency>
        <groupId>org.apache.jmeter</groupId>
        <artifactId>ApacheJMeter_core</artifactId>
        <version>2.13</version>
        <exclusions>
            <exclusion>
                <artifactId>commons-math3</artifactId>
                <groupId>commons-math3</groupId>
            </exclusion>
            <exclusion>
                <artifactId>commons-pool2</artifactId>
                <groupId>commons-pool2</groupId>
            </exclusion>
        </exclusions>
    </dependency>
    <dependency>
        <groupId>org.apache.jmeter</groupId>
        <artifactId>ApacheJMeter_functions</artifactId>
        <version>2.13</version>
        <exclusions>
            <exclusion>
                <artifactId>commons-math3</artifactId>
                <groupId>commons-math3</groupId>
            </exclusion>
            <exclusion>
                <artifactId>commons-pool2</artifactId>
                <groupId>commons-pool2</groupId>
            </exclusion>
        </exclusions>
    </dependency>
</dependencies>

注：如果使用3.0版本就没有上述问题，直接使用ApacheJMeter_core和ApacheJMeter_functions就可以了

扩展JMeter function

要实现扩展JMeter function，主要有两点：

实现function的类的package声明必须包含".functions"
需要继承org.apache.jmeter.functions.AbstractFunction，并且实现相应的方法。

package名字

JMeter设计让一些核心的类（非UI相关的，比如ApacheJMeter_core等）可以在非UI的方式下运行的时候能被加载进来，这些类会被优先加载。加载这些类的时候是通过命名规则来实现的。所有实现function的类必需包含".functions."，所以我们自定义实现的类里必须包含".functions"，比如 "com.xmeter.customized.functions". 当然也可以通过更改jmeter.properties中的配置来实现改变命名规则，如下所示。但是一般来说不推荐更改此项配置。

classfinder.functions.contain=.functions.

扩展AbstractFunction类

AbstractFunction类提供了4个抽象方法，在扩展的时候需要实现他们。

public String execute(SampleResult previousResult, Sampler currentSampler) throws InvalidVariableException

JMeter会将上次运行的SampleResult和当前的Sampler作为参数传入到该方法里，返回值就是在运行该function后得到的值，以String类型返回。该方法如果操作了非线程安全的对象（比如文件），则需要将对该方法进行线程同步保护。

public void setParameters(Collection<CompoundVariable> parameters) throws InvalidVariableException;

这个方法在用于传递用户在执行过程当中传入的实际参数值。该方法在function没有参数情况下也会被调用。一般该方法传入的参数会被保存在类内全局变量里，并被后面调用的execute方法中使用到。

public String getReferenceKey();

这个就是function的名字。JMeter的命名规则是在方法名前面加入双下划线"__"。比如"__GetEven"，function的名字跟实现该类的类名应该一致，而且该名字应该以static final的方式在实现类中定义好，避免在运行的时候更改它。

public List<String> getArgumentDesc();

最后在你的实现类中还需要提供一个方法来告诉JMeter关于你实现的function的描述。

源代码实现

实现的源代码如下所示，重要的代码已经有注释。

package com.xmeter.functions;

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

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;

public class MyRandomFunc extends AbstractFunction{
    //自定义function的描述
    private static final List<String> desc = new LinkedList<String>();
    static {
        desc.add("Get a random int within specified parameter value.");
    }

    //function名称
    private static final String KEY = "__MyRandomFunc";

    private static final int MAX_PARA_COUNT = 1;
    private static final int MIN_PARA_COUNT = 1;

    //传入参数的值
    private Object[] values;

    private Random r = new Random();

    @Override
    public List<String> getArgumentDesc() {
        return desc;
    }

    @Override
    public String execute(SampleResult previousResult, Sampler currentSampler) throws InvalidVariableException {
        try {
            int max = new Integer(((CompoundVariable) values[0]).execute().trim());
            int val = r.nextInt(max);
            return String.valueOf(val);
        } catch(Exception ex) {
            throw new InvalidVariableException(ex);
        }
    }

    @Override
    public String getReferenceKey() {
        return KEY;
    }

    @Override
    public void setParameters(Collection<CompoundVariable> parameters) throws InvalidVariableException {
         checkParameterCount(parameters, MIN_PARA_COUNT, MAX_PARA_COUNT); //检查参数的个数是否正确
         values = parameters.toArray(); //将值存入类变量中
    }

}

编译并拷贝到JMeter扩展目录

接下来剩下的一步就是要把实现的类生成JAR包并且拷贝到JMeter的扩展目录。请参考以下的Maven建立的profile：由于ApacheJMeter_core和ApacheJMeter_functions已经在JMeter的运行时中，所以编译出来的JAR不需要包含它们。

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-compiler-plugin</artifactId>
            <version>3.1</version>
            <configuration>
                <source>1.7</source>
                <target>1.7</target>
            </configuration>
        </plugin>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-assembly-plugin</artifactId>
            <configuration>
                <descriptorRefs>
                    <descriptorRef>jar-with-dependencies</descriptorRef>
                </descriptorRefs>
            </configuration>
            <executions>
                <execution>
                    <id>assemble-all</id>
                    <phase>package</phase>
                    <goals>
                        <goal>single</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>
<profiles>
    <profile>
        <id>production</id>
        <dependencies>
            <dependency>
                <groupId>org.apache.jmeter</groupId>
                <artifactId>ApacheJMeter_core</artifactId>
                <version>2.13</version>
                <scope>provided</scope>
                <exclusions>
                    <exclusion>
                        <artifactId>commons-math3</artifactId>
                        <groupId>commons-math3</groupId>
                    </exclusion>
                    <exclusion>
                        <artifactId>commons-pool2</artifactId>
                        <groupId>commons-pool2</groupId>
                    </exclusion>
                </exclusions>
            </dependency>
            <dependency>
                <groupId>org.apache.jmeter</groupId>
                <artifactId>ApacheJMeter_functions</artifactId>
                <version>2.13</version>
                <scope>provided</scope>
                <exclusions>
                    <exclusion>
                        <artifactId>commons-math3</artifactId>
                        <groupId>commons-math3</groupId>
                    </exclusion>
                    <exclusion>
                        <artifactId>commons-pool2</artifactId>
                        <groupId>commons-pool2</groupId>
                    </exclusion>
                </exclusions>
            </dependency>
        </dependencies>
    </profile>

</profiles>

接下来在Eclipse中建立一个Maven build，请参见如下截图。

Maven设置

在运行"production"这个Maven Build之后，到工程的target目录下，会发现新生成了helloJMeter-0.0.1-SNAPSHOT-jar-with-dependencies.jar，现在可以把这个JAR拷贝至$JMETER__HOME/lib/ext目录下，重新启动JMeter。
点击Options > Function Help Dialog，如果配置正确的话就能出现自己定义的function，如下所示。点击右下角的“Generate”按钮，会生成调用该function的字符串。

JMeter截图1

测试自定义function

最后我们创建一个测试，来验证该function工作是否正常。下面以一个HTTP request为例，将自定义function生成的随机数传入HTTP请求中，因为参数传入了100，因此返回的值应该都是小于100的整数。

JMeter截图2

运行测试，如果一切正常，在服务器端应该就能看到由该function生成的随机整数了。

总结

本文介绍了如何利用JMeter的扩展性来实现自定义的function，通过这种方式，JMeter让使用者犹如拿着功能强大的瑞士军刀，随心所欲扩展出性能测试过程中所需要的功能。

参考文献

http://www.javacodegeeks.com/2013/06/jmeter-custom-function-implementation.html
http://jmeter.apache.org/usermanual/functions.html

关于我们##

XMeter成立于2016年，核心团队都来自于IBM，是一家领先技术的性能测试持续集成咨询与服务提供商。我们致力于提供给客户可靠,简单,低成本的性能测试解决方案。

网友评论

a0a0194a8157:大佬 CompoundVariable 是干啥的呀为啥object[] 要转成这个操作啊为啥我写的时候老是报空指针呢
XMeter性能测试云服务:你自定义function传入的值就是CompoundVariable类型的，空指针就是function没有参数值传进去吧。
644684178f0e:赞一个
a0a0194a8157:好气啊
XMeter性能测试云服务:@EH_58ae 可能有几个JAR下载比较慢，你手工把它下下来放到本地库里就可以了。不用Maven的话打包的时候麻烦，总体的工作其实都差不多。
a0a0194a8157:哥呀，能不能用这个傻逼maven啊搞了四个小时了还在走条干个啥都要走条。。
Tomandy:赞一个👍
熊一二:好

扩展JMeter实现自定义的函数

简介###

创建扩展JMeter项目

通过Maven引入相应的JMeter库

扩展JMeter function

package名字

扩展AbstractFunction类

源代码实现

编译并拷贝到JMeter扩展目录

测试自定义function

总结

参考文献

关于我们##

相关文章

网友评论

延伸阅读

深度阅读

栏目导航

热点阅读

Jmeter自动化测试

Apache JMeter

Jmeter