Jmeter 壓測實戰：Jmeter 二次開發之自定義函式

大话性能發表於2024-04-11
JMeter函式

1.前言

Jmeter 是 Apache 基金會下的一款應用場景非常廣的壓力測試工具，具備輕量、高擴充套件性、分散式等特性。Jmeter 已支援實現隨機數、計數器、時間戳、大小寫轉換、屬性校驗等多種函式，方便使用人員使用。如果在使用過程中存在和業務強耦合的常用功能函式，在 Jmeter 不支援的情況下，那就需要單獨開發自定義函式實現特定功能。

本文介紹如何開發 Jmeter 自定義函式實現快速生成京東宙斯下單標準 sign，同時深刻理解 Jmeter 的外掛化機制及高擴充套件性特性。

2.開發準備

  • Java 基礎開發
  • Maven 基本使用
  • 開發依賴版本
    JDK 1.8.0Maven 3.6.3Jmeter 5.4.3

3.自定義函式核心實現

3.1 新建專案

  • 新建 maven 專案，這裡專案名為：JSF_Sampler
  • 因為是基於 Jmeter 的擴充套件，需要依賴包 Jmeter 兩個核心包，分別是：
  • ApacheJMeter_core
  • ApacheJMeter_java
  • ApacehJMeter_functions

pom.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>org.apache.jmeter</groupId>
            <artifactId>ApacheJMeter_functions</artifactId>
            <version>${jmeter-version}</version>
        </dependency>
    </dependencies>

3.2 繼承實現 AbstractFunction 類

實現類依次實現以下幾個步驟

1）新建實現類並繼承 AbstractFunction

  • 注意：實現類的包名必須包含 xxx.functions.xxx，Jmeter 使用命名規則實現實現類的載入。

2）重寫以下方法，每個方法的用途見下方程式碼註釋

  • execute()

  • setParameters()

  • getReferenceKey()

  • getArgumentDesc()

   /**
     *
     */
    private static final String APP_KEY = "app_key";
    private static final String APP_SECRET = "app_secret";
    private static final String ACCESS_TOKEN = "access_token";
    private static final String TIMESTAMP = "timestamp";
    private static final String V = "v";
    private static final String METHOD = "method";
    private static final String BUY_PARAM_JSON = "360buy_param_json";
    /**
     * Jmeter中自定義的函式名，在Jmeter的函式助手中可以看到
     */
    private static final String FUNC_NAME = "__GenSignFunction";

    /**
     * 自定義函式的描述，入參，出參，方便使用人員參考使用
     */
    private static final List<String> desc = new ArrayList<>();

    static {
        desc.add("This function is used to generate the JD's JOS sign value");
    }
 /**
     * 此為自定義函式核心實現類，其中，入參SampleResult為上次執行的結果，Sampler為當前的採集器；
     * 返回值為該函式的返回值
     * @param sampleResult
     * @param sampler
     * @return
   * @throws InvalidVariableException
 */
 @Override
    public String execute(SampleResult sampleResult, Sampler sampler) throws InvalidVariableException {
        // 入參處理
        String param = String.valueOf((CompoundVariable)paramValues[0]);
        String signResult = paramHandler(param);

        return signResult;
    }

    /**
     * 按京東宙斯sign加密規則生成標準sign
     * @param param
     * @return
     */
    public String paramHandler(String param){
        Map<String,String> valueMap = new HashMap();
        // 按&符號分割
        String[] paramArray = param.split("&");
        for (int i = 0; i < paramArray.length-1; i++) {
            String key = paramArray[i].split("=")[0];
            String value = paramArray[i].split("=")[1];
            valueMap.put(key,value);
        };
        // 京東宙斯標準sign
        String josGign = EncryptUtil.getSignature(valueMap.get("app_secret")+BUY_PARAM_JSON+valueMap.get("360buy_param_json")
        +ACCESS_TOKEN+valueMap.get("access_token")
        +APP_KEY+valueMap.get("app_key")
        +METHOD+valueMap.get("method")
        +TIMESTAMP+valueMap.get("timestamp")
        +V+valueMap.get("v")
        +valueMap.get("app_secret"));
        return josGign;
    }

/**
* 配置入參，jmeter函式助手入參
*/
    @Override
    public void setParameters(Collection<CompoundVariable> collection) throws InvalidVariableException {
        paramValues = collection.toArray();
    }
/**
* 此方法返回自定義的函式名稱
*/
    @Override
    public String getReferenceKey() {
        return FUNC_NAME;
    }
/**
* 此方法返回函式描述資訊
*/
    @Override
    public List<String> getArgumentDesc() {
        return desc;
    }

3.3 最終專案結構

4.Jmeter 載入擴充套件包

以上開發完成，打包此專案，注意這裡的打包要包含依賴包。

4.1 maven 構建配置

<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>

4.2 專案打包

打包指令如下
mvn package -Dmaven.test.skip=true

4.3 Jmeter 載入擴充套件包

將打包後的擴充套件包放置到 Jmeter 的 ext 目錄：apache-jmeter-5.4.3/lib/ext/

啟動 Jmeter 後，Jmeter 會自動載入 ext 目錄中的擴充套件包

開啟 Jmeter 函式助手後，可以看到本次實現類中列印的相關日誌

5.自定義函式呼叫除錯

5.1 開啟 Jmeter 函式助手，選擇自定義函式

5.2 京東宙斯介面驗證

這裡使用京東快遞獲取預製運單號介面，輸入 GET 請求後，直接點選執行函式【Generate & Copy to clipboard】，出參返回 32 位 sign 值。

GET請求入參
method=jingdong.etms.waybillcode.get&app_key=349559FAE87E66826499890862E40A44&access_token=c8c2bdc8d1684630bb771a503d5b5a7fkyzh×tamp=2022-01-28 15:10:00&360buy_param_json={"preNum":"1","customerCode":"10K43816","orderType":"0"}&v=2.0&sign=EBB52C6CEDA34703ADE72D4AA4D8F316&app_secret=29959e4cadc14ff4998d4fc26d1e5063

6.總結

本文透過自定義函式實現了京東宙斯下單標準 sign 的生成，希望透過本專案大家可以學習到：

  • 如何二次開發 Jmeter，實現自己特有的自定義函式。
  • 理解為何官方介紹 Jmeter 是外掛化的，高擴充套件性特性。
  • 更好地理解 Jmeter 內部處理機制。

更多內容可以訪問個人主頁學習《測試工程師 Python 工具開發實戰》書籍、《大話效能測試 JMeter 實戰》書籍

相關文章