【Jmeter扩展开发】自定义Java请求

自定义Java请求

1. Java请求

1.1 Java请求简介

JMeter 内置支持了一系列的常用协议,例如 HTTP/HTTPS、FTP、JDBC、JMS、SOAP 和 TCP 等,可以直接通过编写脚本来支持相关协议的测试场景。除了这些协议之外,用户也可能需要进行一些其他标准协议的测试,或者某些情况下在标准协议基础上增加了定制化的内容,需要对定制后的协议进行测试。本文中介绍的 Java Sampler 扩展机制就是 JMeter 提供的一种可以轻松实现对新协议支持的方式。

1.2 Java请求的使用场景

Java请求可以用于以下场景:

  • 需要在JMeter中实现复杂的请求逻辑,例如需要调用多个Java类或方法,或者需要处理复杂的返回值。
  • 需要在JMeter中实现自定义的协议,或者Jmeter原生尚未支持的协议,例如需要调用自定义的协议或协议扩展。
  • 需要在JMeter中实现一些特殊的测试需求,例如需要调用第三方API或服务,或者需要处理一些特殊的返回值。
  • 不想写beanshell脚本,或者beanshell脚本无法满足需求。

2. Java请求的实现

2.1 工程创建

  1. 使用Maven的quickstart模板创建一个Maven项目
  2. 在pom.xml文件中添加以下依赖:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>

<groupId>com.wick.jmeter.demo</groupId>
<artifactId>jmeter-java-test</artifactId>
<version>1.0-SNAPSHOT</version>
<properties>
<java.version>1.8</java.version>
<jmeter.version>5.4.1</jmeter.version>
</properties>
<dependencies>
<dependency>
<groupId>org.apache.jmeter</groupId>
<artifactId>ApacheJMeter_java</artifactId>
<version>${jmeter.version}</version>
<scope>provided</scope>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-assembly-plugin</artifactId>
<version>3.3.0</version>
<configuration>
<descriptorRefs>
<descriptorRef>jar-with-dependencies</descriptorRef>
</descriptorRefs>
</configuration>
<executions>
<execution>
<phase>package</phase>
<goals>
<goal>single</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
</project>

2.2 代码实现

  1. 创建一个Java类,该类需要实现org.apache.jmeter.protocol.java.sampler.JavaSamplerClient接口,或者继承 org.apache.jmeter.protocol.java.sampler.AbstractJavaSamplerClient
  2. 在Java类中,实现/重写以下4个方法:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
package com.wick.jmeter.demo;

import org.apache.jmeter.config.Arguments;
import org.apache.jmeter.protocol.java.sampler.AbstractJavaSamplerClient;
import org.apache.jmeter.protocol.java.sampler.JavaSamplerContext;
import org.apache.jmeter.samplers.SampleResult;

/**
* @author: wick
* @date: 2024/8/3 09:58
* @description: jmeter自定义java请求
*/

public class CustomJavaRequestTest extends AbstractJavaSamplerClient {


/**
* 获取参数,此方法中配置的参数会在Jmeter的Java请求页面展示,
* @return 请求参数
*/
@Override
public Arguments getDefaultParameters() {
return super.getDefaultParameters();
}

/**
* 测试开始前做初始化,只会执行一次
* @param context Jmeter采样器上下文
*/
@Override
public void setupTest(JavaSamplerContext context) {
super.setupTest(context);
}

/**
* 测试结束后做清理,只会执行一次
* @param context Jmeter采样器上下文
*/
@Override
public void teardownTest(JavaSamplerContext context) {
super.teardownTest(context);
}

/**
* 采样器执行,执行多次,具体执行次数取决于此采样器所在的线程组配置
* @param context Jmeter采样器上下文
* @return 采样器结果
*/
public SampleResult runTest(JavaSamplerContext context) {
return null;
}
}

2.3 打包测试

  1. 打包jar,注意:需要将带有完整依赖的jar打包出来,否则运行时可能会报错
    1
    mvn clean package -T 4C -DskipTests
  2. 将jar放到 <jmeter安装路径>/lib/ext/ 目录下
  3. 重启Jmeter,在Jmeter中添加Java请求,并配置参数,运行测试

3. Java请求的配置

在JMeter中,可以通过以下步骤打开Java请求的配置界面:

  1. 在JMeter的测试计划中,右键单击要添加Java请求的线程组。
  2. 选择“添加” -> “采样器” -> “Java请求”。
  3. 在Java请求的配置界面中,可以设置以下参数:
  • 名称:Java请求的名称。
  • 类名:Java请求的类名。
  • 请求参数:Java请求中设置的参数。

4. Java请求完整代码

假设我们需要实现以下需求:请求一个http接口,但是需要对其中某个字段做Base64编码,然后将编码后的字段作为请求参数传递给http接口

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
package com.wick.jmeter.demo;

import com.thoughtworks.xstream.core.util.Base64Encoder;
import kong.unirest.Cookie;
import kong.unirest.HttpResponse;
import kong.unirest.JsonNode;
import kong.unirest.Unirest;
import org.apache.jmeter.config.Arguments;
import org.apache.jmeter.protocol.java.sampler.AbstractJavaSamplerClient;
import org.apache.jmeter.protocol.java.sampler.JavaSamplerContext;
import org.apache.jmeter.samplers.SampleResult;

import java.nio.charset.StandardCharsets;

/**
* @author: wick
* @date: 2024/8/3 09:58
* @description: jmeter自定义java请求
*/

public class CustomJavaRequestTest extends AbstractJavaSamplerClient {

/**
* 参数
*/
private final String PARAM_USERNAME = "username";
private final String PARAM_PASSWORD = "password";

/**
* 获取参数,此方法中配置的参数会在Jmeter的Java请求页面展示,
* @return 请求参数
*/
@Override
public Arguments getDefaultParameters() {
Arguments arguments = new Arguments();
arguments.addArgument(PARAM_USERNAME, "zhang_san");
arguments.addArgument(PARAM_PASSWORD, "1234");
return arguments;
}

/**
* 测试开始前做初始化,只会执行一次
* @param context Jmeter采样器上下文
*/
@Override
public void setupTest(JavaSamplerContext context) {
Unirest.config()
.defaultBaseUrl("https://httpbin.org/")
.connectTimeout(60000)
.addDefaultCookie(new Cookie("timestamp",String.valueOf(System.currentTimeMillis())));
}

/**
* 采样器执行,执行多次,具体执行次数取决于此采样器所在的线程组配置
* @param context Jmeter采样器上下文
* @return 采样器结果
*/
public SampleResult runTest(JavaSamplerContext context) {
String username = context.getParameter(PARAM_USERNAME);
String password = context.getParameter(PARAM_PASSWORD);
SampleResult result = new SampleResult();
result.sampleStart();
HttpResponse<JsonNode> response;
try {
response = Unirest.get("/get")
.queryString("username", username)
.queryString("password", new Base64Encoder().encode(password.getBytes()))
.asJson();
result.setSuccessful(response.isSuccess());
result.setSamplerData(response.getRequestSummary().getUrl());
result.setResponseCode(response.getStatusText());
result.setResponseHeaders(response.getHeaders().toString());
result.setResponseData(response.getBody().toString(), StandardCharsets.UTF_8.name());
}catch (Exception e){
result.setSuccessful(false);
result.setResponseData(e.getMessage(), StandardCharsets.UTF_8.name());
}
result.sampleEnd();
return result;
}

/**
* 测试结束后做清理,只会执行一次
* @param context Jmeter采样器上下文
*/
@Override
public void teardownTest(JavaSamplerContext context) {
Unirest.shutDown();
}

}

最后,在jmeter中添加Java请求,选中自己开发的请求类 com.wick.jmeter.demo.CustomJavaRequestTest 并配置参数,即可运行。