jmeter函数和变量（一）

概述

对jmeter函数进行一次全面复习，依据是官网的文档版本3.2。本来想一篇写完的，中间做项目和一些杂事拖了2个礼拜，再回来写的时候发现太长了~还是分开写比较妥当。先放出一部分吧。

函数和变量

JMeter函数是一种特殊的值，可以在测试树中填充任何采样器或其他元素的字段。函数调用如下:

${__functionName(var1,var2,var3)}

“__functionName”与具体的函数名匹配。圆括号内是传递给函数的参数，例如${__time(YMD)}，实际的参数因函数而异。不需要参数的函数可以去掉括号，例如${__threadNum}。
如果一个函数参数包含一个逗号，那么一定要用”\”来转义，否则JMeter将把它作为一个参数分隔符。
例如:

${__time(EEE\, d MMM yyyy)}

如果逗号没有转义，将会有异常抛出

${__javaScript(Math.max(2,5))} 

ERROR - jmeter.functions.JavaScript: Error processing Javascript: [Math.max(2]
        org.mozilla.javascript.EvaluatorException: missing ) after argument list (<cmd>#1)

这是因为字符串”Math.max(2,5)”被看作是__javascript函数的两个参数:”Math.max(2” 和 “5)”
变量被引用如下:

${VARIABLE}

如果引用一个未定义的函数或变量，JMeter不会报告/记录一个错误——引用没有改变。例如，如果没有定义变量UNDEF，那么${UNDEF}的值就是${UNDEF}。变量，函数（或者属性）都是区分大小写的。在使用jmeter变量之前，JMeter会删除变量前后的空格，例如${__Random(1,63, LOTTERY )}将会使用变量’LOTTERY’而不是’ LOTTERY ‘（这个前后各有一个空格）。

属性与变量不同。变量是线程的局部变量;属性在所有线程中都是通用的，并且需要使用__P或__property函数来引用。

当在一个windows路径的变量之前使用”\”，例如C:\test\${test}，确保转义，否则JMeter将不会解释变量，例如:C:\\test\\${test}。或者，只使用/替代路径分隔符-例如C:/test/$test-Windows jvms将根据需要转换分隔符。

摘自官网：

Type of function	Name	Comment	Since
Information	threadNum	get thread number	1.X
Information	samplerName	get the sampler name (label)	2.5
Information	machineIP	get the local machine IP address	2.6
Information	machineName	get the local machine name	1.X
Information	time	return current time in various formats	2.2
Information	log	log (or display) a message (and return the value)	2.2
Information	logn	log (or display) a message (empty return value)	2.2
Input	StringFromFile	read a line from a file	1.9
Input	FileToString	read an entire file	2.4
Input	CSVRead	read from CSV delimited file	1.9
Input	XPath	Use an XPath expression to read from a file	2.0.3
Calculation	counter	generate an incrementing number	1.X
Calculation	intSum	add int numbers	1.8.1
Calculation	longSum	add long numbers	2.3.2
Calculation	Random	generate a random number	1.9
Calculation	RandomFromMultipleVars	extracts an element from the values of a set of variables separated by
Calculation	RandomString	generate a random string	2.6
Calculation	UUID	generate a random type 4 UUID	2.9
Scripting	groovy	run a Groovy script	3.1
Scripting	BeanShell	run a BeanShell script	1.X
Scripting	javaScript	process JavaScript (Nashorn)	1.9
Scripting	jexl2	evaluate a Commons Jexl2 expression	jexl2(2.1.1)
Scripting	jexl3	evaluate a Commons Jexl3 expression	jexl3 (3.0)
Properties	property	read a property	2
Properties	P	read a property (shorthand method)	2
Properties	setProperty	set a JMeter property	2.1
Variables	split	Split a string into variables	2.0.2
Variables	V	evaluate a variable name	2.3RC3
Variables	eval	evaluate a variable expression	2.3.1
Variables	evalVar	evaluate an expression stored in a variable	2.3.1
String	regexFunction	parse previous response using a regular expression	1.X
String	escapeOroRegexpChars	quote meta chars used by ORO regular expression	2.9
String	char	generate Unicode char values from a list of numbers	2.3.3
String	unescape	Process strings containing Java escapes (e.g. \n & \t)	2.3.3
String	unescapeHtml	Decode HTML-encoded strings	2.3.3
String	escapeHtml	Encode strings using HTML encoding	2.3.3
String	escapeXml	Encode strings using XMl encoding	3.2
String	urldecode	Decode a application/x-www-form-urlencoded string	2.1
String	urlencode	Encode a string to a application/x-www-form-urlencoded string	2.1
String	TestPlanName	Return name of current test plan	2.6

函数能做什么

有两种函数:用户定义的静态值(或变量)和内置函数。
用户定义的静态值允许用户定义变量，当测试树被编译并提交运行时，这些变量将被替换为静态值。
替换在测试运行第一次开始时发生。用于替换所有HTTP请求的域字段，例如，将同一个测试用例测试不同服务器的将变成一个简单的问题。
注意：变量不能被嵌套，例如${Var${N}}将不起作用. __V (variable)函数可以用来做变量替换: ${__V(Var${N})}. 你也可以使用 ${__BeanShell(vars.get(“Var${N}”)}.
这种类型的替换在没有函数的情况下是可能的，但是不那么方便，也不那么直观。它要求用户创建默认的配置元素，这些元素将填充Samplers的空白值。变量允许只替换任何给定值的一部分，而不只是填充空白值。
有了内置函数，用户可以在运行时根据之前的响应数据计算新值，以及该函数所在的线程、耗时和许多其他信息。在整个测试过程中，这些值会在每个请求后刷新。

函数是线程共享的，在测试中每次函数调用由函数的不同实例处理

函数和变量在哪里使用

函数和变量可以写入任何测试组件的任何字段(除了测试计划之外)。有些字段不允许随机字符串，因为它们期望数字，因此不会接受一个函数。但是，大多数字段都允许函数。
在测试计划中使用的函数有一些限制。在处理函数时，JMeter线程变量将不会被完全设置，因此变量名作为一个参数传入，不会被设置，变量引用也不会起作用，因此split()和regex()和变量评估函数将不会起作用。threadNum()函数不会起作用(在测试计划级别上没有意义)。以下功能应该在测试计划中起作用:

• intSum
• longSum
• machineName
• BeanShell
• groovy
• javaScript
• jexl2/jexl3
• random
• time
• property functions
• log functions

配置元素由一个单独的线程处理。因此，诸如__threadNum这样的函数在诸如用户定义的变量之类的元素中不能正常工作。还要注意，在UDV元素中定义的变量在处理元素之前是不可用的。

在SQL中使用变量/函数引用是，记得字符串包含必要的引号

SELECT item from table where name=’${VAR}’

而不是

SELECT item from table where name=${VAR}

(除非字符串本身包含引号)

如何引用变量和函数

在测试元素中引用变量是通过 ‘${}’将变量包含起来 如${var}。
函数以相同的方式引用，但按照约定，函数名以”__”开头，避免与用户值名称冲突，一些函数使具有参数，这些函数参数以逗号分隔。如果函数不带参数，则可以省略括号。若参数值本身包含逗号，应该在必要时转义: “\,”,这适用于脚本函数——Javascript、Beanshell、Jexl、groovy在脚本方法调用中，需要避免任何可能需要的逗号。

${__BeanShell(vars.put("name"\,"value"))}

另外一种方法可以将脚本定义成一个变量:

SCRIPT vars.put("name","value")
脚本可以引用如下：
${__BeanShell(${SCRIPT})}

这里不需要转义SCRIPT变量中的逗号，因为函数调用在变量替换为它的值之前被解析。这与JSR223或BeanShell的采样器能够很好的配合，因为这些可以用来测试Javascript、Jexl和BeanShell脚本。
函数可以引用变量和其他函数，例如${__XPath(${__P(xpath.file),${XPATH})} 将使用属性”xpath.file”作为文件名，变量XPATH要搜索的表达式的内容。
JMeter提供了一个工具来帮助构造函数调用，用于各种内建函数，然后就可以复制粘贴了。
它不会自动转义，因为函数可以是其他函数的参数，应该只转义想要的值。

If a string contains a backslash(‘\’) and also contains a function or variable reference, the backslash will be removed if it appears before ‘$’ or ‘,’ or ‘\’. This behaviour is necessary to allow for nested functions that include commas or the string ${. Backslashes before ‘$’ or ‘,’ or ‘\’ are not removed if the string does not contain a function or variable reference.

变量或函数的值可以使用__logn()函数进行报告。在定义变量之后，__logn()函数引用可以在测试计划的任何地方使用。或者，可以使用Java请求采样器可以创建包含变量引用的样例;输出将显示在适当的侦听器中。

注意，在树视图监听器中有一个可以用来显示变量值的调试采样器（Debug Sampler）。
如果定义一个用户定义的静态变量，其名称与内置函数相同，那么您的静态变量将会覆盖内置函数。

函数帮助对话框

函数帮助对话框可以从Jmeter的菜单中调出

使用函数帮助器，您可以从下拉中选择一个函数，并为其参数指定值。表中的左列提供了对该参数的简要描述，而右边的列是您在该参数的值中写入的位置。不同的函数有不同的参数。
一旦您完成了这个操作，点击“generate”按钮，就会生成适当的字符串，以便您可以在您喜欢的地方复制粘贴到您的测试计划中。

函数

__regexFunction

函数用于使用任何正则表达式(由用户提供)解析以前的响应(或变量的值)。函数返回带有变量值的模板字符串。
__regexFunction还可以存储起来，以便供后续使用。在第六个参数中，可以指定一个引用名称。在执行该函数之后，可以在稍后使用用户定义值的语法检索相同的值。
例如，如果您输入”refName”作为第六个参数，您将能够使用:

• ${refName}来引用第2个参数（替换字符串模板）的计算结果，这依赖于函数的解析结果。
• ${refName_g0}来引用函数解析后发现的所有匹配结果。
• ${refName_g1}来引用函数解析后发现的第一个匹配组合。
• ${refName_g#}来引用函数解析后发现的第n个匹配组合。
• ${refName_matchNr}来引用函数总共发现的匹配组合数目

Attribute	Description	Required
第1个参数	第1个参数是用于解析服务器响应数据的正则表达式。它会找到所有匹配项。如果希望将表达式中的某部分应用在模板字符串中，一定记得为其加上圆括号。例如，<a href=”(.*)”>。这样就会将链接的值存放到第一个匹配组合中（这里只有一个匹配组合）。又如，。在这个例子中，链接的name作为第一个匹配组合，链接的value会作为第二个匹配组合。这些组合可以用在的模板字符串中	是
第2个参数	这是一个模板字符串，函数会动态填写字符串的部分内容。要在字符串中引用正则表达式捕获的匹配组合，请使用语法：$[group_number]$。例如$1$或者 $2$。的模板可以是任何字符串	是
第3个参数	第3个参数告诉JMeter使用第几次匹配。正则表达式可能会找到多个匹配项。对此，有4种选择：1）整数，直接告诉JMeter使用第几个匹配项。”1”对应第一个匹配，”2”对应第二个匹配，以此类推2）RAND，告诉JMeter随机选择一个匹配项3）ALL，告诉JMeter使用所有匹配项，为每一个匹配项创建一个模板字符串，并将它们连接在一起4）浮点值0到1之间，根据公式（找到的总匹配数目*指定浮点值）计算使用第几个匹配项，计算值向最近的整数取整	否，默认值为1
第4个参数	如果在上一个参数中选择了”ALL”，那么这第4个参数会被插入到重复的模板值之间,就是说有多个地方匹配模版，这多个匹配之间用该参数的值进行分割	否
第5个参数	如果没有找到匹配项返回的默认值	否
第6个参数	重用函数解析值的引用名。存储${refName}和${refName_g#} “#”是正则表达式匹配到组的数量(“0”可以使用，是全部匹配)	否
第7个参数	输入变量名称。如果指定了这一参数，那么该变量的值就会作为函数的输入，而不再使用前面的采样结果作为搜索对象	否

举个栗子！还是以百度的首页搜索为例。一共有两个断言，见截图。

第一个断言正则表达式$1$ $2$返回结果为kw wd；第二个断言直接引用refName_g0(在第一个断言中使用的第六个参数),结果为<input id=kw name=wd class=s_ipt value maxlength=255

因为在上面的例子中正则表达式中并没有出现多个匹配的模版所以设置的第四个参数tmp没有起作用，下面做个演示只是用http关键字进行匹配，并制定第四个参数为SSS

是不是第四个参数已经生效了

现在演示一下正则表达式中应用自定义变量

__counter

这个函数是一个计数器，用于统计函数的使用次数，从1开始每次加1。计数器既可以被配置成针对每个虚拟用户是独立的，也可以被配置成所有虚拟用户公用的。如果每个虚拟用户的计数器是独立增长的，那么通常被用于记录测试计划运行了多少遍。全局计数器通常被用于记录发送了多少次请求。计数器使用一个整数值来记录，允许的最大值为2,147,483,647。
计数器函数实例是完全独立的。全局计数器 “FALSE”是由每个计数器实例单独维护的。
在同一个迭代中，多个计数器函数(__counter)调用不会进一步增加值。如果想要为每个示例增加一个增量，请在预处理程序中使用该函数，例如用户参数。

Attribute	Description	Required
第1个参数	True，如果希望每个虚拟用户的计数器保持独立，与其他用户的计数器相区别。false，全局计数器	是
第2个参数	重用计数器函数创建值的引用名。可以这样引用计数器的值：${refName}。这样就可以创建一个计数器后，在多个地方引	否

格式：${__counter(FALSE,test)}

我们将”__counter”函数生成的参数复制到某个参数下面(一般使用的时候会放在对应的取样器中，见__threadNum例子)，如果为TRUE格式，则每个线程各自统计，最大数为循环数，如果为FALSE，则所有线程一起统计，最大数为线程数乘以循环数
下面是设置了10个线程循环5次执行的结果：自定义的mycountervar在持续增加~~

当然也可以使用线程组的配置元件–计数器来实现计数

__threadNum

函数__threadNum只是简单地返回当前线程的编号。线程编号不依赖于线程组，这就意味着从函数的角度看来，某个线程组的线程#1和另一个线程组的线程#1是没有区别的。另外，该函数没有参数。
格式：${__threadNum}
返回一个1到线程组中配置的运行线程的最大数之间的一个数字
这一函数不能用在任何配置元件中（如用户定义的变量），原因在于配置元件是由一个独立线程运行的。另外在测试计划（Test Plan）中使用也是没有意义的。

__intSum

__intSum函数分别用来进行整型。这两个函数均为可变参数列表的函数，可用来进行任意个整型数据的加法运算。
用于计算多个整数的和,可以是计算正整数和负整数的和,它有N个参数,最少有3个参数,最多不限。最后一个参数是函数名称，前面的其它参 数是要求和的整数。这个函数在函数对话框中只显示3个参数，如果要计算多个整数，可以通过添加参数实现，不过最后一个参数一定要是函数名称。再添加的参数 会在函数名称后面，这个时候，需要我们手动将函数名称参数放到最后一个。

Attribute	Description	Required
第1个参数	第1个整数值	是
第2个参数	第2个整数值	是
…	…	…
第n个参数	第n个整数值	否
最后一个参数	函数计算值的引用名。如果用户指定了这一参数，那么引用名中必须包含一个非数字字母，否则它会被当成另一个整数值，而被函数用于计算	否

 
在HTTP请求中设置函数，经过调试查看保存计算的结果

__longSum

__longSum与__intSum函数分别用来进行长整型和整型数据的加法运算，几乎一样
不再做介绍
见__intSum

__StringFromFile

函数__StringFromFile可以被用来从文本文件中读取字符串。这对于需要大量可变数据的测试很有用。例如，当测试一个银行应用系统时，可能需要100条甚至1000条账户信息。

使用配置元件CSV Data Set Config ，也能达到相同的目的，而且方法更简单。但是该配置元件目前不支持多输入文件。

每次调用函数，都会从文件中读取下一行。当到达文件末尾时，函数又会从文件开始处重新读取，直到最大循环次数。如果在一个测试脚本中对该函数有多次引用，那么每一次引用都会独立打开文件，即使文件名是相同的（如果函数读取的值，在脚本其他地方也有使用，那么就需要为每一次函数调用指定不同的变量名）。

函数实例是在线程之间共享的，当线程需要输入时打开或重新打开文件，因此使用threadNumber作为文件名的一部分将导致不可预测的行为。

如果在打开或者读取文件时发生错误，那么函数就会返回字符串”**ERR**”。

Attribute	Description	Required
文件名	文件名(可以使用相对于JMeter启动目录的相对路径)。如果要在文件名中使用可选的序列号，那么文件名必须适合转成十进制格式。	是
变量名	一个引用名(refName),目的是复用这一函数创建的值。可以使用语法${refName}来引用函数创建的值。默认值为”StringFromFile_”	否
初始序列	号初始序列号(如果省略这一参数，终止序列号会作为一个循环计数器)	否
终止序列	号终止序列号(如果省略这一参数，序列号会一直增加下去，不会受到限 制)	否

 
当打开或者重新打开文件时，文件名参数将会被解析。
每次执行函数时，引用名参数（如果支持）将会被解析。

使用序列号：
当使用可选的序列号时，文件名需要使用格式字符串Java.text.DecimalFormat。当前的序列号会作为唯一的参数。如果不指明可选的初始序列号，就使用文件名作为起始值。一些有用的格式序列如下：

#：插入数字，数字前面不能有0，也不包含空格。

000：插入数字，包含3个数字组合，位数不足使用0在左侧补齐指定的位数，超过位数的按实际位置输出。

例如：

写法	解释
pin#’.’dat	pin1.dat, … pin9.dat, pin10.dat, … pin9999.dat
pin000’.’dat	pin001.dat … pin099.dat … pin999.dat … pin9999.dat
pin’.’dat#	pin.dat1, … pin.dat9 … pin.dat999

 
如果不希望某个格式字符被翻译，需要为它加上单引号。注意”.”是格式字符，必须被单引号所包含。
如果路径名不包含任何特殊的格式化字符，那么当前的序列号将被追加到名称中，否则将根据格式化指令插入数字。
如果省略了初始序列号，且指定了终止序列号，则终止序列号理解为循环的次数，文件将被重复执行指定次数，在这种情况下文件名将不被格式化转义，直接匹配。例如：

${_StringFromFile(PIN#'.'DAT,,1,2)}：读取 PIN1.DAT, PIN2.DAT。
${_StringFromFile(PIN.DAT,,,2)}：读取 PIN.DAT 两次。

注意： “.”在PIN.DAT并没有使用引号引着，在这个用例中起始序列号省略，所以文件名精确匹配

__machineName

函数__machineName返回本机的主机名。使用java方法InetAddress.getLocalHost()传给getHostName()。只有一个参数：引用名，非必须

Attribute	Description	Required
引用名	该函数返回值存储起来，以便复用	否

 

__machineIP

函数__machineIP返回本机的主机IP。使用java方法InetAddress.getLocalHost()传给getHostName()。只有一个参数：引用名，非必须

Attribute	Description	Required
引用名	该函数返回值存储起来，以便复用	否

Jmeter函数和变量（一） http://blog.csdn.net/yue530tomtom/article/details/76651040
Jmeter函数和变量（二） http://blog.csdn.net/yue530tomtom/article/details/77456506
Jmeter函数和变量（三） http://blog.csdn.net/yue530tomtom/article/details/77533426
Jmeter函数和变量（四） http://blog.csdn.net/yue530tomtom/article/details/77573247