Jmeter压测实战—Jmeter二次开发之自定义函数

Jmeter是Apache基金会下的一款应用场景非常广的压力测试工具，具备轻量、高扩展性、分布式等特性。Jmeter已支持实现随机数、计数器、时间戳、大小写转换、属性校验等多种函数，方便使用人员使用。如果在使用过程中存在和业务强耦合的常用功能函数，在Jmeter不支持的情况下，那就需要单独开发自定义函数实现特定功能。

本文介绍如何开发Jmeter自定义函数实现快速生成京东宙斯下单标准sign，同时深刻理解Jmeter的插件化机制及高扩展性特性。

1、开发准备

Java基础开发
Maven基本使用
开发依赖版本
JDK 1.8.0Maven 3.6.3Jmeter 5.4.3

2、自定义函数核心实现

2.1 新建项目

pom.xml文件核心配置如下：

新建maven项目，这里项目名为：JSF_Sampler
因为是基于Jmeter的扩展，需要依赖包Jmeter两个核心包，分别是：
ApacheJMeter_core
ApacheJMeter_java
ApacehJMeter_functions
pom.xml文件核心配置如下

1. <groupId>com.jd.jmeter.jsf</groupId>

2. <artifactId>JSF_Sampler</artifactId>

3. <version>1.0-SNAPSHOT</version>

4. <properties>

5. <maven.compiler.source>8</maven.compiler.source>

6. <maven.compiler.target>8</maven.compiler.target>

7. <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>

8. <jmeter-version>5.4.3</jmeter-version>

9. </properties>

10. <dependencies>

11. <dependency>

12. <groupId>org.apache.jmeter</groupId>

13. <artifactId>ApacheJMeter_core</artifactId>

14. <version>${jmeter-version}</version>

15. </dependency>

16. <dependency>

17. <groupId>org.apache.jmeter</groupId>

18. <artifactId>ApacheJMeter_java</artifactId>

19. <version>${jmeter-version}</version>

20. </dependency>

21. <dependency>

22. <groupId>org.apache.jmeter</groupId>

23. <artifactId>ApacheJMeter_functions</artifactId>

24. <version>${jmeter-version}</version>

25. </dependency>

26. </dependencies>

2.2 继承实现AbstractFunction类

实现类依次实现以下几个步骤

1）新建实现类并继承 AbstractFunction

注意：实现类的包名必须包含xxx.functions.xxx，Jmeter使用命名规则实现实现类的加载。

2）重写以下方法，每个方法的用途见下方代码注释

execute()
setParameters()
getReferenceKey()
getArgumentDesc()

1. /**

2. * 京东宙斯 下单标准字段常量

3. */

4. private static final String APP_KEY = "app_key";

5. private static final String APP_SECRET = "app_secret";

6. private static final String ACCESS_TOKEN = "access_token";

7. private static final String TIMESTAMP = "timestamp";

8. private static final String V = "v";

9. private static final String METHOD = "method";

10. private static final String BUY_PARAM_JSON = "360buy_param_json";

11. /**

12. * Jmeter中自定义的函数名，在Jmeter的函数助手中可以看到

13. */

14. private static final String FUNC_NAME = "__GenSignFunction";

16. /**

17. * 自定义函数的描述，入参，出参，方便使用人员参考使用

18. */

19. private static final List<String> desc = new ArrayList<>();

21. static {

22. desc.add("This function is used to generate the JD's JOS sign value");

23. }

24. /**

25. * 此为自定义函数核心实现类，其中，入参SampleResult为上次运行的结果，Sampler为当前的采集器；

26. * 返回值为该函数的返回值

27. * @param sampleResult

28. * @param sampler

29. * @return

30. * @throws InvalidVariableException

31. */

32. @Override

33. public String execute(SampleResult sampleResult, Sampler sampler) throws InvalidVariableException {

34. // 入参处理

35. String param = String.valueOf((CompoundVariable)paramValues[0]);

36. String signResult = paramHandler(param);

38. return signResult;

39. }

41. /**

42. * 按京东宙斯sign加密规则生成标准sign

43. * @param param

44. * @return

45. */

46. public String paramHandler(String param){

47. Map<String,String> valueMap = new HashMap();

48. // 按&符号分割

49. String[] paramArray = param.split("&");

50. for (int i = 0; i < paramArray.length-1; i++) {

51. String key = paramArray[i].split("=")[0];

52. String value = paramArray[i].split("=")[1];

53. valueMap.put(key,value);

54. };

55. // 京东宙斯标准sign

56. String josGign = EncryptUtil.getSignature(valueMap.get("app_secret")+BUY_PARAM_JSON+valueMap.get("360buy_param_json")

57. +ACCESS_TOKEN+valueMap.get("access_token")

58. +APP_KEY+valueMap.get("app_key")

59. +METHOD+valueMap.get("method")

60. +TIMESTAMP+valueMap.get("timestamp")

61. +V+valueMap.get("v")

62. +valueMap.get("app_secret"));

63. return josGign;

64. }

66. /**

67. * 配置入参，jmeter函数助手入参

68. */

69. @Override

70. public void setParameters(Collection<CompoundVariable> collection) throws InvalidVariableException {

71. paramValues = collection.toArray();

72. }

73. /**

74. * 此方法返回自定义的函数名称

75. */

76. @Override

77. public String getReferenceKey() {

78. return FUNC_NAME;

79. }

80. /**

81. * 此方法返回函数描述信息

82. */

83. @Override

84. public List<String> getArgumentDesc() {

85. return desc;

86. }

2.3 最终项目结构

3、Jmeter加载扩展包

以上开发完成，打包此项目，注意这里的打包要包含依赖包。

3.1 maven构建配置

1. <build>

2. <finalName>${project.artifactId}</finalName>

3. <defaultGoal>install</defaultGoal>

4. <plugins>

5. <plugin>

6. <groupId>org.apache.maven.plugins</groupId>

7. <artifactId>maven-compiler-plugin</artifactId>

8. <configuration>

9. <source>1.8</source>

10. <target>1.8</target>

11. </configuration>

12. </plugin>

13. <plugin>

14. <groupId>org.apache.maven.plugins</groupId>

15. <artifactId>maven-assembly-plugin</artifactId>

16. <configuration>

17. <descriptorRefs>

18. <descriptorRef>jar-with-dependencies</descriptorRef>

19. </descriptorRefs>

20. </configuration>

21. <executions>

22. <execution>

23. <id>assemble-all</id>

24. <phase>package</phase>

25. <goals>

26. <goal>single</goal>

27. </goals>

28. </execution>

29. </executions>

30. </plugin>

31. </plugins>

32. </build>

3.2 项目打包

打包指令如下

mvn package -Dmaven.test.skip=true

3.3 Jmeter加载扩展包

将打包后的扩展包放置到Jmeter的ext目录：apache-jmeter-5.4.3/lib/ext/

启动Jmeter后，Jmeter会自动加载ext目录中的扩展包

打开Jmeter函数助手后，可以看到本次实现类中打印的相关日志

4、自定义函数调用调试

4.1 打开Jmeter函数助手，选择自定义函数

4.2 京东宙斯接口验证

这里使用京东快递获取预制运单号接口，输入GET请求后，直接点击运行函数【Generate & Copy to clipboard】，出参返回32位sign值。

1. GET请求入参

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

5、总结

本文通过自定义函数实现了京东宙斯下单标准sign的生成，希望通过本项目大家可以学习到：

• 如何二次开发Jmeter，实现自己特有的自定义函数。
• 理解为何官方介绍Jmeter是插件化的，高扩展性特性。
• 更好的理解Jmeter内部处理机制。