## 前言

對基於 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)

JMeter 擴充套件開發：擴充套件 TCP 取樣器

相關文章