【Jmeter源码解读】003——TCP采样器代码解析

　　采样器地址为src.protocol.tcp.sampler

1.结构图

还有两个文件

• ReadException：响应的异常，举例子就是服务端发生读取文本的问题，会产生异常
• TCPSampler：采样器的具体实现

2.方法理解

2.1、TCPClient.java

//在线程启动时调用
void setupTest();

//在线程结束时调用
void teardownTest();

//抛出异常
void write(OutputStream os, InputStream is) throws IOException;
void write(OutputStream os, String s) throws IOException;

//返回一个从socket中读出的String（v3.3后已经过时）
String read(InputStream is) throws ReadException;

//返回一个从socket中读出的String
String read(InputStream is, SampleResult sampleResult) throws ReadException;

//获取行尾消息尾字节+返回
byte getEolByte();

//字符集
String getCharset();

//设置行尾/消息尾的字节，如果值超过了一个字节，就会被忽略
void setEolByte(int eolInt);

2.2、AbstractTCPClient.java

private String charset;            //字符集
protected byte eolByte;            //消息尾的
protected boolean useEolByte = false;        //判定行尾字节是否超过限制的flag

public byte getEolByte(){}

public void setEolByte(int eolInt){}

public void setupTest(){}
public void teardownTest(){}

public void setCharset(String charset){}        //设置字符集

//返回一个从socket中读出的String
public String read(InputStream is, SampleResult sampleResult) throws ReadException{}

2.3、BinaryTCPClientImpl.java

//日志
private static final Logger log = LoggerFactory.getLogger(BinaryTCPClientImpl.class);

//EOM字节由属性“tcp.BinaryTCPClient.eomByte”定义，默认值1000
private static final int EOM_INT = JMeterUtils.getPropDefault("tcp.BinaryTCPClient.eomByte", 1000); // $NON_NLS-1$

//构造函数，设置消息尾的字节，没超过限制的话写入日志
public BinaryTCPClientImpl(){}

//把十六进制字符串转换成二进制字节数组
public static byte[] hexStringToByteArray(String hexEncodedBinary){}

//输入十六进制字符串通过hexStringToByteArray（）转换成二进制数组，写入输出流。
public void write(OutputStream os, String hexEncodedBinary) throws IOException{}

//方法不支持过长的前缀？
public void write(OutputStream os, InputStream is){}

//过时的方法，警告写入日志，自动进入新方法read(InputStream is, SampleResult sampleResult)
public String read(InputStream is) throws ReadException{}

//***
//读数据直到碰到EOM byte，没有这个的话一直读到流结束
public String read(InputStream is, SampleResult sampleResult) throws ReadException{}

2.4、TCPClientImpl.java

//日志
private static final Logger log = LoggerFactory.getLogger(TCPClientImpl.class);

//EOl字节由属性“tcp.eolByte”定义，默认值1000
//charset由属性“tcp.charset”定义
private static final int EOL_INT = 
    JMeterUtils.getPropDefault("tcp.eolByte", 1000); 
private static final String CHARSET = 
    JMeterUtils.getPropDefault("tcp.charset", Charset.defaultCharset().name()); 

//构造函数
public TCPClientImpl(){}

//字符集写入流
public void write(OutputStream os, String s)  throws IOException{
    os.write(s.getBytes(CHARSET))；
}

//输入流的缓冲区有东西，就写到输出流中
public void write(OutputStream os, InputStream is) throws IOException{}

//方法过时
public String read(InputStream is) throws ReadException{}

//读数据直到碰到EOl byte，没有这个的话一直读到流结束
public String read(InputStream is, SampleResult sampleResult) throws ReadException{}

//组装显示
private String showEOL(final String input){}

2.5、TCPClientDecorator.java

//把int数组转换成byte数组
public static byte[] intToByteArray(int value, int len){}

//把byte数组转换成int数组
public static int byteArrayToInt(byte[] b){}

2.6、LengthPrefixedBinaryTCPClientImpl.java

//构造函数
public LengthPrefixedBinaryTCPClientImpl(){}

//byte数组写入输出流
public void write(OutputStream os, String s)  throws IOException{}

//写入输出流
public void write(OutputStream os, InputStream is) throws IOException

//过时方法
public String read(InputStream is) throws ReadException{}

//
public String read(InputStream is, SampleResult sampleResult) throws ReadException{}

TCPClient classname：

有三种设置格式

TCPClientImpl：文本数据。

BinaryTCPClientImpl：传输二进制数据，指定包结束符。

LengthPrefixedBinaryTCPClientImpl：数据包中前2个字节为数据长度。
可在bin/jmeter.properties配置文件中tcp.binarylength.prefix.length设置。

TCP的数据以二进制之类的居多，所以为了方便则选择第二个进行设置。

所以填写org.apache.jmeter.protocol.tcp.sampler.BinaryTCPClientImpl

先选用org.apache.jmeter.protocol.tcp.sampler.TCPClientImpl

 

**GUI对应表
**Name**：在查看结果树中用于区分元素。保留，使用。
**TCPClient classname**：最终选择的实现TCPClient的实现类，默认先去查看 tcp.handler，没有的话默认选择TCPClientImpl，当前只写一种方法，以防后续变更。保留，不使用。
**ServerName or IP（必需）**：TCP服务端的IP。
**Port Number（必需）**：服务端要使用的端口号。
**Re-use connection（必需）**：选中则代表这个连接将会保持开启，知道数据读完才会关闭。默认开启
**Close connection**：选中则代表连接在采样器运行完之后关闭。默认关闭
**Set NoDelay**：选中则禁用Nagle算法（禁用适用于需要实时预览的通讯程序），nagle算法用于处理小报文段（微小分组）的发送。保留，程序内写死不禁用。
**SO_LINGER**：在创建socket时，启用/禁用指定的挂起时间(以秒为单位)。可以将“SO LINGER”值设置为0，则可以防止大量套接字处于时间等待状态。保留，程序内写死设置为0。
**End of line(EOL) byte value**：结束读取的值，设置在-128~127之外，以跳过EOL检查。保留，不设置。
**Connect Timeout**：连接时延，不设置。
**Response Timeout**：回复时延，不设置。
**Text to Send（必需）**：要发送的文本。
**Login User**：删除
**Password**：删除