20. 函数和变量¶

Regex 函数用于使用任何正则表达式（由用户提供）解析先前的响应（或变量的值）。该函数返回填充了变量值的模板字符串。

__regexFunction还可以存储值以供将来使用。在第六个参数中，您可以指定一个引用名称。执行此函数后，稍后可以使用用户定义值的语法检索相同的值。例如，如果您输入“ refName ”作为第六个参数，您将能够使用：

• ${refName}引用此函数解析的第二个参数（“替换字符串的模板”）的计算结果
• ${refName_g0}引用此函数解析的整个匹配项。
• ${refName_g1}引用此函数解析的第一个组。
• ${refName_g#}引用此函数解析的第 n^个组。
• ${refName_matchNr}引用此函数找到的组数。

计数器每次调用时都会生成一个新数字，从 1 开始，每次递增 +1。计数器可以配置为将每个模拟用户的值分开，或者为所有用户使用相同的计数器。如果每个用户的值分别递增，这就像计算测试计划的迭代次数。全局计数器就像计算该请求运行了多少次。

计数器使用一个整数变量来保存计数，因此它的最大值为 2,147,483,647。

计数器函数实例是完全独立的。全局计数器 - “ FALSE ” - 由每个计数器实例单独维护。

同一迭代中的多个__counter函数调用不会进一步增加该值。
如果您想要为每个样本增加一个计数，请使用预处理器中的函数，例如User Parameters。

线程号函数只是返回当前正在执行的线程号。这些数字仅相对于它们的 ThreadGroup 是局部唯一的，这意味着从这个函数的角度来看，一个线程组中的线程 #1 与另一个线程组中的线程 #1 无法区分。

ctx.getThreadNum()

此函数没有参数。

使用示例：

${__threadNum}

线程组名称函数只返回正在执行的线程组的名称。

此函数没有参数。

使用示例：

${__threadGroupName}

intSum 函数可用于计算两个或多个整数值的总和。

longSum 函数可用于计算两个或多个 long 值的总和，只要您知道您的值不在 -2147483648 到 2147483647 的区间内，请使用它而不是 __intSum。

StringFromFile 函数可用于从文本文件中读取字符串。这对于运行需要大量可变数据的测试很有用。例如，在测试银行应用程序时，可能需要 100 或 1000 个不同的帐号。

另请参阅 可能更易于使用的CSV 数据集配置测试元素。但是，目前不支持多个输入文件。

每次调用它都会从文件中读取下一行。所有线程共享同一个实例，因此不同的线程将得到不同的行。当到达文件末尾时，它将重新从头开始读取，除非已达到最大循环计数。如果测试脚本中有多个对该函数的引用，则每个引用都将独立打开文件，即使文件名相同。[如果要在其他地方再次使用该值，请为每个函数调用使用不同的变量名。]

如果打开或读取文件发生错误，则函数返回字符串“ **ERR** ”

machineName 函数返回本地主机名。这使用 Java 方法InetAddress.getLocalHost()并将其传递给getHostName()

machineIP 函数返回本地 IP 地址。这使用 Java 方法InetAddress.getLocalHost()并将其传递给getHostAddress()

javaScript 函数执行一段 JavaScript（不是 Java！）代码并返回其值

JMeter Javascript 函数调用一个独立的 JavaScript 解释器。Javascript用作脚本语言，因此您可以进行计算等。

以下变量可用于脚本：

• log -函数的Logger
• ctx - JMeterContext对象
• vars - JMeterVariables对象
• threadName - 包含当前线程名称的字符串
• sampler - 当前的Sampler对象（如果有）
• sampleResult - 以前的 SampleResult对象（如果有）
• props - JMeterProperties（类java.util.Properties）对象

Rhinoscript 允许通过其 Packages 对象访问静态方法。请参阅脚本 Java文档。例如，可以访问 JMeterContextService 静态方法： Java.type("org.apache.jmeter.threads.JMeterContextService").getTotalThreads()

random 函数返回一个介于给定最小值和最大值之间的随机数。

RandomDate 函数返回一个介于给定开始日期和结束日期值之间的随机日期。

RandomString 函数使用要使用的字符中的字符返回长度的随机字符串。

RandomFromMultipleVars 函数根据Source Variables提供的变量值返回一个随机值。

• 边界提取器
• 正则表达式提取器
• CSS 选择器提取器
• JSON 提取器
• XPath 提取器
• XPath2 提取器

UUID 函数返回一个伪随机类型 4 通用唯一标识符 (UUID)。

CSVRead 函数从 CSV 文件中返回一个字符串 (cf StringFromFile )

注意：JMeter 支持多个文件名。

在大多数情况下，较新的 CSV 数据集配置元素 更易于使用。

当第一次遇到文件名时，文件被打开并读入一个内部数组。如果检测到空行，则将其视为文件结尾 - 这允许使用尾随注释。

对相同文件名的所有后续引用都使用相同的内部数组。注意文件名大小写对函数很重要，即使操作系统不关心，所以CSVRead(abc.txt,0)和CSVRead(aBc.txt,0)将引用不同的内部数组。

*ALIAS功能允许多次打开同一个文件，也允许使用更短的文件名 。

每个线程都有自己的内部指针，指向文件数组中的当前行。当一个线程第一次引用该文件时，它将被分配到数组中的下一个空闲行，因此每个线程将访问与所有其他线程不同的行。[除非线程数多于数组中的行数。]

属性函数返回 JMeter 属性的值。如果找不到属性值，并且没有提供默认值，则返回属性名称。提供默认值时，无需提供函数名称 - 参数可以设置为 null，它将被忽略。

• ${__property(user.dir)} - user.dir的返回值
• ${__property(user.dir,UDIR)} - user.dir的返回值并保存在UDIR
• ${__property(abcd,ABCD,atod)} - 属性abcd的返回值（或“ atod ”，如果未定义）并保存在ABCD
• ${__property(abcd,,atod)} - 属性abcd的返回值（或“ atod ”，如果未定义）但不保存它

这是一个简化的属性函数，旨在与命令行上定义的属性一起使用。与__property函数不同，没有将值保存在变量中的选项，如果没有提供默认值，则假定为 1。选择 1 的值是因为它对循环等常见测试变量有效，线程数，斜升等。

定义属性值：

jmeter -Jgroup1.threads=7 -Jhostname1=www.realhost.edu

log 函数记录一条消息，并返回其输入字符串

logn 函数记录一条消息，并返回空字符串

BeanShell 函数评估传递给它的脚本，并返回结果。

有关使用 BeanShell 的完整详细信息，请参阅 BeanShell 网站http://www.beanshell.org/

可以从多个线程调用函数的单个实例。但是函数execute()方法是同步的。

如果定义了属性“ beanshell.function.init ”，它将作为源文件的名称传递给解释器。这可用于定义常用方法和变量。bin 目录中有一个示例初始化文件：BeanShellFunction.bshrc。

在执行脚本之前设置以下变量：

• log - BeanShell 函数的Logger (*)
• ctx - JMeterContext对象
• vars - JMeterVariables对象
• props - JMeterProperties（类java.util.Properties）对象
• threadName - 线程名（字符串）
• Sampler - 当前的Sampler（如果有）
• SampleResult - 当前的SampleResult（如果有）

__groovy函数评估传递给它 的Apache Groovy脚本，并返回结果。

如果定义了属性“ groovy.utilities ”，它将由 ScriptEngine 加载。这可用于定义常用方法和变量。bin目录中有一个示例初始化文件：utility.groovy。

在执行脚本之前设置以下变量：

• log - groovy 函数的Logger (*)
• ctx - JMeterContext对象
• vars - JMeterVariables对象
• props - JMeterProperties（类java.util.Properties）对象
• threadName - 线程名（字符串）
• sampler - 当前的Sampler，如果有的话
• prev - 上一个SampleResult（如果有）
• OUT - System.out

(*) 表示这是在处理初始化文件（如果有）之前设置的。其他变量因调用而异。

例如，不要执行以下操作：

${__groovy("${myVar}".substring(0\,2))}

想象一下，变量 myVar 随每次交易而变化，上面的 Groovy 无法缓存，因为脚本每次都在变化。

而是执行以下操作，可以缓存：

${__groovy(vars.get("myVar").substring(0\,2))}

split 函数根据分隔符将传递给它的字符串拆分，并返回原始字符串。如果任何分隔符相邻，则返回“ ？ ”作为值。拆分字符串在变量${VAR_1}、${VAR_2}等中返回。变量的计数在${VAR_n}中返回。尾随分隔符被视为缺失变量，并返回“ ？ ”。此外，为了让它更好地与 ForEach 控制器一起工作， __split现在删除第一个未使用的变量，以防它是由先前的拆分设置的。

${__split(${VAR},VAR,|)}

XPath 函数读取一个 XML 文件并匹配 XPath。每次调用该函数时，都会返回下一个匹配项。在文件末尾，它将环绕到开头。如果没有节点匹配，则函数将返回空字符串，并将警告消息写入 JMeter 日志文件。

${__XPath(/path/to/build.xml, //target/@name)}

setProperty 函数设置 JMeter 属性的值。函数的默认返回值是空字符串，因此函数调用可以在函数有效的任何地方使用。

^{可以通过将可选的第三}个参数设置为“ true ”来返回原始值。

属性对 JMeter 来说是全局的，因此可以用来在线程和线程组之间进行通信

time 函数以各种格式返回当前时间。

jexl 函数返回计算 Commons JEXL 表达式的结果。有关 JEXL 表达式的更多信息，请参阅下面的链接。

__jexl2函数使用 Commons JEXL 2

• JEXL 语法说明
• JEXL 示例

jexl 函数返回计算 Commons JEXL 表达式的结果。有关 JEXL 表达式的更多信息，请参阅下面的链接。

__jexl3函数使用 Commons JEXL 3

• JEXL 语法说明
• JEXL 示例

V（变量）函数返回对变量名表达式求值的结果。这可用于评估嵌套变量引用（当前不支持）。

例如，如果有变量A1、A2和N = 1：

• ${A1} - 工作正常
• ${A${N}} - 不起作用（嵌套变量引用）
• ${__V(A${N})} - 工作正常。A${N}变为A1，__V函数返回A1的值

evalVar 函数返回计算存储在变量中的表达式的结果。

这允许人们从文件中读取字符串，并处理其中的任何变量引用。例如，如果变量“ query ”包含“ select ${column} from ${table} ”并且“ column ”和“ table ”包含“ name ”和“ customers ”，则${__evalVar(query)} 将评估为“从客户中选择名称”。

eval 函数返回计算字符串表达式的结果。

这允许在存储在变量中的字符串中插入变量和函数引用。例如，给定以下变量：

• 姓名=史密斯
• 列=年龄
• 表=生日
• SQL = select ${column} from ${table} where name='${name}'

这可以与 CSV 数据集结合使用，例如 SQL 语句和值都在数据文件中定义。

char 函数将计算数字列表的结果作为 Unicode 字符返回。另请参见下面的__unescape()。

这允许将任意字符值添加到字段中。

unescape 函数返回对 Java 转义字符串求值的结果。另请参见上面的__char()。

这允许人们向字段添加字符，否则这些字符很难通过 GUI 定义（或不​​可能）。

将包含 HTML 实体转义的字符串转义为包含与转义对应的实际 Unicode 字符的字符串的函数。支持 HTML 4.0 实体。

例如，字符串

${__unescapeHtml(<Français>)}

如果一个实体无法识别，则将其单独放置，并逐字插入结果字符串中。例如${__unescapeHtml(>&zzzz;x)}将返回>&zzzz;x。

使用来自 Commons Lang 的 StringEscapeUtils#unescapeHtml(String) 。

使用 HTML 实体对字符串中的字符进行转义的函数。支持 HTML 4.0 实体。

例如，

${__escapeHtml("bread" & "butter")}

使用来自 Commons Lang 的 StringEscapeUtils#escapeHtml(String) 。

解码application/x-www-form-urlencoded字符串的函数。注意：使用 UTF-8 作为编码方案。

例如，字符串

${__urldecode(Word+%22school%22+is+%22%C3%A9cole%22+in+french)}

使用 Java 类URLDecoder。

将字符串编码为application/x-www-form-urlencoded字符串的函数。

例如，字符串

${__urlencode(Word "school" is "école" in french)}

使用 Java 类URLEncoder。

FileToString 函数可用于读取整个文件。每次调用它都会读取整个文件。

如果打开或读取文件发生错误，则函数返回字符串“ **ERR** ”

samplerName 函数返回当前采样器的名称（即标签）。

该功能在没有关联采样器的测试元素中不起作用。例如测试计划。配置元素也没有关联的采样器。然而，一些配置元素被采样器直接引用，例如 HTTP Header Manager 和 Http Cookie Manager，在这种情况下，函数在 Http Sampler 的上下文中解析。预处理器、后处理器和断言总是有一个关联的采样器。

例子：

${__samplerName()}

TestPlanName 函数返回当前测试计划的名称（可以在 Include Plans 中使用以了解调用测试计划的名称）。

转义ORO Regexp 元字符的函数，它相当于Java Regexp Engine 中的\Q \E。

例如，

${__escapeOroRegexpChars([^"].+?,)}

使用来自 ORO 的 Perl5Compiler#quotemeta(String)。

使用 XML 1.0 实体对字符串中的字符进行转义的函数。

例如，

${__escapeXml("bread" & 'butter')}

使用来自 Commons Lang 的 StringEscapeUtils#escapeXml10(String) 。

timeShift 函数返回给定格式的日期，并添加指定的秒数、分钟数、小时数、天数或月数

摘要函数返回特定散列算法中的加密值，带有可选的盐、大写字母和变量名。

__dateTimeConvert函数将源格式的日期转换为目标格式，将结果可选地存储在变量名称中。

__isPropDefined函数如果属性存在则返回 true，否则返回 false 。

__isVarDefined函数如果变量存在则返回 true，否则返回 false 。

change case 函数返回一个字符串值，该值已按照特定模式更改。结果可以选择保存在 JMeter 变量中。

__StringToFile函数可用于将字符串写入文件。每次调用它时，它都会将一个字符串写入文件追加或覆盖。

函数的默认返回值是空字符串