20. 関数と変数¶

正規表現関数は、任意の正規表現 (ユーザーが提供) を使用して前の応答 (または変数の値) を解析するために使用されます。この関数は、変数値が入力されたテンプレート文字列を返します。

__regexFunctionは、将来の使用のために値を格納することもできます。6 番目のパラメーターでは、参照名を指定できます。この関数の実行後、ユーザー定義値の構文を使用して、後で同じ値を取得できます。たとえば、「refName」を 6 番目のパラメーターとして入力すると、以下を使用できるようになります。

• ${refName}は、この関数によって解析された 2 番目のパラメーター (「置換文字列のテンプレート」) の計算結果を参照します。
• ${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 関数を使用して、2 つ以上の整数値の合計を計算できます。

longSum 関数を使用して、2 つ以上の long 値の合計を計算できます。値が -2147483648 から 2147483647 の範囲にないことがわかっている場合は、__intSum の代わりにこれを使用してください。

StringFromFile 関数を使用して、テキスト ファイルから文字列を読み取ることができます。これは、多くの変数データを必要とするテストを実行する場合に便利です。たとえば、銀行アプリケーションをテストする場合、数百または数千の異なる口座番号が必要になる場合があります。

使いやすいCSV Data Set Config テスト要素 も参照してください 。ただし、現在、複数の入力ファイルはサポートされていません。

呼び出されるたびに、ファイルから次の行を読み取ります。すべてのスレッドが同じインスタンスを共有するため、異なるスレッドは異なる行を取得します。ファイルの終わりに到達すると、最大ループ回数に達していない限り、最初から読み取りを再開します。テスト スクリプト内の関数への参照が複数ある場合、ファイル名が同じであっても、それぞれが個別にファイルを開きます。[値を別の場所で再度使用する場合は、関数呼び出しごとに異なる変数名を使用してください。]

ファイルのオープンまたは読み取りでエラーが発生した場合、関数は文字列 " **ERR** "を返します。

machineName 関数は、ローカル ホスト名を返します。これは、Java メソッドInetAddress.getLocalHost()を使用し、それをgetHostName()に渡します。

machineIP 関数は、ローカル IP アドレスを返します。これは、Java メソッドInetAddress.getLocalHost()を使用し、それをgetHostAddress()に渡します。

javaScript 関数は、JavaScript (Java ではありません!) コードの一部を実行し、その値を返します。

JMeter Javascript 関数は、スタンドアロンの JavaScript インタープリターを呼び出します。スクリプト言語としてJavascriptを使用しているため、計算などを行うことができます。

次の変数がスクリプトで使用可能になります。

• log -関数のロガー
• 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 関数は、使用する chars 内の文字を使用して、長さのランダムな文字列を返します。

RandomFromMultipleVars 関数は、 Source Variablesによって提供される変数値に基づいてランダム値を返します。

• 境界抽出器
• 正規表現エクストラクタ
• CSS セレクター エクストラクタ
• JSON エクストラクタ
• XPath エクストラクタ
• XPath2 エクストラクタ

UUID 関数は、疑似乱数型 4 Universally Unique IDentifier (UUID) を返します。

CSVRead 関数は、CSV ファイルから文字列を返します ( StringFromFileを参照) 。

注: JMeter は複数のファイル名をサポートしています。

ほとんどの場合、新しい CSV Data Set Config 要素 の方が使いやすいです。

ファイル名が最初に検出されると、ファイルが開かれ、内部配列に読み込まれます。空白行が検出された場合、これはファイルの終わりとして扱われます。これにより、末尾のコメントを使用できます。

同じファイル名への後続のすべての参照は、同じ内部配列を使用します。OSが気にしない場合でも、ファイル名の大文字と小文字は関数にとって重要であるため、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

ログ関数はメッセージをログに記録し、その入力文字列を返します

logn 関数はメッセージをログに記録し、空の文字列を返します

BeanShell 関数は、渡されたスクリプトを評価し、結果を返します。

BeanShell の使用の詳細については、BeanShell の Web サイト ( http://www.beanshell.org/ ) を参照してください。

関数の 1 つのインスタンスを複数のスレッドから呼び出すことができます。ただし、関数execute()メソッドは同期されます。

プロパティ「beanshell.function.init」が定義されている場合、ソース ファイルの名前としてインタープリターに渡されます。これは、共通のメソッドと変数を定義するために使用できます。bin ディレクトリにサンプルの初期化ファイルがあります: BeanShellFunction.bshrc。

スクリプトが実行される前に、次の変数が設定されます。

• log - BeanShell 関数のロガー(*)
• 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 関数のロガー(*)
• 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 プロパティの値を設定します。関数からのデフォルトの戻り値は空の​​文字列であるため、関数呼び出しは関数が有効な場所ならどこでも使用できます。

^{オプションの 3番目}のパラメータを「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 = name='${name}' の ${table} から ${column} を選択

これは、CSV データセットと組み合わせて使用​​できます。たとえば、SQL ステートメントと値の両方がデータ ファイルで定義されている場合です。

char 関数は、数字のリストを Unicode 文字として評価した結果を返します。以下の__unescape()も参照してください。

これにより、任意の文字値をフィールドに追加できます。

unescape 関数は、Java エスケープ文字列を評価した結果を返します。上記の__char()も参照してください。

これにより、他の方法では GUI を介して定義するのが難しい (または不可能な) フィールドに文字を追加できます。

HTML エンティティを含む文字列をエスケープ解除する関数は、エスケープに対応する実際の Unicode 文字を含む文字列にエスケープします。HTML 4.0 エンティティをサポートします。

たとえば、文字列

${__unescapeHtml(<フランçais>)}

エンティティが認識されない場合はそのままにして、そのまま結果文字列に挿入します。たとえば、 ${__unescapeHtml(>&zzzz;x)}は>&zzzz;xを返します。

Commons Lang の StringEscapeUtils#unescapeHtml(String) を 使用します。

HTML エンティティを使用して String 内の文字をエスケープする関数。HTML 4.0 エンティティをサポートします。

例えば、

${__escapeHtml("パン" & "バター")}

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(単語「学校」はフランス語で「エコール」です)}

Java クラスURLEncoderを使用します。

FileToString 関数を使用して、ファイル全体を読み取ることができます。呼び出されるたびに、ファイル全体を読み取ります。

ファイルのオープンまたは読み取りでエラーが発生した場合、関数は文字列 " **ERR** "を返します。

samplerName 関数は、現在のサンプラーの名前 (ラベル) を返します。

この関数は、サンプラーが関連付けられていないテスト要素では機能しません。たとえば、テスト計画。構成要素には、関連付けられたサンプラーもありません。ただし、一部の構成要素は、HTTP ヘッダー マネージャーや Http Cookie マネージャーなどのサンプラーによって直接参照されます。この場合、関数は Http サンプラーのコンテキストで解決されます。プリプロセッサ、ポストプロセッサ、およびアサーションには、常にサンプラーが関連付けられています。

例：

${__samplerName()}

TestPlanName 関数は、現在のテスト計画の名前を返します (プランを含めるで使用して、呼び出し元のテスト計画の名前を知ることができます)。

ORO Regexp メタ文字をエスケープする関数。Java Regexp Engine の\Q \Eに相当します。

例えば、

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

ORO の Perl5Compiler#quotemeta(String) を使用します。

XML 1.0 エンティティを使用して String 内の文字をエスケープする関数。

例えば、

${__escapeXml("パン" & 'バター')}

Commons Lang の StringEscapeUtils#escapeXml10(String) を 使用します。

timeShift 関数は、指定された秒数、分数、時間数、日数、または月数を加算して、指定された形式で日付を返します。

ダイジェスト関数は、オプションのソルト、大文字、および変数名を使用して、特定のハッシュ アルゴリズムで暗号化された値を返します。

__dateTimeConvert関数は、ソース形式の日付をターゲット形式に変換し、オプションで結果を変数名に格納します。

__isPropDefined関数は、プロパティが存在する場合は true を返し、存在しない場合は false を返します。

__isVarDefined関数は、変数が存在する場合は true、存在しない場合は false を返します。

大文字小文字の変更関数は、特定のモードに従って大文字小文字が変更された文字列値を返します。結果は、必要に応じて JMeter 変数に保存できます。

__StringToFile関数を使用して、文字列をファイルに書き込むことができます。呼び出されるたびに、文字列をファイルに追加または上書きして書き込みます。

関数からのデフォルトの戻り値は空の​​文字列です