JMeter 采样器插件开发指南：完整项目代码

要开发一个 JMeter 采样器插件，你需要遵循以下步骤：

创建一个 Java 项目，例如使用 Maven 创建一个新的项目。
在项目的 pom.xml 文件中添加 JMeter 相关的依赖项，以便可以访问 JMeter 的 API。

<dependencies>
    <dependency>
        <groupId>org.apache.jmeter</groupId>
        <artifactId>ApacheJMeter_core</artifactId>
        <version>5.4.1</version>
    </dependency>
    <dependency>
        <groupId>org.apache.jmeter</groupId>
        <artifactId>ApacheJMeter_java</artifactId>
        <version>5.4.1</version>
    </dependency>
</dependencies>

创建一个实现 org.apache.jmeter.samplers.Sampler 接口的类，该类将作为你的采样器插件的主要逻辑。

import org.apache.jmeter.samplers.AbstractSampler;
import org.apache.jmeter.samplers.Entry;
import org.apache.jmeter.samplers.SampleResult;

public class MySampler extends AbstractSampler {
    
    private static final long serialVersionUID = 1L;

    @Override
    public SampleResult sample(Entry entry) {
        SampleResult result = new SampleResult();
        result.setSampleLabel(getName());
        result.sampleStart();
        
        // 在这里实现你的采样器逻辑
        
        result.sampleEnd();
        result.setSuccessful(true);
        return result;
    }
}

创建一个实现 org.apache.jmeter.gui.AbstractJMeterGuiComponent 接口的类，该类将用于在 JMeter GUI 中展示你的采样器插件的配置界面。

import org.apache.jmeter.gui.util.HorizontalPanel;
import org.apache.jmeter.samplers.gui.AbstractSamplerGui;
import org.apache.jmeter.testelement.TestElement;

import javax.swing.*;

public class MySamplerGui extends AbstractSamplerGui {

    private static final long serialVersionUID = 1L;
    
    // 创建你的配置界面元素
    private JTextField textField;

    @Override
    public String getLabelResource() {
        return getClass().getSimpleName();
    }

    @Override
    public TestElement createTestElement() {
        MySampler sampler = new MySampler();
        configureTestElement(sampler);
        return sampler;
    }

    @Override
    public void configure(TestElement element) {
        super.configure(element);
        MySampler sampler = (MySampler) element;
        textField.setText(sampler.getPropertyAsString(MySampler.TEXT_FIELD));
    }

    @Override
    public void modifyTestElement(TestElement element) {
        super.modifyTestElement(element);
        MySampler sampler = (MySampler) element;
        sampler.setProperty(MySampler.TEXT_FIELD, textField.getText());
    }

    @Override
    public void clearGui() {
        super.clearGui();
        textField.setText("");
    }

    @Override
    public void initGui() {
        super.initGui();

        // 创建你的配置界面元素
        textField = new JTextField(10);

        // 将元素添加到面板中
        JPanel panel = new HorizontalPanel();
        panel.add(new JLabel("Text Field:"));
        panel.add(textField);

        // 将面板添加到主面板中
        JPanel mainPanel = new JPanel();
        mainPanel.add(panel);

        setLayout(new BorderLayout());
        add(mainPanel, BorderLayout.CENTER);
    }
}

创建一个继承自 org.apache.jmeter.gui.AbstractJMeterGuiComponent 的类，用于定义你的采样器插件在 JMeter GUI 中的显示名称和图标。

import org.apache.jmeter.gui.GuiPackage;
import org.apache.jmeter.gui.tree.JMeterTreeNode;
import org.apache.jmeter.protocol.http.sampler.HTTPSamplerBase;
import org.apache.jmeter.samplers.Sampler;
import org.apache.jmeter.testelement.TestElement;

import javax.swing.*;
import java.awt.*;

public class MySamplerGuiComponent extends AbstractJMeterGuiComponent {

    private static final long serialVersionUID = 1L;
    private static final String ICON_PATH = "/path/to/your/icon.png";

    public MySamplerGuiComponent() {
        super();
        initialize();
    }

    private void initialize() {
        setIcon(createImageIcon(ICON_PATH, "My Sampler"));
        setDocURL("https://example.com/my-sampler-docs");
    }

    @Override
    public String getStaticLabel() {
        return "My Sampler";
    }

    @Override
    public TestElement createTestElement() {
        return new HTTPSamplerBase();
    }

    @Override
    public void modifyTestElement(TestElement element) {
        super.configureTestElement(element);
        if (element instanceof Sampler) {
            Sampler sampler = (Sampler) element;
            sampler.setDomain("");
            sampler.setPort(80);
            sampler.setProtocol("");
            sampler.setPath("");
            sampler.setMethod("");
        }
    }

    @Override
    public void configure(TestElement element) {
        super.configure(element);
        if (element instanceof Sampler) {
            Sampler sampler = (Sampler) element;
            // 配置你的采样器
        }
    }

    @Override
    public void clearGui() {
        super.clearGui();
        // 清除你的配置界面元素
    }

    @Override
    public JPopupMenu createPopupMenu() {
        JPopupMenu menu = new JPopupMenu();
        // 创建右键菜单
        return menu;
    }

    @Override
    public JMeterTreeNode createTreeNode(TestElement element, JMeterTreeNode parentNode) {
        JMeterTreeNode node = new JMeterTreeNode(element, this);
        node.setAllowsChildren(true);
        return node;
    }

    @Override
    public void setEnabled(boolean enabled) {
        super.setEnabled(enabled);
        // 设置你的配置界面元素是否可用
    }

    @Override
    public void configure(TestElement element, GuiPackage guiPackage) {
        super.configure(element, guiPackage);
        // 配置你的采样器
    }
}

创建一个 META-INF/gradle-plugins 目录，并在该目录下创建一个 sample.properties 文件，文件内容如下：

implementation-class=com.example.MySamplerPlugin

创建一个实现 org.gradle.api.Plugin 接口的类，用于在构建过程中将插件添加到 JMeter 中。

import org.gradle.api.Plugin;
import org.gradle.api.Project;

public class MySamplerPlugin implements Plugin<Project> {
    @Override
    public void apply(Project project) {
        project.getExtensions().create("jmeterPlugins", JMeterPluginsExtension.class);
    }
}

创建一个类，用于定义 JMeter 插件的扩展配置。

public class JMeterPluginsExtension {
    private String jmeterHome;

    public String getJmeterHome() {
        return jmeterHome;
    }

    public void setJmeterHome(String jmeterHome) {
        this.jmeterHome = jmeterHome;
    }
}

在项目的 build.gradle 文件中添加以下内容，以将插件添加到 JMeter 中：

plugins {
    id 'java'
}

apply plugin: 'com.example.MySamplerPlugin'

dependencies {
    implementation gradleApi()
    implementation localGroovy()
    implementation 'org.apache.jmeter:ApacheJMeter_core:5.4.1'
    implementation 'org.apache.jmeter:ApacheJMeter_java:5.4.1'
}

jmeterPlugins {
    jmeterHome = '/path/to/your/jmeter_home'
}

jar {
    manifest {
        attributes(
                'JMeterPluginType': 'Sampler',
                'Implementation-Version': '1.0.0',
                'PluginVersion': '1.0.0',
                'PluginType': 'Sampler',
                'PluginAuthor': 'Your Name',
                'PluginName': 'My Sampler',
                'PluginDescription': 'My custom JMeter sampler plugin',
                'IconPath': '/path/to/your/icon.png'
        )
    }
}

构建项目并将生成的 JAR 文件复制到 JMeter 的 lib/ext 目录中。
启动 JMeter，你将在采样器列表中看到你的自定义采样器插件。

这是一个基本的 JMeter 采样器插件的开发流程。你可以根据自己的需求进一步修改和扩展插件的功能。