jmeter之GUI运行原理

/**这个包名，也是这个文件所在的路径，java自带的一个演示文件，
    英文好的同学可自行阅读，英文不好的可以和我一起阅读，
    互相学习，共同进步，如有错误欢迎指正。
    */
package org.apache.jmeter.protocol.java.test;
 
import java.io.Serializable;
import java.util.Iterator;
import java.util.concurrent.TimeUnit;
 
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;
import org.apache.jmeter.testelement.TestElement;
import org.apache.jorphan.logging.LoggingManager;
import org.apache.log.Logger;
 
public class JavaTest extends AbstractJavaSamplerClient implements Serializable {
 
    private static final Logger LOG = LoggingManager.getLoggerForClass();
 
    private static final long serialVersionUID = 240L;
 
    /**这个变量是用来记录JavaSamplerContext对象context调用getLongParameter方法传递DEFAULT_SLEEP_TIME和SLEEP_NAME运算后的返回值*/
    private long sleepTime;
 
    /** 下边这个变量的值100就是Sleep_Time的默认值，也是我们在页面中看到的那个100,注意这个值是一个毫秒值. */
    public static final long DEFAULT_SLEEP_TIME = 100;
 
    /** 这个变量就是用来存储GUI中的那个Sleep_Time的变量。 */
    private static final String SLEEP_NAME = "Sleep_Time";
 
    /**
    以下的变量名称和GUI中的变量名称都是相同的，不难看懂。
     */
    private long sleepMask;
 
    public static final long DEFAULT_SLEEP_MASK = 0xff;
 
    private static final String DEFAULT_MASK_STRING = "0x" + (Long.toHexString(DEFAULT_SLEEP_MASK)).toUpperCase(java.util.Locale.ENGLISH);
 
    private static final String MASK_NAME = "Sleep_Mask";
 
    private String label;
 
    private static final String LABEL_NAME = "Label";
 
    private String responseMessage;
 
    private static final String RESPONSE_MESSAGE_DEFAULT = "";
 
    private static final String RESPONSE_MESSAGE_NAME = "ResponseMessage";
 
    private String responseCode;
 
    private static final String RESPONSE_CODE_DEFAULT = "";
 
    private static final String RESPONSE_CODE_NAME = "ResponseCode";
 
    private String samplerData;
 
    private static final String SAMPLER_DATA_DEFAULT = "";
 
    private static final String SAMPLER_DATA_NAME = "SamplerData";
 
    private String resultData;
 
    private static final String RESULT_DATA_DEFAULT = "";
 
    private static final String RESULT_DATA_NAME = "ResultData";
 
    private boolean success;
 
    private static final String SUCCESS_DEFAULT = "OK";
 
    private static final String SUCCESS_NAME = "Status";
 
    /**
     * 默认的构造函数，实例化了一个客户端的类
     */
    public JavaTest() {
        LOG.debug(whoAmI() + "\tConstruct");
    }
 
    /*
     * 这个方法就是设置了所有的值，我们从GUI中输入的值就是由这个方法进行读取并且赋值给上边定义的变量。
     */
    private void setupValues(JavaSamplerContext context) {
 
        sleepTime = context.getLongParameter(SLEEP_NAME, DEFAULT_SLEEP_TIME);
        sleepMask = context.getLongParameter(MASK_NAME, DEFAULT_SLEEP_MASK);
 
        responseMessage = context.getParameter(RESPONSE_MESSAGE_NAME, RESPONSE_MESSAGE_DEFAULT);
 
        responseCode = context.getParameter(RESPONSE_CODE_NAME, RESPONSE_CODE_DEFAULT);
 
        success = context.getParameter(SUCCESS_NAME, SUCCESS_DEFAULT).equalsIgnoreCase("OK");
 
        label = context.getParameter(LABEL_NAME, "");
        if (label.length() == 0) {
            label = context.getParameter(TestElement.NAME);
        }
 
        samplerData = context.getParameter(SAMPLER_DATA_NAME, SAMPLER_DATA_DEFAULT);
 
        resultData = context.getParameter(RESULT_DATA_NAME, RESULT_DATA_DEFAULT);
    }
 
    /**
    这是一个初始化方法，可以理解为loadrunner中的init
     */
    @Override
    public void setupTest(JavaSamplerContext context) {
        if (LOG.isDebugEnabled()) {
            LOG.debug(whoAmI() + "\tsetupTest()");
            listParameters(context);
        }
    }
 
    /**
        这个方法是一个与生命周期相关的方法
        决定了哪些变量参数是否显示到GUI页面上。这个方法类一加载就会运行，运行的顺序排在所有复写的方法中第一。
     */
    @Override
    public Arguments getDefaultParameters() {
        Arguments params = new Arguments();
        params.addArgument(SLEEP_NAME, String.valueOf(DEFAULT_SLEEP_TIME));
        params.addArgument(MASK_NAME, DEFAULT_MASK_STRING);
        params.addArgument(LABEL_NAME, "");
        params.addArgument(RESPONSE_CODE_NAME, RESPONSE_CODE_DEFAULT);
        params.addArgument(RESPONSE_MESSAGE_NAME, RESPONSE_MESSAGE_DEFAULT);
        params.addArgument(SUCCESS_NAME, SUCCESS_DEFAULT);
        params.addArgument(SAMPLER_DATA_NAME, SAMPLER_DATA_DEFAULT);
        params.addArgument(RESULT_DATA_NAME, SAMPLER_DATA_DEFAULT);
        return params;
    }
 
    /**
        主要运行的代码，相当于Loadrunner中的action
     */
    @Override
    public SampleResult runTest(JavaSamplerContext context) {
        setupValues(context);
 
        SampleResult results = new SampleResult();
 
        results.setResponseCode(responseCode);
        results.setResponseMessage(responseMessage);
        results.setSampleLabel(label);
 
        if (samplerData != null && samplerData.length() > 0) {
            results.setSamplerData(samplerData);
        }
 
        if (resultData != null && resultData.length() > 0) {
            results.setResponseData(resultData, null);
            results.setDataType(SampleResult.TEXT);
        }
 
        //这个方法很重要，是标记一个事务的开始，可以理解为loadrunner中的lr_start_transaction
        results.sampleStart();
 
        long sleep = sleepTime;
        if (sleepTime > 0 && sleepMask > 0) {
            long start = System.currentTimeMillis();
 
            sleep = sleepTime + (start % sleepMask);
        }
 
        try {
 
            if (sleep > 0) {
                TimeUnit.MILLISECONDS.sleep(sleep);
            }
            results.setSuccessful(success);
        } catch (InterruptedException e) {
            LOG.warn("JavaTest: interrupted.");
            results.setSuccessful(true);
        } catch (Exception e) {
            LOG.error("JavaTest: error during sample", e);
            results.setSuccessful(false);
        } finally {
            // 这里就是标记事务的结束，相当于loadrunner中的lr_end_transaction
            results.sampleEnd();
        }
 
        if (LOG.isDebugEnabled()) {
            LOG.debug(whoAmI() + "\trunTest()" + "\tTime:\t" + results.getTime());
            listParameters(context);
        }
 
        return results;
    }
 
    /**
        包含初始化参数的一个调试方法。
     */
    private void listParameters(JavaSamplerContext context) {
        Iterator<String> argsIt = context.getParameterNamesIterator();
        while (argsIt.hasNext()) {
            String name = argsIt.next();
            LOG.debug(name + "=" + context.getParameter(name));
        }
    }
 
    /**
        这个就是一个用户自定义的调试方法。
     */
    private String whoAmI() {
        StringBuilder sb = new StringBuilder();
        sb.append(Thread.currentThread().toString());
        sb.append("@");
        sb.append(Integer.toHexString(hashCode()));
        return sb.toString();
    }
 
}