关于物联网:JMeter-扩展开发扩展-TCP-取样器

对基于 TCP/IP 协定的套接字利用进行性能测试是十分常见的测试场景。JMeter 提供的“TCP 取样器”大部分状况下能够满足测试的需要，然而也有它的局限性。如果心愿实现更灵便的 TCP 套接字测试形式，能够通过对 JMeter 内置的 TCP 取样器进行扩大开发来实现。

在应用 JMeter TCP 取样器时，能够指定 TCPClient 接口的扩大类名，以切换不同的实现。如果不指定，JMeter 默认应用的是 org.apache.jmeter.protocol.tcp.sampler.TCPClientImpl。除了 TCPClientImpl，JMeter 还提供了另外两个实现，别离是 BinaryTCPClientImpl 和 LengthPrefixedBinaryTCPClientImpl，用于解决二进制格局的数据。其中：

应用 BinaryTCPClientImpl 时，文本框中应输出十六进制字符内容，该实现将十六进制转换为对应二进制的字节内容后进行发送。
应用 LengthPrefixedBinaryTCPClientImpl 时，应用字节流的前两个或前四个字节寄存音讯的长度，通过该前缀长度值来确定字节流的完结地位。

实现 TCPClient 接口来减少新的 TCP 取样形式，是扩大 TCP 取样器的一种办法。

然而如果咱们须要对 TCP 取样器做一个通用的批改，例如，当初的 TCP 取样器在读取服务器端返回的响应时，会以“行尾 EOL 字节值”中指定的字节作为结束符，来确定读取的完结地位；不过这种设计就不适用于没有明确终止符，只有固定长度的返回响应。仅减少 TCPClient 接口的实现还不足以实现相似的需要，接下来将示例介绍如何进行革新，使得 TCP 取样器除了指定结束符，还能反对指定返回字节流的长度。

先看一下批改后的成果。在“行尾 EOL 字节值”之后减少了一个“响应长度”的字段，举例来说，下图中指定了响应长度为 12 字节，如果服务器返回的是 ”Echo: hello\n”（其中 ”\n” 是回车符），那么总长度就是 12 字节，也就是会读取到回车符之后进行。如果“行尾 EOL 字节值”和“响应长度”同时设置的话，将优先应用“行尾 EOL 字节值”的配置。

首先，从 JMeter 官网下载所应用的 JMeter 对应的源代码。

JMeter 对 TCP 协定的反对都放在了 protocol/tcp 目录下，因而本次开发的所做的更改都集中于该目录，如下图所示：

整体办法与前文 JMeter 扩大插件实现对自定义协定进行反对很相似，也须要别离对 Sampler 界面和 Sampler 实现逻辑进行调整。

须要更改的类为：org.apache.jmeter.protocol.tcp.config.gui.TCPConfigGui.java

次要改变是在类中退出新的“响应长度”的字段。参考代码如下：

...

public class TCPConfigGui extends AbstractConfigGui {

    ...
    private JTextField responseLenth;
    ...

    @Override
    public void configure(TestElement element) {
        ...
        responseLenth.setText(element.getPropertyAsString(TCPSampler.LENGTH, ""));
    }

    @Override
    public void modifyTestElement(TestElement element) {
        ...
        element.setProperty(TCPSampler.LENGTH, responseLenth.getText(), ""); //TCPSampler.LENGTH 稍后定义
    }

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

    private JPanel createLengthPanel() {JLabel label = new JLabel(JMeterUtils.getResString("response_length")); //$NON-NLS-1$ 

        responseLenth = new JTextField(3); // 3 columns size
        responseLenth.setMaximumSize(new Dimension(responseLenth.getPreferredSize()));
        label.setLabelFor(responseLenth);

        JPanel lengthPanel = new JPanel(new FlowLayout());
        lengthPanel.add(label);
        lengthPanel.add(responseLenth);
        return lengthPanel;
    }

    private void init() {
        ...
        optionsPanel.add(createEolBytePanel());
        optionsPanel.add(createLengthPanel());
        mainPanel.add(optionsPanel);
        ...
    }

    ...
}

首先在 org.apache.jmeter.protocol.tcp.sampler.TCPSampler.java 退出“响应长度”字段的定义，该字段值将会被 set 到 TCPClient 中：

...
public class TCPSampler extends AbstractSampler implements ThreadListener, Interruptible {

    ...
    public static final String LENGTH = "TCPSampler.length"; //$NON-NLS-1$
    ...

    private TCPClient getProtocol() {
        TCPClient tcpClient = null;
        Class<?> javaClass = getClass(getClassname());
        if (javaClass == null){return null;}
        try {tcpClient = (TCPClient) javaClass.newInstance();
            if (getPropertyAsString(EOL_BYTE, "").length()>0){tcpClient.setEolByte(getEolByte());
                log.info("Using eolByte={}", getEolByte());
            } else if (getPropertyAsString(LENGTH, "").trim().length()>0) {tcpClient.setLength(Integer.parseInt(getPropertyAsString(LENGTH, "").trim()));
                log.info("Using length={}", getPropertyAsString(LENGTH, ""));
            }

            if (log.isDebugEnabled()) {log.debug("{} Created: {}@{}", this, getClassname(), Integer.toHexString(tcpClient.hashCode())); //$NON-NLS-1$
            }
        } catch (Exception e) {log.error("{} Exception creating: {}", this, getClassname(), e); //$NON-NLS-1$
        }
        return tcpClient;
    }
    ...
}

在 TCPClient 接口中减少长度字段的反对：

...

public interface TCPClient {

    ...
    /**
     * Get the response length setting
     * 
     * @return
     */
    int getLength();


    /**
     * Set the length of returned response.
     * 
     * @param length
     */
    void setLength(int length);
}

而后对 TCPClient 的各实现类进行革新。

AbstractTCPClient 中减少长度字段 get/set 办法的实现：

...

public abstract class AbstractTCPClient implements TCPClient {

    ...
    protected int length = -1;

    ...
    @Override
    public int getLength() {if(useEolByte) {return -1;}
        return length;
    }

    @Override
    public void setLength(int length) {this.length = length;}
}

TCPClientImpl 中对 read 办法进行革新：

...

public class TCPClientImpl extends AbstractTCPClient {

    ...
    @Override
    public String read(InputStream is, SampleResult sampleResult) throws ReadException{ByteArrayOutputStream w = new ByteArrayOutputStream();
        try {byte[] buffer = new byte[4096];
            int x;
            boolean first = true;
            // 如果没有设置响应长度，仍应用行尾 EOL 字节值来确定响应的完结；否则应用响应长度来进行限度
            if(getLength() == -1) {while ((x = is.read(buffer)) > -1) {if (first) {sampleResult.latencyEnd();
                        first = false;
                    }
                    w.write(buffer, 0, x);
                    if (useEolByte && (buffer[x - 1] == eolByte)) {break;}
                }   
            } else {buffer = new byte[length];
                if ((x = is.read(buffer, 0, length)) > -1) {sampleResult.latencyEnd();
                    w.write(buffer, 0, x);
                }
            }

            // do we need to close byte array (or flush it?)
            if(log.isDebugEnabled()) {log.debug("Read: {}\n{}", w.size(), w.toString());
            }
            return w.toString(CHARSET);
        } catch (IOException e) {throw new ReadException("Error reading from server, bytes read:" + w.size(), e, w.toString());
        }
    }
    ...
}

如果须要其余的 TCPClient 实现类也反对响应长度，能够参考 TCPClientImpl 的革新来进行。

因为本次扩大间接批改了 JMeter 内置的 TCP 取样器，因而须要对 JMeter 源码局部进行编译和打包。

生成编译好的 jar 包后，替换 $JMETER_HOME/lib/ext/ApacheJMeter_tcp.jar，重启 JMeter 即可失效。

留神：因为替换掉了 JMeter 的内置实现，请先做好原有 ApacheJMeter_tcp.jar 的备份。本文只作为开发扩大的一个参考，如果用于理论的生产测试中，替换前请对扩大的批改进行认真评估。

本文是 JMeter 扩大开发的一次利用，在对 JMeter 内置的 TCP 取样器自身有所理解的状况下，对它的性能进行了拓展。

版权申明：本文为 EMQ 原创，转载请注明出处。

原文链接：https://www.emqx.com/zh/blog/jmeter-tcp

关于物联网:JMeter-扩展开发扩展-TCP-取样器

前言

JMeter TCP 取样器的实现

实现成果

筹备开发环境

扩大实现

步骤 1：革新 Sampler 界面

步骤 2：更新 Sampler 逻辑

步骤 3：编译、打包和部署

总结