Jmeter(五)_函数
JMeter提供了很多函数,如果能够熟练使用,可以为脚本带来很多方便。
JMeter函数是一种特殊值,可用于除测试计划外的任何组件。
函数调用的格式如下所示:
${__functionName(var1,var2,var3)}
其中,__functionName为函数名,括号内是函数的参数,无参数时可以不用括号,如${__UUID}
Tips:
如果参数包含逗号,那么一定要使用“\”来转义,否则JMeter会把它当作一个参数分隔符
实际使用时,可通过函数助手对话框选择函数,设置参数后,点击生成按钮生成函数字符串。
一、__BeanShell:beanshell函数
1、它有两个参数,第一个参数是要执行的语句,可以是beanshell语句或者是文件地址,是必选参数;第二个参数是保存结果的变量名称,非必选参数。
2、Example:
${__BeanShell(123*456)}:返回56088
${__BeanShell(source(“function.bsh”))}:会执行外部脚本function.bsh,并返回结果
${__BeanShell(import java.util.*;Properties props = System.getProperties();String osName = props.getProperty(“os.name”);if(osName.contains(“Windows”))return 443;return 8443;)}:判断端口
3、与beanshell元件比较:
该函数与beanshell元件(beanshell sampler、beanshell preprocess等)作用是一样的,只是beanshell函数更常用于一些简单的判断或计算等,可以把少量的脚本放在函数中直接赋值给一个变量,而不用总是添加beanshell元件。
二、__regexFunction:正则表达式函数
1、该函数使用用户提供的正则表达式来解析前面的服务器响应(或者是某个变量值)。函数会返回一个有模板的字符串,其中携带有可变的值。
2、__regexFunction还可以被用来保存值,以便供后续使用。在函数的第6个参数中,测试人员可以指定一个引用名。在函数执行以后,测试人员可以使用用户定义值的语法来获取同样的值。例如,如果测试人员输入"refName"作为第6个参数,那么测试人员可以使用:
${refName}来引用第2个参数(Template for the replacement string)的计算结果,这依赖于函数的解析结果。
${refName_g0}来引用函数解析后发现的所有匹配结果。
${refName_g1}来引用函数解析后发现的第一个匹配组合。
${refName_g#}来引用函数解析后发现的第n个匹配组合。
${refName_matchNr}来引用函数总共发现的匹配组合数目。
具体参数描述如下:
其实这个函数的作用跟正则表达式提取器的作用是类似的。
三、__counter:计数器函数
1、每次调用计数器函数都会产生一个新值,从1开始每次加1。计数器既可以被配置成针对每个虚拟用户是独立的,也可以被配置成所有虚拟用户公用的。
2、如果每个虚拟用户的计数器是独立增长的,那么通常被用于记录测试计划运行了多少遍。全局计数器通常被用于记录发送了多少次请求。
3、计数器使用一个整数值来记录,允许的最大值为2,147,483,647。
4、目前计数器函数实例是独立实现的(JMeter 2.1.1及其以前版本,使用一个固定的线程变量来跟踪每个用户的计数器,因此多个计数器函数会操作同一个值)。全局计数器(FALSE)每个计数器实例都是独立维护的。
5、该函数也有对应的配置元件:计数器,功能类似。
四、__threadNum
函数__threadNum只是简单地返回当前线程的编号。线程编号不依赖于线程组,这就意味着从函数的角度看来,某个线程组的线程#1和另一个线程组的线程#1是没有区别的。另外,该函数没有参数。
这一函数不能用在任何配置元件中(如用户定义的变量),原因在于配置元件是由一个独立线程运行的。另外在测试计划(Test Plan)中使用也是没有意义的。所以,很少用。
五、__intSum:整数求和函数
1、函数__intSum可以被用来计算两个或者更多整数值的合。至少需要两个整数,如果指定变量名则名称中必须包含一个非数字字母,否则它会被当成另一个整数值,而被函数用于计算。
2、当有多个整数时点击添加按钮来增加参数,但是需要注意的是,添加完参数后,点击”生成”的函数默认是把手动添加的函数放在后面,这时需要手动调整变量名的位置,把它放到最后,否则会报错。
六、__longSum:长整型求和函数
该函数用来计算两个或更多长整型值的和,使用方法跟上面的__intSum函数一样。
七、__StringFromFile:读取文件中的字符串函数
1、该函数用来从文本文件中读取字符串。支持读取多个文件。
2、使用配置元件CSV Data Set Config ,也能达到相同的目的,而且方法更简单,但是它目前不支持多个输入文件。
3、每次调用函数,都会从文件中读取下一行。当到达文件末尾时,函数又会从文件开始处重新读取,直到最大循环次数。如果在一个测试脚本中对该函数有多次引用,那么每一次引用都会独立打开文件,即使文件名是相同的(如果函数读取的值,在脚本其他地方也有使用,那么就需要为每一次函数调用指定不同的变量名)。
4、如果在打开或者读取文件时发生错误,那么函数就会返回字符串"ERR"。
示例:
${_StringFromFile(demo.txt,)} 读取demo.txt
${_StringFromFile(PIN#’.'DAT,1,2)} 读取demo1.txt, demo2.txt
${_StringFromFile(PIN.DAT,2)} 读取demo.txt两次
5、函数的第三个参数:初始的序列号,如果省略,那么结束序列号就代表文件的循环读取次数。
6、函数的第四个参数:结束序列号,如果省略,那么序列号会无限增长。
7、读取多个文件示例:
需要在文件名中使用序列号:当使用序列号时,文件名需要使用格式字符串java.text.DecimalFormat。当前的序列号会作为唯一的参数。如果不指明可选的初始序列号,就使用文件名作为起始值。一些有用的格式序列如下:
#:插入数字,不从零开始,不包含空格。
000:插入数字,包含3个数字组合,不从零开始。
例如:
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
如果不希望某个格式字符被翻译,需要为它加上单引号。注意上面的"."是格式字符,必须被单引号所包含。
比如现在要同时读取两个文件,分别是PIN1.DAT, PIN2.DAT:
${_StringFromFile(PIN#’.'DAT,1,2)}:同时读取 PIN1.DAT, PIN2.DAT。
${_StringFromFile(PIN.DAT,2)}:读取 PIN.DAT 两次。
${_StringFromFile(test#’.'txt,1,2)}:同时读取test1.txt,test2.txt
八、__machineName
函数__machineName返回本机的主机名。
九、__javaScript
1、函数__javaScript可以用来执行JavaScript代码片段(非Java),并返回结果值。
2、JMeter的_javaScript函数会调用标准的JavaScript解释器,还可以直接调用jmeter的内置函数。
3、请记得为文本字符串添加必要的引号。另外,如果表达式中有逗号,请确保对其转义。例如,KaTeX parse error: Expected group after '_' at position 2: {_̲_javaScript('{sp}’.slice(7,99999))},对7之后的逗号进行了转义。
十、__Random:随机数函数
函数__Random会返回指定最大值和最小值之间的随机数。
十一、_RandomString():随机字符串函数
1、Random string length:随机字符的长度
2、Chars to use for random string generation:用来生成随机字符串的字符,可以是纯数字,纯字符,字符字母数字组合
3、Name of variable in which to store the result (optional):随机生成的字符被变量保存
4、${__RandomString(6,abcdefgh1234566,ranstr)},解释:随机生成一个6位长度的字符串被ranstr保存;
十二、__property
1、函数__property会返回一个JMeter属性的值。如果函数找不到属性值,而又没有提供默认值,则它会返回属性的名称。
2、例如,
${__property(user.dir)}:返回属性user.dir的值。
${__property(user.dir,UDIR)}:返回属性user.dir的值,并保存在变量UDIR中。
${__property(abcd,ABCD,atod)}:返回属性abcd的值 (如果属性没有定义,返回"atod"),并保存在变量ABCD 中。
${__property(abcd,atod)}:返回属性abcd 的值(如果属性没有定义,返回"atod"),但是并不保存函数的返回值。
十三、_P
1、函数_P是一个简化版的属性函数,目的是使用在命令行中定义的属性。
2、不同于函数_property,本函数没有提供选项用于设置保存属性值的变量。另外,如果没有设置默认值,默认值自动设为1。
3、例如:定义属性值:
jmeter -Jgroup1.threads=7 -Jhostname1=www.realhost.edu
获取值如下:
${__P(group1.threads)}:返回属性group1.threads的值。
${__P(group1.loops)}:返回属性group1.loops 的值。
${__P(hostname,www.baidu.com)}:返回属性hostname的值,如果没有定义该属性则返回值www.baidu.com。
在上面的例子中,第一个函数调用返回7,第二个函数调用返回1,而最后一个函数调用返回www.baidu.com(除非这些属性在其他地方有定义)。
十四、__log
1、函数__log会记录一条日志,并返回函数的输入字符串。
2、OUT 和ERR的日志级别,将会分别导致输出记录到System.out和System.err中。在这种情况下,输出总是会被打印(它不依赖于当前的日志设置)。
例如:
${__log(Message)}:写入日志文件,形如"…thread Name : Message"。
${__log(Message,OUT)}:写到控制台窗口。
KaTeX parse error: Expected group after '_' at position 2: {_̲_log({VAR},VAR=)}:写入日志文件,形如"…thread Name VAR=value"。
十五、__split:字符串分割函数
1、函数__split会通过分隔符来拆分传递给它的字符串,并返回原始的字符串。如果分隔符紧挨在一起,那么函数就会以变量值的形式返回"?"。拆分出来的字符串,以变量${VAR_1}、{VAR_2}…以此类推的形式加以返回。
2、分隔符默认是逗号,如果你想要多此一举,明确指定使用逗号,需要对逗号转义,如“,”
3、例如,在测试计划中定义变量VAR=“a||c|”:
KaTeX parse error: Expected group after '_' at position 2: {_̲_split({VAR},VAR),|} :该函数调用会返回VAR变量的值,例如"a||c|",并设定VAR_n=4、VAR_1=a、VAR_2=?、VAR_3=c、VAR_4=?、VAR_5=null变量的值。
十六、__XPath
1、函数__XPath读取XML文件,并在文件中寻找与指定XPath相匹配的地方。每调用函数一次,就会返回下一个匹配项。到达文件末尾后,会从头开始。如果没有匹配的节点,那么函数会返回空字符串,另外,还会向JMeter日志文件写一条警告信息。
整个节点列表都会被保存在内存之中。
例如:
${__XPath(/path/to/build.xml, //target/@name)}
这会找到build.xml文件中的所有目标节点,并返回下一个name属性的内容。
十七、__setProperty
1、函数__setProperty用于设置JMeter属性的值。函数的默认返回值是空字符串,因此该函数可以被用在任何地方,只要对函数本身调用是正确的。
2、通过将函数可选的第3个参数设置为"true",函数就会返回属性的原始值。
3、属性对于JMeter是全局的,因此可以被用来在线程和线程组之间通信。
十八、__time
1、函数__time可以通过多种格式返回当前时间。
2、如果省略了格式字符串,那么函数会以毫秒的形式返回当前时间。其他情况下,当前时间会被转成简单日期格式。包含如下形式:
YMD = yyyyMMdd。
HMS = HHmmss。
YMDHMS = yyyyMMdd-HHmmss。
USER1 = JMeter属性time.USER1。
USER2 = JMeter属性time.USER2。
用户可以通过修改JMeter属性文件来改变默认格式,或者自定义格式,例如修改YMD格式: time.YMD=yyMMdd。
十九、__V
1、函数__V可以用于执行变量名表达式,并返回执行结果。它可以被用于执行嵌套函数引用(目前JMeter不支持)。
2、例如,如果存在变量A1、A2和N=1,则:
${A1}:能正常工作。
KaTeX parse error: Expected '}', got 'EOF' at end of input: {A{N}}:无法正常工作(嵌套变量引用)。
KaTeX parse error: Expected group after '_' at position 2: {_̲_V(A{N})}:可以正常工作。A${N}变为A1,函数 __V返回变量值A1。
二十、__evalVar
1、函数__evalVar可以用来执行保存在变量中的表达式,并返回执行结果。
如此一来,用户可以从文件中读取一行字符串,并处理字符串中引用的变量。
2、例如,假设变量"query"中包含有"select ${column} from t a b l e " , 而 " c o l u m n " 和 " t a b l e " 中 分 别 包 含 有 " n a m e " 和 " c u s t o m e r s " , 那 么 {table}",而 "column"和"table"中分别包含有"name"和"customers",那么 table",而"column"和"table"中分别包含有"name"和"customers",那么{__evalVar(query)}将会执行"select name from customers"。
二十一、__eval
1、函数__eval可以用来执行一个字符串表达式,并返回执行结果。
如此一来,用户就可以对字符串(存储在变量中)中的变量和函数引用做出修改。
2、例如,给定变量name=Smith、column=age、table=birthdays、SQL=select ${column} from t a b l e w h e r e n a m e = ′ {table} where name=' tablewherename=′{name}’,那么通过KaTeX parse error: Expected group after '_' at position 2: {_̲_eval({SQL})},就能执行"select age from birthdays where name=‘Smith’"。这样一来,就可以与CSV数据集相互配合,例如,将SQL语句和值都定义在数据文件中。
二十二、__escapeHtml
1、函数__escapeHtml用于转义字符串中的字符(使用HTML实体)。支持HTML 4.0实体。
二十三、__unescapeHtml
1、函数__unescapeHtml用于反转义一个包含HTML实体的字符串,将其变为包含实际Unicode字符的字符串。支持HTML 4.0实体。
2、如果函数不认识某个实体,就会将实体保留下来,并一字不差地插入结果字符串中。例如,">&zzzz;x"会变为">&zzzz;x"。
二十四、__FileToString
1、函数__FileToString可以被用来读取整个文件。每次对该函数的调用,都会读取整个文件。
2、如果在打开或者读取文件时发生错误,那么函数就会返回字符串"ERR"。