1 前言
Jmeter是Apache基金會下的一款應用場景非常廣的壓力測試工具，具備輕量、高擴充性、分布式等特性。Jmeter已支援實作随機數、計數器、時間戳、大小寫轉換、屬性校驗等多種函數，友善使用人員使用。如果在使用過程中存在和業務強耦合的常用功能函數，在Jmeter不支援的情況下，那就需要單獨開發自定義函數實作特定功能。
本文介紹如何開發Jmeter自定義函數實作快速生成京東宙斯下單标準sign，同時深刻了解Jmeter的插件化機制及高擴充性特性。
2 開發準備
- Java基礎開發
- Maven基本使用
-
開發依賴版本
JDK 1.8.0
Maven 3.6.3
Jmeter 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内部處理機制。
作者：京東物流 苗浩沖
來源：京東雲開發者社群