JMeter 二次开发与 API 平台

// JSR223 PreProcessor - 生成 HMAC-SHA256 签名
// 注意：勾选 Cache compiled script 以启用编译缓存

import javax.crypto.Mac
import javax.crypto.spec.SecretKeySpec
import java.nio.charset.StandardCharsets

// 从用户变量中读取 appId 与 secret
def appId  = vars.get('appId')
def secret = vars.get('secret')
def ts     = System.currentTimeMillis().toString()
def nonce  = UUID.randomUUID().toString().replace('-', '')

// 拼接待签名串
def payload = "${appId}|${ts}|${nonce}"

// 计算 HMAC-SHA256
def mac = Mac.getInstance('HmacSHA256')
mac.init(new SecretKeySpec(secret.getBytes(StandardCharsets.UTF_8), 'HmacSHA256'))
def sign = mac.doFinal(payload.getBytes(StandardCharsets.UTF_8)).encodeHex() as String

// 写回变量供 HTTP Sampler 使用
vars.put('ts',    ts)
vars.put('nonce', nonce)
vars.put('sign',  sign)

log.debug("签名生成完成: appId=${appId}, ts=${ts}")

<!-- pom.xml：JMeter 5.6.3 二次开发依赖 -->
<project>
    <modelVersion>4.0.0</modelVersion>
    <groupId>com.example</groupId>
    <artifactId>jmeter-plugins</artifactId>
    <version>1.0.0</version>
    <packaging>jar</packaging>

    <properties>
        <jmeter.version>5.6.3</jmeter.version>
        <maven.compiler.source>17</maven.compiler.source>
        <maven.compiler.target>17</maven.compiler.target>
    </properties>

    <dependencies>
        <!-- 核心 API：TestElement、SampleResult 等 -->
        <dependency>
            <groupId>org.apache.jmeter</groupId>
            <artifactId>ApacheJMeter_core</artifactId>
            <version>${jmeter.version}</version>
            <scope>provided</scope>
        </dependency>
        <!-- Java Sampler 抽象类 -->
        <dependency>
            <groupId>org.apache.jmeter</groupId>
            <artifactId>ApacheJMeter_java</artifactId>
            <version>${jmeter.version}</version>
            <scope>provided</scope>
        </dependency>
        <!-- 函数助手开发依赖 -->
        <dependency>
            <groupId>org.apache.jmeter</groupId>
            <artifactId>ApacheJMeter_functions</artifactId>
            <version>${jmeter.version}</version>
            <scope>provided</scope>
        </dependency>
    </dependencies>
</project>

package com.example.sampler;

import org.apache.jmeter.config.Arguments;
import org.apache.jmeter.protocol.java.sampler.AbstractJavaSamplerClient;
import org.apache.jmeter.protocol.java.sampler.JavaSamplerContext;
import org.apache.jmeter.samplers.SampleResult;

/**
 * 自定义 Java Sampler：调用 gRPC 接口
 * 4 个核心方法对应生命周期：参数声明 → 初始化 → 循环执行 → 收尾
 */
public class GrpcSampler extends AbstractJavaSamplerClient {

    private GrpcClient client;  // 假设的 gRPC 客户端封装

    /** GUI 中显示的默认参数 */
    @Override
    public Arguments getDefaultParameters() {
        Arguments args = new Arguments();
        args.addArgument("host", "127.0.0.1");
        args.addArgument("port", "9090");
        args.addArgument("method", "/helloworld.Greeter/SayHello");
        args.addArgument("payload", "{\"name\":\"perf-test\"}");
        return args;
    }

    /** 每个线程启动前执行一次，建立长连接 */
    @Override
    public void setupTest(JavaSamplerContext ctx) {
        String host = ctx.getParameter("host");
        int    port = Integer.parseInt(ctx.getParameter("port"));
        client = new GrpcClient(host, port);  // 复用 Channel，避免每次握手
    }

    /** 每次循环调用的核心方法 */
    @Override
    public SampleResult runTest(JavaSamplerContext ctx) {
        SampleResult result = new SampleResult();
        result.setSampleLabel(ctx.getParameter("method"));
        result.sampleStart();  // 计时开始
        try {
            String resp = client.call(ctx.getParameter("method"),
                                      ctx.getParameter("payload"));
            result.setResponseData(resp, "UTF-8");
            result.setResponseCodeOK();
            result.setSuccessful(true);
        } catch (Exception e) {
            result.setSuccessful(false);
            result.setResponseCode("500");
            result.setResponseMessage(e.getMessage());
        } finally {
            result.sampleEnd();  // 计时结束
        }
        return result;
    }

    /** 线程结束时关闭连接 */
    @Override
    public void teardownTest(JavaSamplerContext ctx) {
        if (client != null) client.close();
    }
}

package com.example.functions;  // 包名必须以 functions 结尾

import org.apache.jmeter.engine.util.CompoundVariable;
import org.apache.jmeter.functions.AbstractFunction;
import org.apache.jmeter.functions.InvalidVariableException;
import org.apache.jmeter.samplers.SampleResult;
import org.apache.jmeter.samplers.Sampler;

import java.util.Collection;
import java.util.LinkedList;
import java.util.List;

/** 自定义函数：${__PhoneNo()} 随机生成 11 位手机号 */
public class PhoneNoFunction extends AbstractFunction {

    private static final String KEY = "__PhoneNo";
    private static final List<String> DESC = new LinkedList<>();
    static {
        DESC.add("前缀（可选），如 138");
    }

    @Override
    public String execute(SampleResult prev, Sampler sampler) {
        String prefix = "1" + (3 + (int)(Math.random() * 8));  // 13~18
        StringBuilder sb = new StringBuilder(prefix);
        for (int i = 0; i < 8; i++) sb.append((int)(Math.random() * 10));
        return sb.toString();
    }

    @Override
    public void setParameters(Collection<CompoundVariable> args) throws InvalidVariableException {
        // 入参校验，本例无强制参数
    }

    @Override
    public String getReferenceKey() { return KEY; }

    @Override
    public List<String> getArgumentDesc() { return DESC; }
}

package com.example.postprocessor;

import org.apache.jmeter.processor.AbstractPostProcessor;
import org.apache.jmeter.samplers.SampleResult;
import org.apache.jmeter.threads.JMeterContext;

import javax.xml.xpath.XPath;
import javax.xml.xpath.XPathFactory;

public class NamespaceAwareXPathExtractor extends AbstractPostProcessor {
    @Override
    public void process() {
        JMeterContext ctx = getThreadContext();
        SampleResult prev = ctx.getPreviousResult();
        if (prev == null) return;

        String xpathExpr = getPropertyAsString("xpath");
        String varName   = getPropertyAsString("varName");
        try {
            XPath xpath = XPathFactory.newInstance().newXPath();
            // 省略：解析响应字节流为 DOM，设置命名空间感知
            String value = xpath.evaluate(xpathExpr, /* doc */ null);
            ctx.getVariables().put(varName, value);
        } catch (Exception e) {
            log.warn("XPath 提取失败: {}", e.getMessage());
        }
    }
}

import org.apache.jmeter.util.JMeterUtils;

// 1. 加载 JMeter 主配置文件（jmeter.properties）
JMeterUtils.loadJMeterProperties("/opt/jmeter/bin/jmeter.properties");
// 2. 设置 JMeter 安装目录，加载 saveservice.properties 等
JMeterUtils.setJMeterHome("/opt/jmeter");
// 3. 初始化语言环境与日志
JMeterUtils.initLocale();
JMeterUtils.initLogging();

import org.apache.jmeter.save.SaveService;
import org.apache.jorphan.collections.HashTree;
import java.io.FileInputStream;

// 加载本地 JMX 文件为 HashTree
try (FileInputStream fis = new FileInputStream("/data/scripts/test.jmx")) {
    HashTree tree = SaveService.loadTree(fis);
    // 后续交给 Engine 执行
    runEngine(tree);
} catch (Exception e) {
    log.error("脚本加载失败", e);
}

import org.apache.jmeter.reporters.ResultCollector;
import org.apache.jmeter.samplers.SampleEvent;
import org.apache.jmeter.samplers.SampleResult;

/** 自定义结果收集器：将实时指标推送到 Kafka */
public class KafkaResultCollector extends ResultCollector {

    @Override
    public void sampleOccurred(SampleEvent event) {
        super.sampleOccurred(event);  // 保留默认行为（写 jtl 等）
        SampleResult res = event.getResult();
        // 组装监控数据点
        MetricPoint point = MetricPoint.builder()
            .timestamp(System.currentTimeMillis())
            .label(res.getSampleLabel())
            .rt(res.getTime())
            .success(res.isSuccessful())
            .bytes(res.getBytesAsLong())
            .build();
        // 异步发送到 Kafka，后端聚合计算 QPS/RT/P99
        KafkaProducerHolder.send("jmeter-metrics", point.toJson());
    }
}

import org.apache.jmeter.engine.StandardJMeterEngine;

StandardJMeterEngine engine = new StandardJMeterEngine();
engine.configure(tree);   // 注入 HashTree
engine.run();             // 阻塞执行，直到测试计划结束

apiVersion: argoproj.io/v1alpha1
kind: Workflow
metadata:
  generateName: jmeter-perf-
spec:
  entrypoint: perf-test
  templates:
    - name: perf-test
      steps:
        - - name: distribute-script
            template: jmeter-worker
            arguments:
              parameters:
                - name: script-url
                  value: "https://oss.example.com/scripts/test.jmx"
                - name: threads
                  value: "500"
            withItems: [1, 2, 3, 4]   # 启动 4 个 Worker
    - name: jmeter-worker
      inputs:
        parameters:
          - name: script-url
          - name: threads
      container:
        image: jmeter:5.6.3-jdk17
        command: [sh, -c]
        args:
          - |
            curl -sL {{inputs.parameters.script-url}} -o /tmp/test.jmx
            jmeter -n -t /tmp/test.jmx \
              -Jthreads={{inputs.parameters.threads}} \
              -Jbackend.influxdb.url=http://influxdb:8086 \
              -l /tmp/result.jtl
            curl -X PUT --data-binary @/tmp/result.jtl \
              http://report-collector/api/jtl/upload