JMeter内置变量大揭秘：含义，用法和实例

在JMeter中，有一些内置的变量，可以帮助我们在测试过程中存储和使用一些数据。这些内置变量有四种：vars，props，prev和sample。

vars变量

vars变量是JMeterVariables类的一个实例，它是一个Map类型的对象，可以存储String或Object类型的数据。vars变量的作用域是当前线程组，也就是说，只有同一个线程组内的线程才能访问和修改同一个vars变量。如果不同的线程组需要共享数据，就不能使用vars变量。

vars变量的使用方法很简单，我们可以在BeanShell Sampler或JSR223 Sampler中使用以下语法来获取和设置vars变量：

// JSR233  groovy 脚本
//获取vars变量
String value = vars.get("key");
Object obj = vars.getObject("key");

//设置vars变量
vars.put("key", "value");
vars.putObject("key", new Object());

直接使用${key}来引用vars变量的值。

vars变量的一个常见用途是保存上一个请求的响应数据，以便后续请求使用。例如，我们可以在
JSR233PostProcessor中使用以下代码的一些实例：

又比如从 csv 文件中读取数据，并保存到一个list对象中：

然后从其他取样器中使用这个对象：

props变量

props变量是JMeterProperties类的一个实例，它是一个Hashtable类型的对象，也可以存储String或Object类型的数据。props变量的作用域是全局的，也就是说，所有的线程组都可以访问和修改同一个props变量。如果不同的线程组需要共享数据，就可以使用props变量。

props变量的使用方法和vars变量类似，我们可以在BeanShell Sampler或JSR223
Sampler中使用以下语法来获取和设置props变量：

//获取props变量
String value = props.get("key");
Object obj = props.get("key");

//设置props变量
props.put("key", "value");
props.put("key", new Object());

我们也可以在其他元件中使用${__P(key)}来引用props变量的值。

props变量的一个常见用途是保存一些全局配置参数，例如服务器地址，端口号等。例如，我们可以在Test Plan中使用User Defined
Variables元件来定义一些props变量：

然后，在其他地方，我们可以使用${__P(server)}来引用服务器地址。

prev变量

prev变量是SampleResult类的一个实例，它是一个对象，可以存储上一个请求(或者说上一个取样器)的结果信息。prev变量的作用域是当前线程组，并且只能在后置处理器(PostProcessor)或断言(Assertion)中使用。

prev变量的使用方法是在BeanShell PostProcessor或JSR223
PostProcessor中使用以下语法来获取prev变量：

SampleResult prev = ctx.getPreviousResult();

然后，我们可以调用prev对象的各种方法来获取结果信息，例如：

prev变量的一个常见用途是对上一个请求的结果进行处理或判断。例如，我们可以在BeanShell
Assertion中使用以下代码来判断响应码是否为200：

SampleResult prev = ctx.getPreviousResult();
if (!"200".equals(prev.getResponseCode())) {
    AssertionResult result = new AssertionResult("检查检查状态码");
    result.setFailure(true);
    result.setFailureMessage("响应状态码鬼知道是啥，反正不是 200");
    prev.addAssertionResult(result);
    prev.setSuccessful(false);
}

当前了，你要是直接在jsr233或者beanshell中直接如下那样写，也不会出现错误，也能直接使用。

//jsr233 中的代码
def responseCode = prev.getResponseCode();

sample变量

sample变量是SampleEvent类的一个实例，它是一个对象，可以存储当前请求(或者说当前取样器)的事件信息。sample变量的作用域是当前线程组，能在监听器(Listener)中使用。

sample变量的使用方法是在BeanShell Listener或JSR223 Listener中使用以下语法来获取sample变量：

SampleEvent sample = ctx.getCurrentSampleEvent();

然后，我们可以调用sample对象的各种方法来获取事件信息，例如：

//获取取样器结果
SampleResult result = sample.getResult();
//获取线程名称
String threadName = sample.getThreadName();
//获取线程组名称
String threadGroupName = sample.getThreadGroup();
//获取主机名称
String hostName = sample.getHostname();

sample变量的一个常见用途是对当前请求的事件进行处理或记录。例如，我们可以在BeanShell Listener中使用以下代码来打印事件信息：

SampleEvent sample = ctx.getCurrentSampleEvent();
log.info("Thread name: " + sample.getThreadName());
log.info("Thread group: " + sample.getThreadGroup());
log.info("Host name: " + sample.getHostname());
log.info("Sampler name: " + sample.getResult().getSampleLabel());
log.info("Response time: " + sample.getResult().getTime());
log.info("Response code: " + sample.getResult().getResponseCode());
log.info("Response data: " + new String(sample.getResult().getResponseData()));

内置变量的区别

从上面的介绍可以看出，JMeter内置变量有以下几个区别：

• vars和props都是Map类型的对象，可以存储和修改数据;prev和sample都是普通对象，只能读取数据。
• vars和props都可以在任何地方引用;prev只能在后置处理器或断言中引用;sample只能在监听器中引用。
• vars和props都需要手动设置和获取;prev和sample都由JMeter自动提供。
• vars只能在当前线程组内共享;props可以跨线程组共享;prev和sample只能在当前线程内访问。
• vars和props都只能存储String或Object类型;prev和sample都包含多种类型的数据。

内置变量的实际工作场景

来看一些实际工作场景：

场景一：我们需要模拟用户上传文件，并且每个用户都要上传不同的文件。这时候，我们就可以使用JSR223
PreProcessor元件来动态生成一个文件名，并将它保存到props变量中。然后，在上传文件请求中，我们就可以使用${__P(filename)}来引用文件名。

//在JSR223 PreProcessor的代码如下：
import java.util.UUID
//生成一个随机的UUID作为文件名
String filename = UUID.randomUUID().toString() + ".txt"
//将文件名保存到props变量中
props.put("filename", filename)

场景二：我们需要对每个请求的响应时间进行判断，如果超过了预期的时间，就要记录下来。这时候，我们就可以使用JSR223 Assertion元件来获取prev变量，并调用getTime()方法来获取响应时间。然后，我们就可以使用if语句来判断响应时间是否超过了预期，并使用log.info()方法来记录日志。

//在JSR223 Assertion 中的代码如下：
def prev = ctx.getPreviousResult()
//获取响应时间
def responseTime = prev.getTime()
//设置预期时间为1000毫秒
def expectedTime = 1000
//判断响应时间是否超过预期
if (responseTime > expectedTime) {
    // 这里建议将结果写入 csv 以便持久化查看
    log.info("响应时间是：${responseTime} ms, 预期时间是：${expectedTime} ms")
}

场景三：我们需要对每个请求的响应数据进行处理，如果包含了某些关键字，就要提取出来，那么则如下：

//在JSR223 PostProcessor 中的代码如下：
def prev = ctx.getPreviousResult()
def responseData = prev.getResponseDataAsString()
// 使用正则处理数据
def regex = /(.*?)/
def matcher = regex.matcher(responseData)
if (matcher.find()) {
    def keyword = matcher.group(1)
    vars.put("keyword", keyword)
}
// 当然除了上述代码外，也可以直接使用正则匹配元件去处理。

场景四：我们需要对每个请求的事件信息进行记录，例如线程名称，线程组名称，主机名称等，那么则如下：

//在JSR223 Listener 中的代码
def sample = ctx.getCurrentSampleEvent()
def result = sample.getResult()
//打印事件信息到日志文件中，建议处理到csv（不过会有一点性能开销）
log.info("线程名称: " + sample.getThreadName())
log.info("线程组名: " + sample.getThreadGroup())
log.info("域名地址: " + sample.getHostname())
log.info("取样器名: " + result.getSampleLabel())
log.info("响应时间: " + result.getTime())
log.info("响应编码: " + result.getResponseCode())
log.info("响应数据: " + new String(result.getResponseData()))