Jmeter压测实战：Jmeter二次开发之JSF采样器实现-京东云开发者社区

### 1 前言

Jmeter是Apache基金会下的一款应用场景非常广的压力测试工具，具备轻量、高扩展性、分布式等特性。Jmeter已支持实现HTTP、FTP、JAVA、TCP、JDBC等多种采样器，方便对不同的接口类型进行请求测试及压力测试。如果被测试的接口Jmeter当前不支持，那就需要单独开发自定义采样器实现接口的请求调用，比如JSF这种京东自研的RPC类接口，或者京东JMQ消息队列接口。

本文介绍如何开发Jmeter自定义采样器，同时深刻理解Jmeter的插件化机制及高扩展性特性。

备注：JSF是京东自研的RPC服务框架，类似于开源的dubbo服务的分布式框架，具备轻量级，更佳的性能，兼容旧版本协议等优化特性。RPC框架负责屏蔽底层的传输方式（TCP或UDP）、序列号方式（XML/JSON/二进制）和通信细节，从而让程序员专注于业务的实现。

### 2 开发具备能力

本文Jmeter的二次开发，需要人员具备以下能力：

- Java基础开发（包括GUI API）
- Maven基本使用
- Jmeter基本使用

### 3 实战整体流程图

![](//img1.jcloudcs.com/developer.jdcloud.com/eae67839-7a4c-4d50-bcfa-94779207275b20220414140852.png)

### 4 采样器GUI实现

#### 4.1 新建项目

本次开发依赖版本

- JDK 1.8.0
- Maven 3.6.3
- Jmeter 5.4.3

新建maven项目，这里项目名为：JSF_Sampler

因为是基于Jmeter的扩展，需要依赖包Jmeter两个核心包，分别是：

- ApacheJMeter_core
- ApacheJMeter_java

这里还依赖了支持JSF调用的三方包
pom.xml文件核心配置如下

```xml
<groupId>com.jd.jmeter.jsf</groupId>
<artifactId>JSF_Sampler</artifactId>
<version>1.0-SNAPSHOT</version>
<properties>
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <jmeter-version>5.4.3</jmeter-version>
</properties>
<dependencies>

        <dependency>
            <groupId>org.apache.jmeter</groupId>
            <artifactId>ApacheJMeter_core</artifactId>
            <version>${jmeter-version}</version>
        </dependency>
       
        <dependency>
            <groupId>org.apache.jmeter</groupId>
            <artifactId>ApacheJMeter_java</artifactId>
            <version>${jmeter-version}</version>
        </dependency>
        <dependency>
       
            <groupId>com.jd.qa</groupId>
            <artifactId>selena-core</artifactId>
            <version>0.0.36-SNAPSHOT</version>
            <exclusions>
                <exclusion>
                    <artifactId>core-utils</artifactId>
                    <groupId>com.jd.qa</groupId>
                </exclusion>
            </exclusions>
        </dependency>
        <dependency>
            <groupId>com.jd.qa</groupId>
            <artifactId>core-utils</artifactId>
            <version>0.0.4.1-SNAPSHOT</version>
        </dependency>
    </dependencies>
```

#### 4.2 继承实现AbstractSamplerGui类

实现类依次实现以下几个步骤
1. 新建实现类并继承 AbstractSamplerGui
注意：实现类的包名必须包含xxx.gui.xxx，否则无法加载自定义的GUI实现类。
2. 初始化GUI组件，GUI使用Jmeter封装好的组件，界面元素包括：
杰夫接口名、杰夫别名、杰夫方法及入参
3. 同时需要重写以下几个方法
- getStaticLabel()
- createTestElement()
- modifyTestElement()
- configure()
- clearGui()

重写方法功能及实现代码如下：

```java
    /**
     * GUI中显示的sampler的名称
     */
    @Override
    public String getStaticLabel(){
        return "JSF Sampler";
    }
/**
 * 将界面中的数据设置到新建的sampler实例
 */
  @Override
    public TestElement createTestElement() {
        JsfSampler jsfSampler = new JsfSampler();
        this.setUpSamplerProp(jsfSampler);
        return jsfSampler;
    }
/**
 * 将界面中测试数据设置到新建的sampler实例
 */
    @Override
    public void modifyTestElement(TestElement testElement) {
        JsfSampler jsfSampler = (JsfSampler) testElement;
        this.setUpSamplerProp(jsfSampler);
    }
   /**
    * 界面与sampler之间的数据交换
    * 特别注意：一定要先调用父类的configure方法，会交换默认的一些数据
    */
    @Override
    public void configure(TestElement element) {
        super.configure(element);
        JsfSampler jsfSampler = (JsfSampler) element;
        this.interfaceField.setText(jsfSampler.getJsfInterfaceName());
        this.aliasField.setText(jsfSampler.getJsfAliasName());
        this.methodField.setText(jsfSampler.getJsfMethod());
        this.textMessage.setText(jsfSampler.getJsfBody());
    }
    /**
     * 界面reset时，可以显示默认值
     * 特别注意：一定要先调用父类的configure方法，会reset一些默认的数据
     */
    @Override
    public void clearGui() {
        super.clearGui();
        this.interfaceField.setText("com.jd.ldop.oms.api.order.OrderApi");
        this.aliasField.setText("oms-production");
        this.methodField.setText("receiveOrderInfo");
        this.textMessage.setText("{\n" +
                "\"preNum\":10,\n" +
                "\"customerCode\":\"010K258778\",\n" +
                "\"orderType\":\"0\"\n" +
                "}");
    }
```

最终GUI页面元素如下，即JSF接口四要素：接口名、别名、方法、入参

![](//img1.jcloudcs.com/developer.jdcloud.com/68341bb9-5f93-4acc-be36-c40adc49850a20220414141112.png)

### 5 采样器核心调用实现

#### 5.1 新建采样器实现类

- 新建实现类并继承 AbstractSampler，同时实现接口TestStateListener
- 注意：采样器实现类的包名必须包含xxx.functions.xxx，否则无法加载自定义的Sampler实现类。
- 实现Sampler参数属性getter、setter方法

#### 5.2 重写采样器核心方法

实现Sampler以下几个方法，具体方法实现见下方代码

- sample()
- testStarted()
- testStarted(String s)
- testEnded()
- testEnded(String s)

```java
    //以下四个方法空实现重写即可，但是必须要写，否则无法识别 
    @Override
    public void testStarted() {
    }
    @Override
    public void testStarted(String s) {
    }
    @Override
    public void testEnded() {
        this.testEnded("local");
    }
    @Override
    public void testEnded(String s) {
    }
 /**
  * 核心实现方法，此方法实现对被测接口的请求方法及返回处理
  * 其中，SampleResult封装了控制请求的发送、response结果处理的方法
  */
 @Override
    public SampleResult sample(Entry entry) {
        SampleResult sampleResult = new SampleResult();
        sampleResult.setSampleLabel(getName());
   //请求发送开始
        sampleResult.sampleStart();

String aliasName = getJsfAliasName().split(";")[0];
        String ip = getJsfAliasName().split(";")[1].split(":")[0];
        String port = getJsfAliasName().split(";")[1].split(":")[1];
        try {
//这里使用了封装好请求JSF的包，只需要传入JSF四要素即可
            JsfBuilder jsfBuilder = JsfBuilder
                    .builder()
                    .aliasName(aliasName)
                    .interfaceName(getJsfInterfaceName())
                    .methodName(getJsfMethod())
                    .prams(getJsfBody())
                    .ip(ip)
                    .port(port)
                    .build();
            String jsfRes = jsfBuilder.hr();
//请求发送结束
            sampleResult.sampleEnd();
//处理返回的response
            sampleResult.setSuccessful(true);
            sampleResult.setResponseCodeOK();
            sampleResult.setResponseCode("SUCCESS");
            sampleResult.setResponseMessage(jsfRes);
            sampleResult.setResponseData(jsfRes,null);
        } catch (BusinessException e) {
            sampleResult.sampleEnd();
            sampleResult.setSuccessful(false);
            sampleResult.setResponseCode("FAIL");
            sampleResult.setResponseMessage("Exception" + e);
            e.printStackTrace();
            log.error("JSF接口请求报错");
        }
        return sampleResult;
    }
```

#### 5.3 最终项目结构

![](//img1.jcloudcs.com/developer.jdcloud.com/19b0234d-7288-4a90-a2ec-0b13e3319b2620220414141238.png)

### 6 Jmeter加载扩展包

以上开发完成，打包此项目，注意这里的打包要包含依赖包。

#### 6.1 maven构建配置

```xml
<build>
        <finalName>${project.artifactId}</finalName>
        <defaultGoal>install</defaultGoal>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <configuration>
                    <source>1.8</source>
                    <target>1.8</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>
```

#### 6.2 项目打包

打包指令如下

```
mvn package -Dmaven.test.skip=true
```

![](//img1.jcloudcs.com/developer.jdcloud.com/33c19089-5d44-4926-aaa2-7a3ec621d2a820220414141354.png)

#### 6.3 Jmeter加载扩展包

将打包后的扩展包放置到Jmeter的ext目录：apache-jmeter-5.4.3/lib/ext/

![](//img1.jcloudcs.com/developer.jdcloud.com/f0c74a52-72e5-48cc-8b08-3841876bce8120220414141432.png)

启动Jmeter后，Jmeter会自动加载ext目录中的扩展包，可以从日志控制台看到初始化GUI日志

![](//img1.jcloudcs.com/developer.jdcloud.com/70ffee96-38e7-47d9-95cb-f6faf62d8bc420220414141444.png)

![](//img1.jcloudcs.com/developer.jdcloud.com/1d5510d7-7852-472b-9df8-a1b5d10e82ce20220414141458.png)

### 7 测试JSF调用

#### 7.1 新建采样器

新建线程组->新建采样器->JSF Sampler (本次新增的采样器)

![](//img1.jcloudcs.com/developer.jdcloud.com/08f959e5-4951-4241-aa8e-d2d19e7900ec20220414141518.png)

#### 7.2 配置采样器请求参数及结果树

配置JSF请求参数如下

![](//img1.jcloudcs.com/developer.jdcloud.com/3a78ae6a-8b04-478c-963b-0fcdd361399420220414141544.png)

#### 7.3 发送请求后查看结果树

发送请求后查看结果树

![](//img1.jcloudcs.com/developer.jdcloud.com/6ffaf193-1078-4524-868a-abd083445c2720220414141607.png)

### 8 总结

本文通过自定义采样器实现了JSF接口的调用，希望通过本项目大家可以学习到：
如何二次开发Jmeter，实现自己特有的采样器。
理解为何官方介绍Jmeter是插件化的，高扩展性特性。
更好的理解Jmeter内部处理机制。

### 9 思考

- Jmeter的HTTP采样器的实现方法是如何实现的
- 如何实现定制化Jmeter的HTTP采样器支持HTTPs

------------

###### 自猿其说Tech-JDL京东物流技术与数据智能部
###### 作者：苗浩冲