## 前言

对基于 TCP/IP 协议的套接字应用进行性能测试是非常常见的测试场景。JMeter 提供的“TCP 取样器”大部分情况下可以满足测试的需求，但是也有它的局限性。如果希望实现更灵活的 TCP 套接字测试方式，可以通过对 JMeter 内置的 TCP 取样器进行扩展开发来实现。

## JMeter TCP 取样器的实现

[![1](http://img.blog.itpub.net/blog/2022/12/01/f5a284b13366c727.png?x-oss-process=style/bb "1")](https://www.emqx.com/zh/blog/jmeter-tcp "1")

在使用 JMeter TCP 取样器时，可以指定 TCPClient 接口的扩展类名，以切换不同的实现。如果不指定，JMeter 默认使用的是 org.apache.jmeter.protocol.tcp.sampler.TCPClientImpl。除了 TCPClientImpl，JMeter 还提供了另外两个实现，分别是 BinaryTCPClientImpl 和 LengthPrefixedBinaryTCPClientImpl，用于处理二进制格式的数据。其中：

- 使用 BinaryTCPClientImpl 时，文本框中应输入十六进制字符内容，该实现将十六进制转换为对应二进制的字节内容后进行发送。
- 使用 LengthPrefixedBinaryTCPClientImpl 时，使用字节流的前两个或前四个字节存放消息的长度，通过该前缀长度值来确定字节流的结束位置。

实现 TCPClient 接口来增加新的 TCP 取样方式，是扩展 TCP 取样器的一种方法。

但是如果我们需要对 TCP 取样器做一个通用的修改，例如，现在的 TCP 取样器在读取服务器端返回的响应时，会以“行尾 EOL 字节值”中指定的字节作为结束符，来确定读取的结束位置；不过这种设计就不适用于没有明确终止符，只有固定长度的返回响应。仅增加 TCPClient 接口的实现还不足以实现类似的需求，接下来将示例介绍如何进行改造，使得 TCP 取样器除了指定结束符，还能支持指定返回字节流的长度。

## 实现效果

先看一下修改后的效果。在“行尾EOL字节值”之后增加了一个“响应长度”的字段，举例来说，下图中指定了响应长度为12字节，如果服务器返回的是"Echo: hello\n"（其中"\n"是回车符），那么总长度就是12字节，也就是会读取到回车符之后停止。如果“行尾EOL字节值”和“响应长度”同时设置的话，将优先使用“行尾EOL字节值”的配置。

[![2](http://img.blog.itpub.net/blog/2022/12/01/8b3a733f83486824.png?x-oss-process=style/bb "2")](https://www.emqx.com/zh/blog/jmeter-tcp "2")

## 准备开发环境

首先，从 JMeter 官网下载所使用的 JMeter 对应的[源代码](https://jmeter.apache.org/download_jmeter.cgi)。

JMeter 对 TCP 协议的支持都放在了 protocol/tcp 目录下，因此本次开发的所做的更改都集中于该目录，如下图所示：

[![3](http://img.blog.itpub.net/blog/2022/12/01/62e18b9b1e1852b6.png?x-oss-process=style/bb "3")](https://www.emqx.com/zh/blog/jmeter-tcp "3")

整体方法与前文 [JMeter 扩展插件实现对自定义协议进行支持](https://www.emqx.com/zh/blog/support-for-custom-protocols-through-jmeter-extensions) 很类似，也需要分别对 Sampler 界面和 Sampler 实现逻辑进行调整。

## 扩展实现

### 步骤1：改造 Sampler 界面

需要更改的类为：org.apache.jmeter.protocol.tcp.config.gui.TCPConfigGui.java

主要改动是在类中加入新的“响应长度”的字段。查阅[参考代码](https://www.emqx.com/zh/blog/jmeter-tcp)。

### 步骤2：更新 Sampler 逻辑

首先在 org.apache.jmeter.protocol.tcp.sampler.TCPSampler.java 加入“响应长度”字段的定义，该字段值将会被 set 到 TCPClient 中。查阅[参考代码](https://www.emqx.com/zh/blog/jmeter-tcp)。

如果需要其他的 TCPClient 实现类也支持响应长度，可以参考 TCPClientImpl 的改造来进行。

### 步骤3：编译、打包和部署

由于本次扩展直接修改了 JMeter 内置的 TCP 取样器，因此需要对 JMeter 源码部分进行编译和打包。

生成编译好的 jar 包后，替换 $JMETER_HOME/lib/ext/ApacheJMeter_tcp.jar，重启 JMeter 即可生效。

注意：由于替换掉了 JMeter 的内置实现，请先做好原有 ApacheJMeter_tcp.jar 的备份。本文只作为开发扩展的一个参考，如果用于实际的生产测试中，替换前请对扩展的修改进行仔细评估。

## 总结

本文是 JMeter 扩展开发的一次应用，在对 JMeter 内置的 TCP 取样器本身有所了解的情况下，对它的功能进行了拓展。

>版权声明： 本文为 EMQ 原创，转载请注明出处。
>
>原文链接：[https://www.emqx.com/zh/blog/jmeter-tcp](https://www.emqx.com/zh/blog/jmeter-tcp)

ITPub博客

JMeter 扩展开发：扩展 TCP 取样器

最新文章