Java 外部コマンドを実行し3つの結果を取得

2018年9月17日 Java

Java 外部コマンドを実行し3つ（標準出力、エラー出力、リターンコード）の結果を取得

Java でコマンドや、バッチ・シェル等の外部実行ファイルを起動するサンプルプログラムを紹介します。
また外部コマンド実行と同時に、メソッドのリタンーン値として標準出力、エラー出力、リターンコードを取得します。

通常、Javaで外部コマンドを起動する方法は以下の方法で行えます。

Runtime r = Runtime.getRuntime();
r.exec(“実行するコマンド名”);

また、起動した外部コマンドのリターン値を取得するには、java.lang.ProcessのwaitFor()を実行します。

Process p = Runtime.getRuntime().exec(“実行するコマンド名”);
int ret = p.waitFor()

サンプルプログラム

/**
 * 外部コマンドを実行します。
 * またリタンーン値で、標準出力、エラー出力 、リターンコードを取得します。
 * 例：
 *     execCommand(“notepad.exe”);
 * 
 * @see execCommand(String[] cmds)
 *    ※実行するコマンドに引数（パラメータ）がある場合は、
 *    以下を使用してください。
 * @param cmd 実行するコマンド
 * @return コマンド実行結果情報を保持するString配列
 *    配列[0] ⇒ 標準出力 
 *    配列[1] ⇒ エラー出力 
 *    配列[2] ⇒ リターンコード
 * @throws IOException 入出力エラーが発生した場合
 */
public static String[] execCommand(String cmd) throws IOException,
        InterruptedException {
    return execCommand(new String[] { cmd });
}
/**
 * 外部コマンドを引数（パラメータ）を指定して実行します。
 * またリタンーン値で、標準出力、エラー出力 、リターンコードを取得します。
 * 例：
 *     execCommand(new String[]{“notepad.exe”,”C:\test.txt”});
 * 
 * Process.waitFor()を実行していますので、外部コマンドの実行が
 * 終了するまでこのメソッドは待機します。
 * 
 * @see execCommand(String cmd)
 *    ※実行するコマンドに引数がない場合は簡易的にこちらを
 *      使用してください。
 * @param cmds 実行するコマンドと引数を含む配列
 * @return コマンド実行結果情報を保持するString配列
 *    配列[0] ⇒ 標準出力 
 *    配列[1] ⇒ エラー出力 
 *    配列[2] ⇒ リターンコード
 * @throws IOException 入出力エラーが発生した場合
 */
public static String[] execCommand(String[] cmds) throws IOException,
                                                    InterruptedException {
    String[] returns = new String[3];
    String LINE_SEPA = System.getProperty(“line.separator”);
    Runtime r = Runtime.getRuntime();
    Process p = r.exec(cmds);
    InputStream in = null;
    BufferedReader br = null; 
    try {
        in = p.getInputStream();
        StringBuffer out = new StringBuffer();
        br = new BufferedReader(new InputStreamReader(in));
        String line;
        while ((line = br.readLine()) != null) {
            out.append(line + LINE_SEPA);
        }
        returns[0] = out.toString();
        br.close();
        in.close();
        in = p.getErrorStream();
        StringBuffer err = new StringBuffer();
        br = new BufferedReader(new InputStreamReader(in));
        while ((line = br.readLine()) != null) {
            err.append(line + LINE_SEPA);
        }
        returns[1] = err.toString();
        returns[2] = Integer.toString(p.waitFor());
        return returns;
    } finally {
        if (br != null) {
            br.close();
        }
        if (in != null) {
            in.close();
        }
    }
}

実行結果

◆実行例

public static void main(String[] args) {
    try {
    System.out.println(“\n—– 1. 引数なしで実行。” +
            “\n※helpコマンドを実行。”);
    String[]s = execCommand(“help”);
    System.out.println(
            “●[標準出力]\n”+s[0].substring(0,200)+
            “\n●[エラー出力]\n”+s[1]+
            “\n●[リターンコード]\n”+s[2]);
    
    System.out.println(“\n—– 2. 引数を指定して実行。” +
            “\n※helpコマンドの引数にdirを指定して実行。”);
    s = execCommand(new String[]{“help”,”dir”});
    System.out.println(
            “●[標準出力]\n”+s[0].substring(0,200)+
            “\n●[エラー出力]\n”+s[1]+
            “\n●[リターンコード]\n”+s[2]);

    System.out.println(“\n—– 3. バッチファイルを実行。” +
            “\n※さらにリターンコードを評価して処理を分岐する。”);
    s = execCommand(“C:\\test.bat”);
    if (!s[2].equals(“0”)) {
        System.out.println(“\ntest.batは異常終了しています。”+
                           “[リターンコード]=”+s[2]);
    }
    } catch (Exception e) {
        e.printStackTrace();
    }
}

◆出力結果

----- 1. 引数なしで実行。
※helpコマンドを実行。
●[標準出力]
特定のコマンドの詳細情報は、"HELP コマンド名" を入力してください
ASSOC    ファイル拡張子の関連付けを表示または変更します。
AT       コマンドやプログラムを指定した日時に実行します。
ATTRIB   ファイルの属性を表示または変更します。
BREAK    拡張 CTRL+C チェックを設定または解除します。
CACLS    ファイルのアクセス制御リスト (
●[エラー出力]

●[リターンコード]
1

----- 2. 引数を指定して実行。
※helpコマンドの引数にdirを指定して実行。
●[標準出力]
ディレクトリ中のファイルとサブディレクトリを一覧表示します。

DIR [ドライブ:][パス][ファイル名] [/A[[:]属性]] [/B] [/C] [/D] [/L] [/N]
  [/O[[:]ソート順]] [/P] [/Q] [/S] [/T[[:]タイムフィールド]] [/W] [/X] [/4]

  [ドライブ:][パス][ファイル名]
              一覧
●[エラー出力]

●[リターンコード]
1

----- 3. バッチファイルを実行。
※さらにリターンコードを評価して処理を分岐する。
test.batは異常終了しています。[リターンコード]=9

※test.batの内容

echo test.batが実行されました。
echo エラーが発生しています。
exit 9

Java 外部コマンドを実行し3つの結果を取得

Java 外部コマンドを実行し3つ（標準出力、エラー出力、リターンコード）の結果を取得

サンプルプログラム

実行結果

Java 数値⇔文字列⇔日付の変換

Javaの基本的な配列操作まとめ

Java 変数の型を instanceof で確認する

Javaの基本的な文字列操作まとめ