詳解JMeter函數和變量(1)
JMeter函數可以被認爲是某種特殊的變量,它們可以被採樣器或者其他測試元件所引用。函數調用的語法如下:
- ${__functionName(var1,var2,var3)}
其中,__functionName匹配被調用的函數名稱。用圓括號包含函數的形參,例如${__time(YMD)},不同函數要求的參數也不同。有些JMeter函數不要求參數,則可以不使用圓括號,例如${__threadNum}。
如果一個函數的參數中包含逗號,那麼必須對逗號進行轉義(使用"\"),否則JMeter會把逗號當成參數分隔符。例如:
- ${__time(EEE\, d MMM yyyy)}
變量引用的語法如下:
- ${VARIABLE}
如果測試計劃中引用了未定義的變量或者函數,那麼JMeter並不會報告/記錄錯誤信息,引用返回的值就是引用自身。例如,假設字符串UNDEF沒 有被定義爲變量,那麼${UNDEF}返回的值就是${UNDEF}。變量、函數(包括屬性)都是大小寫敏感的。JMeter 2.3.1及其後續版本會剔除參數名中的空格,例如,${__Random(1,63, LOTTERY )}中的"LOTTERY "會被"LOTTERY"所代替。
屬性不同於變量。變量對線程而言是局部的,所有線程都可以訪問屬性,就使用__P或者__property函數。
如表11-1所示爲JMeter內置函數的列表(按類型劃分)。
表11-1 JMeter內置函數列表
函數類型 |
函數名稱 |
註釋 |
Information |
get thread number |
|
Information |
get the local machine name |
|
Information |
return current time in various formats |
|
Information |
log (or display) a message (and return the value) |
|
Information |
log (or display) a message (empty return value) |
|
Input |
read a line from a file |
|
Input |
read an entire file |
|
Input |
read from CSV delimited file |
|
Input |
Use an XPath expression to read from a file |
|
Calculation |
generate an incrementing number |
|
Calculation |
add int numbers |
|
Calculation |
add long numbers |
|
Calculation |
generate a random number |
|
Scripting |
run a BeanShell script |
|
Scripting |
process JavaScript (Mozilla Rhino) |
|
Scripting |
evaluate a Commons Jexl expression |
|
Properties |
read a property |
|
Properties |
read a property (shorthand method) |
|
Properties |
set a JMeter property |
|
Variables |
Split a string into variables |
|
Variables |
evaluate a variable name |
|
Variables |
evaluate a variable expression |
|
Variables |
evaluate an expression stored in a variable |
|
String |
parse previous response using a regular expression |
|
String |
generate Unicode char values from a list of numbers |
|
String |
Process strings containing Java escapes (e.g. \n & \t) |
|
String |
Decode HTML-encoded strings |
|
String |
Encode strings using HTML encoding |
詳解JMeter函數和變量(2)
1.使用函數可以做些什麼
目前有兩種類型的函數:用戶定義的靜態值(或者變量)和JMeter內置函數。
當需要編譯測試樹或者提交運行時,用戶可以使用自定義變量來代替常用的靜態值。這種替換隻在測試的開始階段執行一次。一個典型的應用就是使用自定義變量來替換所有HTTP請求的DOMAIN域,例如,做出輕微改動,就可以讓同一個測試腳本適配多個服務器。
需要注意,目前變量不支持嵌套;例如${Var${N}}不能正常工作。但是在JMeter 2.2及其以後版本中,可以藉助函數__V (variable)來達成嵌套變量的目的(如${__V(Var${N})})。在早期的JMeter版本中可以使 用${__BeanShell(vars.get("Var${N}")}。
這種類型的替換也可以不用函數來實現,但是就不像使用函數時那麼直觀和方便。用戶可以創建默認配置測試元件,它們會填充採樣器中的空白設置。
使用JMeter內置函數,用戶可以基於前面的服務器響應數據、函數所在線程、當前時間或者其他資源來動態地計算變量值。這些變量的值會在整個測試期間針對每個請求動態更新。
函數可以在多個線程間共用。在測試計劃中每次函數調用,都是採用獨立的函數實例。
2.函數和變量可以被用在哪裏
函數和變量理論上可以被用在任何測試元件的任何輸入域之中(除了測試計劃之外,見下面的內容)。有些輸入域不支持隨機數組,因爲它們只接受數字,這樣一來就不支持函數。當然,大多數輸入域支持函數。
將函數用於測試計劃(Test Plan)的設置時,會受到一些限制。此種情況下,JMeter線程的變量在函數被處理時還沒有被設定,因此變量作爲參數傳遞時沒有初始化,函數引用當然 不會生效。如此一來,split()、regex()及變量賦值函數就都不能正常工作。函數threadNum()同樣不能正常工作,該函數在測試計劃層 沒有意義。在測試計劃中,函數intSum、longSum、machineName、BeanShell、javaScript、jexl、 random、time、property functions、log functions應該能正常工作。
配置元件是通過一個獨立線程處理的。因此函數(如__threadNum)不能在這些測試元件(如用戶定義的變量)之中正常工作。另外還需要注意,在用戶定義的變量(UDV)中定義的變量,在UDV被處理前是不能使用的。
當在SQL代碼中引用變量/函數時,需要爲文本字符串加上必要的引號。例如,使用:
- SELECT item from table where name='${VAR}'
而非:
- SELECT item from table where name=${VAR}
(除非VAR自身就包含引號)。
3.怎樣引用函數和變量
在測試元件中引用某個變量,可以通過使用"${"和"}"將變量名括起來實現。
函數使用相同的辦法加以引用,但是依據慣例,函數名以"__"開頭,以區別於變量名。部分函數會攜帶參數,參數放在圓括號中,以逗號加以分隔。如果函數沒有參數,那麼可以省略圓括號。
如果參數值中包含逗號,必須對其加以轉義。如果測試人員需要在參數值中包含一個逗號,可以這樣轉義:"\,"。這主要影響腳本函數,例如JavaScript、BeanShell、Jexl有必要對腳本方法調用中的所有逗號加以轉義。例如:
- ${__BeanShell(vars.put("name"\,"value"))}
另外,測試人員還有一種選擇,即將腳本定義爲一個變量,例如,在測試計劃中定義:
- SCRIPT vars.put("name","value")
腳本可以如下般引用:
- ${__BeanShell(${SCRIPT})}
這裏沒有必要對SCRIPT變量的內容進行轉義,因爲函數的調用先於變量被其值所替換。該方法適合於BSF或者BeanShell採樣器,這兩種採樣器可以用於測試JavaScript、Jexl和BeanShell腳本。
函數可以引用變量及其他函數,例如${__XPath(${__P(xpath.file),${XPATH})},使用"xpath.file"作爲文件名,變量XPATH的內容作爲搜索表達式。
JMeter提供了一個工具,用來幫助測試人員使用各種內置函數實現函數調用。使用該工具,只需複製-粘貼。工具不會爲測試人員自動轉義值,因爲函數可以作爲其他函數的參數,測試人員應該只對文本進行轉義。
如果一個字符串既包含反斜線("\"),又包含函數或者變量引用,那麼出現在"$"、"," 或者"\"之前的反斜線會被移除。這個操作對於嵌套函數(被嵌套的函數表達式包含逗號或者${)是有必要的。如果字符串中不包含函數和變量引用,那麼出現 在"$"、","或者"\"之前的反斜線就不會被移除。
用戶可以使用__logn() 函數來報告變量或者函數的值。__logn() 函數可以在測試計劃中的任何地方被引用,前提條件是被報告的值已經被定義。另外,Java請求採樣器可以被用來產生一個包含變量引用的採樣;輸出結果會在 合適的監聽器中展示。JMeter 2.3及其以後版本中包含一個Debug Sampler,可以使用它來展示變量的值(如在查看結果樹中展示)。
如果測試人員定義了一個用戶定義靜態變量,且該變量名與JMeter內置函數名相同,那麼測試人員的靜態變量就會覆蓋同名內置函數。
詳解JMeter函數和變量(3)
4.函數助手對話框
測試人員可以在JMeter的選項菜單中找到函數助手對話框("Function Helper"對話框),如圖11-1所示。
圖11-1
使用函數助手,測試人員可以從下拉列表中選擇一個函數,併爲其參數設定值。在圖11-1中,表格的左邊一列是函數參數的簡要描述,右邊一列是供用戶填充參數的值。不同函數要求的參數也不同。
當測試人員完成以上設置後,請單擊"Generate"按鈕,函數助手會爲測試人員生成函數調用所需的字符串,測試人員所要做的只是將它複製-粘貼到測試計劃中去。
5.常用JMeter函數
1)__regexFunction
正則表達式函數可以使用正則表達式(用戶提供的)來解析前面的服務器響應(或者是某個變量值)。函數會返回一個有模板的字符串,其中攜帶有可變的值。
__regexFunction還可以被用來保存值,以便供後續使用。在函數的第6個參數中,測試人員可以指定一個引用名。在函數執行以後,測試人 員可以使用用戶定義值的語法來獲取同樣的值。例如,如果測試人員輸入"refName"作爲第6個參數,那麼測試人員可以使用:
${refName}來引用第2個參數(Template for the replacement string)的計算結果,這依賴於函數的解析結果。
${refName_g0}來引用函數解析後發現的所有匹配結果。
${refName_g1}來引用函數解析後發現的第一個匹配組合。
${refName_g#}來引用函數解析後發現的第n個匹配組合。
${refName_matchNr}來引用函數總共發現的匹配組合數目。
參數如表11-2所示。
表11-2 參數描述
函數參數 |
描述 |
是否必需 |
第1個參數 |
第1個參數是用於解析服務器響應數據的正則表達式。 它會找到所有匹配項。如果測試人員希望將表達式 中的某部分應用在模板字符串中,一定記得爲其加 上圓括號。例如,<a href="(.*)">。這樣就會將鏈接 的值存放到第一個匹配組合中(這裏只有一個匹配組 合)。又如,<input type="hidden" name="(.*)" value="(.*)">。在這個例子中,鏈接的name作爲第 一個匹配組合,鏈接的value會作爲第二個匹配組合。 這些組合可以用在測試人員的模板字符串中 |
是 |
第2個參數 |
這是一個模板字符串,函數會動態填寫字符串的部分 內容。要在字符串中引用正則表達式捕獲的匹配組合, 請使用語法:$[group_number]$。例如$1$或者 $2$。 測試人員的模板可以是任何字符串 |
是 |
第3個參數 |
第3個參數告訴JMeter使用第幾次匹配。測試人 員的正則表達式可能會找到多個匹配項。對此, 測試人員有4種選擇: n 整數,直接告訴JMeter使用第幾個匹配項。 n “1”對應第一個匹配,“2”對應第二個匹配,以此類推 n RAND,告訴JMeter隨機選擇一個匹配項 n ALL,告訴JMeter使用所有匹配項,爲每一 n 個匹配項創建一個模板字符串,並將它們連接在一起 n 浮點值0到1之間,根據公式(找到的總匹配 n 數目*指定浮點值)計算使用第幾個匹配項, n 計算值向最近的整數取整 |
否,默認值爲1 |
第4個參數 |
如果在上一個參數中選擇了“ALL”,那麼這第4個 參數會被插入到重複的模板值之間 |
否 |
第5個參數 |
如果沒有找到匹配項返回的默認值 |
否 |
第6個參數 |
重用函數解析值的引用名,參見上面內容 |
否 |
第7個參數 |
輸入變量名稱。如果指定了這一參數,那麼該變量 的值就會作爲函數的輸入,而不再使用前面的 採樣結果作爲搜索對象 |
否 |
2)__counter
每次調用計數器函數都會產生一個新值,從1開始每次加1。計數器既可以被配置成針對每個虛擬用戶是獨立的,也可以被配置成所有虛擬用戶公用的。如果每個虛擬用戶的計數器是獨立增長的,那麼通常被用於記錄測試計劃運行了多少遍。全局計數器通常被用於記錄發送了多少次請求。
計數器使用一個整數值來記錄,允許的最大值爲2,147,483,647。
目前計數器函數實例是獨立實現的(JMeter 2.1.1及其以前版本,使用一個固定的線程變量來跟蹤每個用戶的計數器,因此多個計數器函數會操作同一個值)。全局計數器(FALSE)每個計數器實例都是獨立維護的。
參數如表11-3所示。
表11-3 參數描述
函數參數 |
描述 |
是否必需 |
第1個參數 |
True,如果測試人員希望每個虛擬用戶的計數 器保持獨立,與其他用戶的計數器相區別。 false,全局計數器 |
是 |
第2個參數 |
重用計數器函數創建值的引用名。測試人員可 以這樣引用計數器的值:${refName}。這樣一來, 測試人員就可以創建一個計數器後,在多個地方引 用它的值(JMeter 2.1.1及其以前版本,這個參數是必需的) |
否 |
3)__threadNum
函數__threadNum只是簡單地返回當前線程的編號。線程編號不依賴於線程組,這就意味着從函數的角度看來,某個線程組的線程#1和另一個線程組的線程#1是沒有區別的。另外,該函數沒有參數。
這一函數不能用在任何配置元件中(如用戶定義的變量),原因在於配置元件是由一個獨立線程運行的。另外在測試計劃(Test Plan)中使用也是沒有意義的。
4)__intSum
函數__intSum可以被用來計算兩個或者更多整數值的合。
參數如表11-4所示。
表11-4 參數描述
函數參數 |
描述 |
是否必需 |
第1個參數 |
第1個整數值 |
是 |
第2個參數 |
第2個整數值 |
是 |
第n個參數 |
第n個整數值 |
否 |
最後一個參數 |
重用函數計算值的引用名。如果用戶指定 了這一參數,那麼引用名中必須包含一個非 數字字母,否則它會被當成另一個整數值, 而被函數用於計算 |
否 |
詳解JMeter函數和變量(4)
JMeter 2.3.1及其以前版本,要求必須有引用名參數。後續JMeter版本中,引用名是可選的參數,但是引用名不能是整數值。
5)__longSum
函數__ longSum可以被用來計算兩個或者更多長整型值的合。
參數如表11-5所示。
表11-5 參數描述
函數參數 |
描述 |
是否必需 |
第1個參數 |
第1個長整型值 |
是 |
第2個參數 |
第2個長整型值 |
是 |
第n個參數 |
第n個長整型值 |
否 |
最後一個參數 |
重用函數計算值的引用名。如果用戶指 定了這一參數,那麼引用名中必須包含一個 非數字字母,否則它會被當成另一個長整 型值,而被函數用於計算 |
否 |
6)__StringFromFile
函數__StringFromFile可以被用來從文本文件中讀取字符串。這對於需要大量可變數據的測試很有用。例如,當測試一個銀行應用系統時,測試人員可能需要100條甚至1000條賬戶信息。
使用配置元件CSV Data Set Config ,也能達到相同的目的,而且方法更簡單。但是該配置元件目前不支持多輸入文件。
每次調用函數,都會從文件中讀取下一行。當到達文件末尾時,函數又會從文件開始處重新讀取,直到最大循環次數。如果在一個測試腳本中對該函數有多次 引用,那麼每一次引用都會獨立打開文件,即使文件名是相同的(如果函數讀取的值,在腳本其他地方也有使用,那麼就需要爲每一次函數調用指定不同的變量 名)。
如果在打開或者讀取文件時發生錯誤,那麼函數就會返回字符串"**ERR**"。
參數如表11-6所示。
表11-6 參數描述
函數參數 |
描述 |
是否必需 |
文件名 |
文件名(可以使用相對於JMeter啓動 目錄的相對路徑)。如果要在文件名中 使用可選的序列號,那麼文件名必須適 合轉成十進制格式。參考下面的例子 |
是 |
變量名 |
一個引用名(refName)的目的是復 用這一函數創建的值。可以使用語法 ${refName}來引用函數創建的值。 默認值爲“StringFromFile_” |
否 |
初始序列號 |
初始序列號(如果省略這一參數, 終止序列號會作爲一個循環計數器) |
否 |
終止序列號 |
終止序列號(如果省略這一參數, 序列號會一直增加下去,不會受到限制) |
否 |
當打開或者重新打開文件時,文件名參數將會被解析。
每次執行函數時,引用名參數(如果支持)將會被解析。
使用序列號:當使用可選的序列號時,文件名需要使用格式字符串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
如果不希望某個格式字符被翻譯,測試人員需要爲它加上單引號。注意"."是格式字符,必須被單引號所包含。
如果省略了初始序列號,而終止序列號參數將會作爲循環計數器,文件將會被使用指定的次數。例如:
${_StringFromFile(PIN#'.'DAT,,1,2)}:讀取 PIN1.DAT, PIN2.DAT。
${_StringFromFile(PIN.DAT,,,2)}:讀取 PIN.DAT 兩次。
7)__machineName
函數__machineName返回本機的主機名。
參數如表11-7所示。
表11-7 參數描述
函數參數 |
描述 |
是否必需 |
變量名 |
重用函數計算值的引用名 |
否 |
詳解JMeter函數和變量(5)
8)__javaScript
函數__javaScript可以用來執行JavaScript代碼片段(非Java),並返回結果值。JMeter的_javaScript函數會調用標準的JavaScript解釋器。JavaScript會作爲腳本語言使用,因此測試人員可以做相應的計算。
在腳本中可以訪問如下一些變量。
Log:該函數的日誌記錄器。
Ctx:JmeterContext對象。
Vars:JmeterVariables對象。
threadName:字符串包含當前線程名稱 (在2.3.2 版本中它被誤寫爲"theadName")。
sampler:當前採樣器對象(如果存在)。
sampleResult:前面的採樣結果對象(如果存在)。
props:JMeter屬性對象。
Rhinoscript允許通過它的包對象來訪問靜態方法。例如,用戶可以使用如下方法訪問JMeterContextService靜態方法:
Packages.org.apache.jmeter.threads.JMeterContextService.getTotalThreads()
JMeter不是一款瀏覽器,它不會執行從頁面下載的JavaScript。
參數如表11-8所示。
表11-8 參數描述
函數參數 |
描述 |
是否必需 |
JavaScript代碼片段 |
待執行的JavaScript代碼片段。例如: n new Date():返回當前日期和時間 n Math.floor(Math.random()*(${maxRandom} n +1)):在0 和變量maxRandom之間的隨機數 n ${minRandom}+Math.floor(Math.random()* n (${maxRandom}-${minRandom}+1)): n 在變量 minRandom和maxRandom之間的隨機數 n "${VAR}"=="abcd" |
是 |
變量名 |
重用函數計算值的引用名 |
否 |
請記得爲文本字符串添加必要的引號。另外,如果表達式中有逗號,請確保對其轉義。例如,${__javaScript('${sp}'.slice(7\,99999))},對7之後的逗號進行了轉義。
9)__Random
函數__Random會返回指定最大值和最小值之間的隨機數。
參數如表11-9所示。
表11-9 參數描述
函數參數 |
描述 |
是否必需 |
最小值 |
最小數值 |
是 |
最大值 |
最大數值 |
是 |
變量名 |
重用函數計算值的引用名 |
否 |
10)__CSVRead
函數__CSVRead會從CSV文件讀取一個字符串(請注意與StringFromFile 的區別)。
JMeter 1.9.1以前的版本僅支持從單個文件中讀取,JMeter 1.9.1及其以後版本支持從多個文件中讀取。
在大多數情況下,新配置元件CSV Data Set更好用一些。
當對某個文件進行第一次讀取時,文件將被打開並讀取到一個內部數組中。如果在讀取過程中找到了空行,函數就認爲到達文件末尾了,即允許拖尾註釋(這一特性是JMeter 1.9.1版本引入的)。
後續所有對同一個文件名的引用,都使用相同的內部數組。另外,文件名大小寫對函數調用很重要,哪怕操作系統不區分大小寫,CSVRead(abc.txt,0)和CSVRead(aBc.txt,0)會引用不同的內部數組。
使用*ALIAS特性可以多次打開同一個文件,另外還能縮減文件名稱。
每一個線程都有獨立的內部指針指向文件數組中的當前行。當某個線程第一次引用文件時,函數會爲線程在數組中分配下一個空閒行。如此一來,任何一個線程訪問的文件行,都與其他線程不同(除非線程數大於數組包含的行數)。
默認情況下,函數會在遇到的每一個逗號處斷行。如果測試人員希望在輸入的列中使用逗號,那麼測試人員需要換一個分隔符(通過設置屬性csvread.delimiter來實現),且該符號沒有在CSV文件的任何列中出現。
參數如表11-10所示。
表11-10 參數描述
函數參數 |
描述 |
是否必需 |
文件名 |
設置從哪個文件讀取(或者*ALIAS) |
是 |
列數 |
從文件的哪一列讀取。0 =第一列, 1 = 第二列,依此類推。“next”爲走到文件的 下一行。*ALIAS爲打開一個文件,並給它分配一個別名 |
是 |
例如,測試人員可以用如下參數來設置某些變量:
1
2
3
4
|
COL1a ${__CSVRead(random.txt,0)} COL2a ${__CSVRead(random.txt,1)}${__CSVRead(random.txt,next)} COL1b ${__CSVRead(random.txt,0)} COL2b ${__CSVRead(random.txt,1)}${__CSVRead(random.txt,next)} |
詳解JMeter函數和變量(6)
上面的例子會從一行中讀取兩列,接着從下一行中讀取兩列。如果所有變量都在同一個前置處理器中(用戶參數上定義的),那麼行都是順序讀取的。否則,不同線程可能會讀取不同的行。
這一函數並不適合於讀取很大的文件,因爲整個文件都會被存儲到內存之中。對於較大的文件,請使用配置元件CSV Data Set或者StringFromFile 。
11)__property
函數__property會返回一個JMeter屬性的值。如果函數找不到屬性值,而又沒有提供默認值,則它會返回屬性的名稱。
例如,
${__property(user.dir)}:返回屬性user.dir的值。
${__property(user.dir,UDIR)}:返回屬性user.dir的值,並保存在變量UDIR中。
${__property(abcd,ABCD,atod)}:返回屬性abcd的值 (如果屬性沒有定義,返回"atod"),並保存在變量ABCD 中。
${__property(abcd,,atod)}:返回屬性abcd 的值(如果屬性沒有定義,返回"atod"),但是並不保存函數的返回值。
參數如表11-11所示。
表11-11 參數描述
函數參數 |
描述 |
是否必需 |
屬性名 |
獲取屬性值、所需的屬性名 |
是 |
變量名 |
重用函數計算值的引用名 |
否 |
默認值 |
屬性未定義時的默認值 |
否 |
12)_P
函數_P是一個簡化版的屬性函數,目的是使用在命令行中定義的屬性。不同於函數_property,本函數沒有提供選項用於設置保存屬性值的變量。 另外,如果沒有設置默認值,默認值自動設爲1。之所以選擇1,原因在於它對於很多常見測試變量都是一個合理值,例如,循環次數、線程數、啓動線程耗時間 等。
例如:定義屬性值:
jmeter -Jgroup1.threads=7 -Jhostname1=www.realhost.edu
獲取值如下。
${__P(group1.threads)}:返回屬性group1.threads的值。
${__P(group1.loops)}:返回屬性group1.loops 的值。
${__P(hostname,www.dummy.org)}:返回屬性hostname的值,如果沒有定義該屬性則返回值www.dummy.org。
在上面的例子中,第一個函數調用返回7,第二個函數調用返回1,而最後一個函數調用返回www.dummy.org(除非這些屬性在其他地方有定義)。
參數如表11-12所示。
表11-12 參數描述
函數參數 |
描述 |
是否必需 |
屬性名 |
獲取屬性值、所需的屬性名 |
是 |
默認值 |
屬性未定義時的默認值。如果省略 此參數,默認值自動設爲1 |
否 |
13)__log
函數__log會記錄一條日誌,並返回函數的輸入字符串。
參數如表11-13所示。
表11-13 參數描述
函數參數 |
描述 |
是否必需 |
待記錄字符串 |
一個字符串 |
是 |
日誌級別 |
OUT、ERR、DEBUG、INFO(默認)、 WARN或者ERROR |
否 |
可拋棄的文本 |
如果非空,會創建一個可拋棄 的文本傳遞給記錄器 |
否 |
註釋 |
如果存在,註釋會在字符串中展示, 用於標識日誌記錄了什麼 |
否 |
OUT 和ERR的日誌級別,將會分別導致輸出記錄到System.out和System.err中。在這種情況下,輸出總是會被打印(它不依賴於當前的日誌設置)。
例如,
${__log(Message)}:寫入日誌文件,形如"...thread Name : Message"。
${__log(Message,OUT)}:寫到控制檯窗口。
${__log(${VAR},,,VAR=)}:寫入日誌文件,形如"...thread Name VAR=value"。
14)__logn
函數__logn會記錄一條日誌,並返回空字符串。
參數如表11-14所示。
表11-14 參數描述
函數參數 |
描述 |
是否必需 |
待記錄字符串 |
一個字符串 |
是 |
日誌級別 |
OUT,ERR,DEBUG, INFO (默認),WARN 或者ERROR |
否 |
可拋棄的文本 |
如果非空,會創建一個可拋棄的 文本傳遞給記錄器 |
否 |
OUT 和ERR的日誌級別,將會分別導致輸出記錄到System.out和System.err中。在這種情況下,輸出總是會被打印(它不依賴於當前的日誌設置)。
例如,${__logn(VAR1=${VAR1},OUT)}:將變量值寫到控制檯窗口中。
15)__BeanShell
函數__BeanShell會執行傳遞給它的腳本,並返回結果。
關於BeanShell的詳細資料,請參考BeanShell的Web站點:http://www.beanshell.org/ 。
需要注意,測試腳本中每一個獨立出現的函數調用,都會使用不同的解釋器,但是後續對函數調用的援引會使用相同的解釋器。這就意味着變量會持續存在,並跨越函數調用。
單個函數實例可以從多個線程調用。另外,該函數的execute()方法是同步的。
如果定義了屬性"beanshell.function.init",那麼它會作爲一個源文件傳遞給解釋器。這樣就可以定義一些通用方法和變量。在bin目錄中有一個初始化文件的例子:BeanShellFunction.bshrc。
詳解JMeter函數和變量(7)
如下變量在腳本執行前就已經設置了。
log:函數BeanShell(*)的記錄器。
ctx:目前的JMeter Context變量。
vars:目前的JMeter變量。
props:JMeter屬性對象。
threadName:線程名(字符串)。
sampler:當前採樣器(如果存在)。
sampleResult:當前採樣器(如果存在)。
"*"意味着該變量在JMeter使用初始化文件之前就已經設置了。其他變量在不同調用之間可能會發生變化。
參數如表11-15所示。
表11-15 參數描述
函數參數 |
描述 |
是否必需 |
BeanShell腳本 |
一個BeanShell腳本(不是文件名) |
是 |
變量名 |
重用函數計算值的引用名 |
否 |
例如,
${__BeanShell(123*456)}:回56088。
${__BeanShell(source("function.bsh"))}:行在function.bsh中的腳本。
請記得爲文本字符串及代表文本字符串的JMeter變量添加必要的引號。
16)__plit
函數__split會通過分隔符來拆分傳遞給它的字符串,並返回原始的字符串。如果分隔符緊挨在一起,那麼函數就會以變量值的形式返回"?"。拆分 出來的字符串,以變量${VAR_1}、{VAR_2}…以此類推的形式加以返回。JMeter 2.1.2及其以後版本,拖尾的分隔符會被認爲缺少一個變量,會返回"?"。另外,爲了更好地配合ForEach控制器,現在__split會刪除第一個 不用的變量(由前一次分隔符所設置)。
例如,在測試計劃中定義變量VAR="a||c|":
- ${__split(${VAR},VAR),|}
該函數調用會返回VAR變量的值,例如"a||c|",並設定VAR_n=4(3 ,JMeter 2.1.1及其以前版本)、VAR_1=a、VAR_2=?、VAR_3=c、VAR_4=?(null,JMeter 2.1.1及其以前版本)、VAR_5=null(JMeter 2.1.2及其以後版本)變量的值。
參數如表11-16所示。
表11-16 參數描述
函數參數 |
描述 |
是否必需 |
待拆分字符串 |
一個待拆分字符串,例如“a|b|c” |
是 |
變量名 |
重用函數計算值的引用名 |
否 |
分隔符 |
分隔符,例如“|”。如果省略了此參數,函數 會使用逗號做分隔符。需要注意的是,假如測 試人員要多此一舉,明確指定使用逗號, 需要對逗號轉義,如“\,” |
否 |
17)__XPath
函數__XPath讀取XML文件,並在文件中尋找與指定XPath相匹配的地方。每調用函數一次,就會返回下一個匹配項。到達文件末尾後,會從頭開始。如果沒有匹配的節點,那麼函數會返回空字符串,另外,還會向JMeter日誌文件寫一條警告信息。
整個節點列表都會被保存在內存之中。
例如:
- ${__XPath(/path/to/build.xml, //target/@name)}
這會找到build.xml文件中的所有目標節點,並返回下一個name屬性的內容。
參數如表11-17所示。
表11-17 參數描述
函數參數 |
描述 |
是否必需 |
XML文件名 |
一個待解析的XML文件名 |
是 |
XPath |
一個XPath表達式,用於在 XML文件中尋找目標節點 |
是 |
18)__setProperty
函數__setProperty用於設置JMeter屬性的值。函數的默認返回值是空字符串,因此該函數可以被用在任何地方,只要對函數本身調用是正確的。
通過將函數可選的第3個參數設置爲"true",函數就會返回屬性的原始值。
屬性對於JMeter是全局的,因此可以被用來在線程和線程組之間通信。
參數如表11-18所示。
表11-18 參數描述
函數參數 |
描述 |
是否必需 |
屬性名 |
待設置屬性名 |
是 |
屬性值 |
屬性的值 |
是 |
True/False |
是否返回屬性原始值 |
否 |
詳解JMeter函數和變量(8)
19)__time
函數__time可以通過多種格式返回當前時間。
參數如表11-19所示。
表11-19 參數描述
函數參數 |
描述 |
是否必需 |
格式 |
設置時間所採用的格式 |
否 |
變量名 |
待設置變量名 |
否 |
如果省略了格式字符串,那麼函數會以毫秒的形式返回當前時間。其他情況下,當前時間會被轉成簡單日期格式。包含如下形式:
YMD = yyyyMMdd。
HMS = HHmmss。
YMDHMS = yyyyMMdd-HHmmss。
USER1 = JMeter屬性time.USER1。
USER2 = JMeter屬性time.USER2。
用戶可以通過修改JMeter屬性來改變默認格式,例如,time.YMD=yyMMdd。
20)_jexl
函數_jexl可以用於執行通用JEXL表達式,並返回執行結果。感興趣的讀者可以從下面這兩個網頁鏈接獲取更多關於JEXL的信息。
http://commons.apache.org/jexl/reference/syntax.html。
http://commons.apache.org/jexl/reference/examples.html#Example_Expressions。
參數如表11-20所示。
表11-20 參數描述
函數參數 |
描述 |
是否必需 |
表達式 |
待執行的表達式。例如,6*(5+2) |
是 |
變量名 |
待設置變量名 |
否 |
如下變量可以通過腳本進行訪問。
log:函數記錄器。
ctx:JMeterContext對象。
vars:JMeterVariables對象。
props:JMeter屬性對象。
threadName:字符串包含當前線程名稱 (在2.3.2 版本中它被誤寫爲"theadName")。
sampler:當前的採樣器對象(如果存在)。
sampleResult:前面的採樣結果對象(如果存在)。
OUT - System.out,例如 OUT.println("message")。
JEXL可以基於它們來創建類,或者調用方法,例如:
- Systemclass=log.class.forName("java.lang.System");
- now=Systemclass.currentTimeMillis();
需要注意的是,Web站點上的JEXL文檔錯誤地建議使用"div"做整數除法。事實上"div"和"/"都執行普通除法。
JMeter 2.3.2以後的版本允許在表達式中包含多個聲明。JMeter 2.3.2及其以前的版本只處理第一個聲明(如果存在多個聲明,就會記錄一條警告日誌)。
21)__V
函數__V可以用於執行變量名表達式,並返回執行結果。它可以被用於執行嵌套函數引用(目前JMeter不支持)。
例如,如果存在變量A1、A2和N=1,則:
${A1}:能正常工作。
${A${N}}:無法正常工作(嵌套變量引用)。
${__V(A${N})}:可以正常工作。A${N}變爲A1,函數 __V返回變量值A1。
參數如表11-21所示。
表11-21 參數描述
函數參數 |
描述 |
是否必需 |
變量名表達式 |
待執行變量名表達式 |
是 |
22)__evalVar
函數__evalVar可以用來執行保存在變量中的表達式,並返回執行結果。
如此一來,用戶可以從文件中讀取一行字符串,並處理字符串中引用的變量。例如,假設變量"query"中包含有"select ${column} from ${table}",而"column"和"table"中分別包含有"name"和"customers",那 麼${__evalVar(query)}將會執行"select name from customers"。
參數如表11-22所示。
表11-22 參數描述
函數參數 |
描述 |
是否必需 |
變量名 |
待執行變量名 |
是 |
詳解JMeter函數和變量(9)
23)__eval
函數__eval可以用來執行一個字符串表達式,並返回執行結果。
如此一來,用戶就可以對字符串(存儲在變量中)中的變量和函數引用做出修改。例如,給定變量name=Smith、column=age、 table=birthdays、SQL=select ${column} from ${table} where name='${name}',那麼通過${__eval(${SQL})},就能執行"select age from birthdays where name='Smith'"。這樣一來,就可以與CSV數據集相互配合,例如,將SQL語句和值都定義在數據文件中。
參數如表11-23所示。
表11-23 參數描述
函數參數 |
描述 |
是否必需 |
變量名 |
待執行變量 |
是 |
24)__char
函數__char會將一串數字翻譯成Unicode字符,另外還請參考下面__unescape()函數。
參數如表11-24所示。
表11-24 參數描述
函數參數 |
描述 |
是否必需 |
Unicode字符編碼 (十進制數或者十六進制數) |
待轉換的Unicode字符編碼, 可以是十進制數或者十六進制數 |
是 |
Unicode字符編碼(十進制數或者十六進制數) 待轉換的Unicode字符編碼,可以是十進制數或者十六進制數是
例如:
- ${__char(0xC,0xA)} = CRLF
- ${__char(165)} = � (yen)
函數__unescape用於反轉義Java-escaped字符串,另外還請參考上面的__char函數。
參數如表11-25所示。
表11-25 參數描述
函數參數 |
描述 |
是否必需 |
待反轉義字符串 |
待反轉義字符串 |
是 |
例如:
- ${__unescape(\r\n)} = CRLF
- ${__unescape(1\t2)} = 1[tab]2
26)__unescapeHtml
函數__unescapeHtml用於反轉義一個包含HTML實體的字符串,將其變爲包含實際Unicode字符的字符串。支持HTML 4.0實體。
例如,字符串"<Français>"變爲"<Fran?ais>"。
如果函數不認識某個實體,就會將實體保留下來,並一字不差地插入結果字符串中。例如,">&zzzz;x"會變爲">&zzzz;x"。
參數如表11-26所示。
表11-26 參數描述
函數參數 |
描述 |
是否必需 |
待反轉義字符串 |
待反轉義字符串 |
是 |
27)__escapeHtml
函數__escapeHtml用於轉義字符串中的字符(使用HTML實體)。支持HTML 4.0實體。
例如,"bread" & "butter"變爲"bread" & "butter"。
參數如表11-27所示。
表11-27 參數描述
函數參數 |
描述 |
是否必需 |
待轉義字符串 |
待轉義字符串 |
是 |
28)__FileToString
函數__FileToString可以被用來讀取整個文件。每次對該函數的調用,都會讀取整個文件。
如果在打開或者讀取文件時發生錯誤,那麼函數就會返回字符串"**ERR**"。
參數如表11-28所示。
表11-28 參數描述
函數參數 |
描述 |
是否必需 |
文件名 |
包含路徑的文件名 (路徑可以是相對於JMeter 啓動目錄的相對路徑) |
是 |
文件編碼方式(如果不採 用平臺默認的編碼方式) |
讀取文件需要用到的文件 編碼方式。如果沒有 指明就使用平臺默認的編碼方式 |
否 |
變量名 |
引用名(refName)用 於重用函數創建的值 |
否 |
詳解JMeter函數和變量(10)
6.預定義變量
大多數變量都是通過函數調用和測試元件(如用戶定義變量)來設置的;在這種情況下用戶擁有對變量名的完整控制權。但是有些變量是JMeter內置的。例如,
Cookiename:包含Cookie值。
JMeterThread.last_sample_ok:最近的採樣是否可以(true/false)。
START 變量(參見後續內容)。
7.預定義變量屬性
JMeter屬性集是在JMeter啓動時通過系統屬性初始化的;其他補充JMeter屬性來自於jmeter.properties、user.properties或者命令行。
JMeter還另外定義了一些內置屬性。下面是具體列表。從方便的角度考慮,屬性START的值會被複制到同名變量中去。
START.MS:以毫秒爲單位的JMeter啓動時間。
START.YMD:JMeter啓動日期格式yyyyMMdd。
START.HMS:JMeter啓動時間格式HHmmss。
TESTSTART.MS:以毫秒爲單位的測試啓動時間。
請注意:START變量/屬性表徵的是JMeter啓動時間,而非測試的啓動時間。它們主要用於文件名之中。