他のプログラミング言語の呼び出し
java (.jar)python (.py)php (.php)js (.js)BeanShell (.bsh)go (.go)shell (.sh)ruby (.rb)lua (.lua)TIP
外部プログラムの呼び出し
1.
2.
3.
pm.execute('com.apidog.Base64EncodeDemo.jar', ['abc','bcd'])の場合、実際に実行されるコマンドはjava -jar "com.apidog.Base64EncodeDemo.jar" "abc" "bcd"となる。
| 言語 | コマンドプレフィックス | ファイル拡張子 |
|---|---|---|
| Java | java -jar | .jar |
| Python | python | .py |
| PHP | php | .php |
| JavaScript | node | .js |
| BeanShell | java bsh.Interpreter | .bsh |
| Go | go run | .go |
| Shell | sh | .sh |
| Ruby | ruby | .rb |
| Lua | lua | .lua |
| Rust | cargo run | .rs |
| Python | python | .py |
API
pm.executeAsync
filePath string 外部プログラムのパスargs string[] パラメータ。jarパッケージ内の特定メソッドを呼び出す場合、JSON.stringifyが変換に使用される。それ以外の場合、_string_型以外は暗黙的に_string_に変換される。options Objectcommand string 外部プログラムの実行コマンド。「コマンドプレフィックス」の最初の部分が実行コマンドとなる。オプション、デフォルト値は自動的に推測される（上記の「コマンドプレフィックス」表を参照）。任意のプログラムにカスタマイズ可能。cwd string サブプロセスの作業ディレクトリ。オプション、デフォルトは「外部プログラムディレクトリ」。env Record<string, string> サブプロセスの環境変数。オプション、デフォルトは{}。windowsEncoding string Windows システムで使用するエンコーディング。オプション、デフォルトは"cp936"。className string jarパッケージ内で呼び出すクラス名（例："com.apidog.Utils"）。オプション。method string jarパッケージ内で呼び出すメソッド名（例："add"）。オプション（classNameに値がある場合は必須）。paramTypes string[] jarパッケージ内で呼び出すメソッドのパラメータ型（例：["int", "int"]）。オプション、デフォルトはパラメータに基づいて自動推測される。commandパラメータの使用.pyファイルの実行にpythonを使用する。コンピュータにpython3がインストールされている場合、commandをpython3に指定できる。pm.execute
TIP
pm.executeAsyncの使用を推奨する。詳細はコード移行手順を参照。pm.execute(filePath, args, options)filePath string 外部プログラムのパスargs string[] パラメータ。jarパッケージ内の特定メソッドを呼び出す場合、JSON.stringifyが変換に使用される。それ以外の場合、_string_型以外は暗黙的に_string_に変換される。options ObjectwindowsEncoding string Windowsシステムで使用するエンコーディング。オプション、デフォルトは"cp936"。className string jarパッケージ内で呼び出すクラス名（例："com.apidog.Utils"）。オプション。method string jarパッケージ内で呼び出すメソッド名（例："add"）。オプション（classNameに値がある場合は必須）。paramTypes string[] jarパッケージ内で呼び出すメソッドのパラメータ型（例：["int", "int"]）。オプション、デフォルトはパラメータに基づいて自動推測される。実行とログ
Shell/CMDに貼り付けてデバッグできる。TIP
pm.executeはstderrに内容がある場合に実行が失敗したと判断する。これにより、警告やエラーメッセージを出力する一部のプログラムが失敗することがある。pm.executeAsyncでは、プロセスの終了コードを使用して実行が失敗したかどうかを判断するように変更されている。
外部プログラムの入出力
パラメータ
pm.executeAsync('add.js', [2, 3])では、実際に実行されるコマンドはnode add.js 2 3となる。外部スクリプトadd.jsでパラメータを取得するには：TIP
1.
2.
戻り値
const result = await pm.executeAsync('add.js', [2, 3])では、以下のように結果を返すことができる：TIP
1.
2.
3.
4.
エラーのスロー
TIP
1.
2.
console.error('Error')はエラーをスローするのではなく、単にstderrに出力するだけ。他の言語を使用する際もこの点に注意してね。デバッグ情報
pm.executeAsyncは実行の成否の判断にstderrではなく終了コードを使用するため、stderrを実行に影響を与えずにデバッグ情報の出力に使用できる。TIP
1.
pm.executeAsyncでのみサポートされている。2.
pm.executeからpm.executeAsyncへの移行
pm.executeAsyncの戻り値は_Promise_型のため、executeを直接executeAsyncに変更することはできない。ただし、async/awaitを使用することで最小限の変更で移行できる。TIP
1.
executeをexecuteAsyncに変更する2.
awaitを追加する.jarパッケージ内の特定メソッドの呼び出し
TIP
>= 2.1.39が必要。内部ランタイムリフレクションを使用するSpring Bootのようなjarではなく、リフレクションで呼び出し可能なjarのみをサポートしている。options.classNameが指定された場合、デフォルトの動作を上書きし、代わりにjar内の指定されたメソッドを呼び出す。<app-dist>/assets/JarExecuter-1.1.0-jar-with-dependencies.jarは組み込みの実行プログラムで、ユーザープログラム./scripts/jar-1.0-SNAPSHOT.jar内のメソッドcom.apidog.Test.combine(String,String)をリフレクションで見つけ、パラメータ（JSON文字列）"hello"と"world"で呼び出す役割を担う。TIP
paramTypesはオプションだ。指定しない場合、パラメータに基づいて型が自動的に推測される。整数は"int"として、浮動小数点数は"double"として、真偽値は"boolean"として、文字列は"String"として推測される。配列は最初の要素に基づいて推測される（例：[3]は"int[]"として、[3.14]は"double[]"として推測される）。paramTypesを手動で指定する必要がある。paramTypes配列でサポートされる値："Number"、"int"、"Integer"、"long"、"Long"、"short"、"Short"、"float"、"Float"、"double"、"Double"、"boolean"、"Boolean"、"String"、"Number[]"、"int[]"、"Integer[]"、"long[]"、"Long[]"、"short[]"、"Short[]"、"float[]"、"Float[]"、"double[]"、"Double[]"、"boolean[]"、"Boolean[]"、"String[]"paramTypesは省略できる：例
1. PHPプログラム
2. Jarプログラム
よくある問題
1. 一部のプログラムではプロジェクト設定ファイルが必要で、不足するとエラーになる
could not find `Cargo.toml` in `<...>/ExternalPrograms` or any parent directorygo.mod file not found in current directory or any parent directory; see 'go help modules'cwdを指定する。2. MacOSにはPython 3が組み込まれているがPython 2はない
commandを"python3"に設定する。3. Command xxxが見つからない
4. 一部のWindowsシステムで外部スクリプトの呼び出しが文字化けする
windowsEncodingを'utf-8'に設定する