JMeter 內建支援了一系列的常用協議，例如 HTTP/HTTPS、FTP、JDBC、JMS、SOAP 和 TCP 等，可以直接透過編寫指令碼來支援相關協議的測試場景。除了這些協議之外，使用者也可能需要進行一些其他標準協議的測試，或者某些情況下在標準協議基礎上增加了定製化的內容，需要對定製後的協議進行測試。本文中介紹的 Java Sampler 擴充套件機制就是 JMeter 提供的一種可以輕鬆實現對新協議支援的方式。

## Java Sampler 簡介

JMeter 中有一類重要的元件 Sampler，即“取樣器”。取樣器中包含了前面提到的一系列協議，可以認為“取樣器”這個類別中的元件，是對相應協議的實現。不過 Java Sampler 的意思並不是指支援所謂的 Java 協議，也不能簡單地說成 Java 取樣器，比較準確的意思是利用自定義的 Java 類來擴充套件對新協議的支援，這些擴充套件的新協議都是透過“Java請求“加入到測試指令碼中的。

下面兩張圖的步驟展示瞭如何新增 Java 請求，以及如何選擇不同的 Java Sampler。
[![1](http://img.blog.itpub.net/blog/2022/10/20/36815aa11c4bb75b.png?x-oss-process=style/bb "1")](https://www.emqx.com/zh/blog/jmeter-extension-development-custom-java-sampler "1")

[![2](http://img.blog.itpub.net/blog/2022/10/20/bf91e61ccd3d5571.png?x-oss-process=style/bb "2")](https://www.emqx.com/zh/blog/jmeter-extension-development-custom-java-sampler "2")
接下來我們將以 MQTT 協議中的連線為例，介紹使用 Java Sampler 來進行擴充套件開發的具體步驟。

## 準備開發環境

在開發 JMeter外掛的時候，大部分情況不需要把 JMeter 的原始碼下載，只需要對相關的 JMeter 庫進行引用就可以了。請參見文章 [JMeter 擴充套件開發：自定義函式](https://www.emqx.com/zh/blog/jmeter-extension-development-custom-functions) 來準備開發環境。需要注意的是，在本文的示例中，除了引用 `ApacheJMeter_core` 之外，還需要引入 `ApacheJMeter_core` ，以及支援 MQTT 協議的 Java 類庫，在此例中使用的是開源的 Eclipse Paho Java MQTT client 庫。其他的 MQTT Java 類庫當然也可以，取決於被擴充套件的協議和協議擴充套件者的偏好。

pom.xml 中所需的依賴部分如下：

```xml
<dependencies>
  <dependency>
    <groupid>org.eclipse.paho</groupid>
    <artifactid>org.eclipse.paho.client.mqttv3</artifactid>
    <version>1.2.5</version>
  </dependency>
  <dependency>
    <groupid>org.apache.jmeter</groupid>
    <artifactid>ApacheJMeter_java</artifactid>
    <version>5.4.3</version>
    <scope>provided</scope>
  </dependency>
  <dependency>
    <groupid>org.eclipse.paho</groupid>
    <artifactid>org.eclipse.paho.client.mqttv3</artifactid>
    <version>1.2.5</version>
  </dependency>
<dependencies>
```

## 開發 Java Sampler

開發一個自己的 Java Sampler 包括下面幾步：

1. 繼承 JMeter 抽象類 org.apache.jmeter.protocol.java.sampler.AbstractJavaSamplerClient
2. 實現下面4個方法：

方法1：

```isbl
SampleResult runTest(JavaSamplerContext context)
```

`runTest` 方法定義在介面 JavaSamplerClient 中，擴充套件協議的主體邏輯就是在這個方法中進行編碼實現，是必須要實現的方法。

方法2：

```csharp
public Arguments getDefaultParameters()
```

與請求一起傳送的預設引數定義在 `getDefaultParameters` 方法中，這些引數的名稱和值將出現在 JMeter Java 請求對應的介面中。這個方法不是必須要實現的，使用 Java 請求的時候，如果沒有預設的引數，也可以透過手動新增引數的方法加入。

方法3：

```isbl
void setupTest(JavaSamplerContext context)
```

方法4：

```isbl
void teardownTest(JavaSamplerContext context)
```

`setupTest` 和 `teardownTest` 顧名思義，就是在 Java 請求開始時候進行的初始化工作，以及結束時候進行的掃尾工作。這兩個方法也不是必須要實現的。

### runTest 方法

先重點介紹 `runTest` 方法。 `runTest` 方法的返回結果為 SampleResult，也就是每次“取樣“的結果。方法實現的一般程式碼結構如下：

```reasonml
@Override
public SampleResult runTest(JavaSamplerContext context) {

SampleResult result = new SampleResult();
  result.sampleStart();
  try{ 
    //以下部分實現具體的處理邏輯
    //...
    //具體業務邏輯結束

//發出請求
    result.sampleEnd();
    //請求成功，設定測試結果為成功
    result.setSuccessful(true);
    result.setResponseData("data...".getBytes());
    result.setResponseMessage("message...");
    result.setResponseCodeOK();
  } catch(Exception e) {
    //請求失敗，設定測試結果為失敗
    result.sampleEnd();
    result.setSuccessful(false);
    result.setResponseCode("500");
  }
  return result;
}
```

如上所示，程式碼邏輯主要是：

1）對目標系統必送正確的協議資料。

2）根據目標系統返回的資料，給 SampleResult 設定正確的方法、結束時間等，這樣 JMeter 引擎可獲知測試成功與否，進一步地可以正確顯示到 JMeter 的報告結果中。

進行普通 MQTT TCP 連線，業務邏輯部分的實現可以參考下面的程式碼：

```reasonml
//MQTT Broker 的連線資訊
String broker = "tcp://broker.emqx.io:1883";
String username = "emqx";
String password = "public";
String clientid = "publish_client";

MqttClient client = new MqttClient(broker, clientid, new MemoryPersistence());
MqttConnectOptions options = new MqttConnectOptions();
options.setUserName(username);
options.setPassword(password.toCharArray());
client.connect(options);
```

### getDefaultParameters 方法

上述程式碼中我們硬編碼了 MQTT Broker 的連線資訊，但在實際應用場景中，更希望能使用一個 JMeter 外掛，連線不同的 MQTT Broker。這種情況下，就可以將連線資訊從 `JavaSamplerContext` 的引數中讀取出來：

```abnf
String broker = context.getParameter("broker");
String username = context.getParameter("user");
String password = context.getParameter("password");
String clientid = context.getParameter("clientid");
```

引數具體值的輸入由指令碼編寫人員在 JMeter 介面上編輯指令碼時指定，或者在執行期間使用指定變數的值。而為了方便指令碼編寫人員瞭解並更改所需的引數，我們透過 `getDefaultParameters` 方法將這些引數在介面上暴露出來：

```typescript
public Arguments getDefaultParameters() {
  Arguments arguments = new Arguments();
  arguments.addArgument("broker", "tcp://broker.emqx.io:1883");
  arguments.addArgument("user", "emqx");
  arguments.addArgument("password", "public");
  arguments.addArgument("clientid", "publish_client");
  return arguments;
}
```

### setupTest 方法

跟寫 JUnit 測試的 setup 方法類似，這裡主要執行針對單個虛擬使用者的一次性起始、準備性的操作。

### teardownTest 方法

與 JUnit 測試的 teardown 方法類似，這裡主要執行針對單個虛擬使用者的收尾的操作。需要注意的是，該方法的呼叫不是在單個虛擬使用者的執行緒裡，而是所有虛擬使用者都在一個執行緒裡順序執行該方法。

## 編譯、部署與使用

完成了程式碼的編寫，需要將程式碼進行編譯和部署。pom.xml 的 build 設定及編譯具體方法也可參見此前的文章 JMeter 擴充套件開發：自定義函式。

編譯完成後，在 target 目錄下會生成一個 jar 包。請注意透過示例的 pom.xml，編譯出來的 jar 包裡包含了所需的第三方類庫，如 org.eclipse.paho.client.mqtt 庫，避免 JMeter 執行時找不到第三方提供的類的問題。

將編譯好的 jar 複製到 $JMETER_HOME/lib/ext 目錄下，重啟 JMeter。啟動完畢，新增一個 Java 請求，在類名稱下拉選單框中應該就能看到新擴充套件的類了。如果不存在，請檢視一下 lib/ext 目錄下是否正確複製了 jar 包，也可以查一下 JMeter 的日誌，確認沒有報出異常。

[![3](http://img.blog.itpub.net/blog/2022/10/20/0317834480031301.png?x-oss-process=style/bb)](https://www.emqx.com/zh/blog/jmeter-extension-development-custom-java-sampler)
至此，我們完成了透過 JMeter 提供的擴充套件機制來支援新協議的測試。可以看到 JMeter 對新協議的定製擴充套件還是比較簡單的。不過透過 Java Sampler 方式擴充套件的協議在介面友好性上與 JMeter 提供的標準協議相比還是較差，我們將在本系列專題的後續文章中介紹如何使用 JMeter 更強大的擴充套件方式，敬請期待。

>版權宣告： 本文為 EMQ 原創，轉載請註明出處。
>
>原文連結：[https://www.emqx.com/zh/blog/jmeter-extension-development-custom-java-sampler](https://www.emqx.com/zh/blog/jmeter-extension-development-custom-java-sampler)</dependencies></dependencies>

JMeter 擴充套件開發：自定義 Java Sampler

相關文章