如何正確的使用 Runtime.exec()

或許大部分有寫過Java程式的人都知道java.lang.Runtime這個class有一個method叫做exec()，可以被用來呼叫(調用)外部的程式。然而大部分的人都不知道這個method存在著幾個機車的小陷阱，一個不小心就會發生災難了，待我娓娓道來...

這個method有幾個overloaded的版本如下：

Process	exec(String[] progArray, String[] envp, File directory) Executes the specified command and its arguments in a separate native process.
Process	exec(String prog, String[] envp) Executes the specified program in a separate native process.
Process	exec(String prog) Executes the specified program in a separate native process.
Process	exec(String prog, String[] envp, File directory) Executes the specified program in a separate native process.
Process	exec(String[] progArray) Executes the specified command and its arguments in a separate native process.
Process	exec(String[] progArray, String[] envp) Executes the specified command and its arguments in a separate native process.

其中prog這個參數是要執行的外部可執行檔名稱，progArray則是可執行檔名稱和一些參數，當然你也可以把progArray合成一個prog參數(中間必須用空白格開)，不過，問題多多。envp表示環境變數，directory表示可執行檔的目錄，更詳細的參數說明請參考Java文件。

請看以下的程式碼隱藏著什麼樣的危機？

import java.util.*;

import java.io.*;

public class BadExample1 {

    public static void main (String args[]) {

        try {

            Runtime rt = Runtime.getRuntime ();

            Process proc = rt.exec ("javac");

            int exitVal = proc.exitValue ();

            System.out.println ("Process exitValue: " + exitVal);

        } catch (Exception e) {

            e.printStackTrace ();

        }

    }

}

結果是：

java BadExample1

java.lang.IllegalThreadStateException: process has not exited

        at java.lang.Win32Process.exitValue(Native Method)

        at BadExample1.main(BadExample1.java:13)

奇怪，這麼簡單的程式碼，不過就是請exec執行一行javac，怎麼就跳出Exception了呢？讓我們來分析一下，首先這段程式用getRuntime()這個static method取得Runtime物件，然後呼叫exec去執行"javac"外部可執行檔，最後取得回傳值並把它輸出在標準輸出。問題來了，exec會create一個新的process來執行外部可執行檔，如果呼叫proc.exitValue()的時候javac還沒執行完畢，JVM就會丟出IllegalThreadStateException (記得嗎？在多工的作業系統裡，每個process幾乎可以被看成是同時運行的，既然如此沒有人可以保證process執行完成的先後順序。) ，有方法可以等外部process執行完畢嗎？YES，Process這個class提供了一個waitFor() method正好可以用來解決這個問題，而且waitFor()還會回傳等同於
exitValue()回傳值，所以程式再度改寫如下：

import java.util.*;

import java.io.*;

public class BadExample2 {

    public static void main (String) {

        try {

            Runtime rt = Runtime.getRuntime ();

            Process proc = rt.exec ("javac");

            int exitVal = proc.waitFor ();

            System.out.println ("Process exitValue: " + exitVal);

        } catch (Exception e) {

            e.printStackTrace();

        }

    }

}

Sorry, Sorry, Sorry...讓我想起當紅的SorrySorry舞，很抱歉，這次程式直接當在那裡給你看，奇怪？為什麼會當，原來JDK裡面有一段話是這麼說的：

Because some native platforms only provide limited buffer size for standard input and output streams, failure to promptly write the input stream or read the output stream of the subprocess may cause the subprocess to block, and even deadlock.

好吧，所以以這個例子而言，應該要把stderr跟stdout裡面的buffer趕快讀走，再度改寫程式如下：

import java.util.*;

import java.io.*;

public class OkExample1 {

    public static void main (String args[]) {

        try {

            Runtime rt = Runtime.getRuntime ();

            Process proc = rt.exec ("javac");

            String line = null;

            InputStream stderr = proc.getErrorStream ();

            InputStreamReader esr = new InputStreamReader (stderr);

            BufferedReader ebr = new BufferedReader (esr);

            System.out.println ("<error>");

            while ( (line = ebr.readLine ()) != null)

                System.out.println(line);

            System.out.println ("</error>");

            InputStream stdout = proc.getInputStream ();

            InputStreamReader osr = new InputStreamReader (stdout);

            BufferedReader obr = new BufferedReader (osr);

            System.out.println ("<output>");

            while ( (line = obr.readLine ()) != null)

                System.out.println(line);

            System.out.println ("</output>");

            int exitVal = proc.waitFor ();

            System.out.println ("Process exitValue: " + exitVal);

        } catch (Exception e) {

            e.printStackTrace();

        }

    }

}

輸出結果：

java OkExample1

<error>

Usage: javac <options> <source files>

where <options> includes:

  -g                     Generate all debugging info

  -g:none                Generate no debugging info

  -g:{lines,vars,source} Generate only some debugging info

  -O                     Optimize; may hinder debugging or enlarge class files

  -nowarn                Generate no warnings

  -verbose               Output messages about what the compiler is doing

  -deprecation           Output source locations where deprecated APIs are used

  -classpath <path>      Specify where to find user class files

  -sourcepath <path>     Specify where to find input source files

  -bootclasspath <path>  Override location of bootstrap class files

  -extdirs <dirs>        Override location of installed extensions

  -d <directory>         Specify where to place generated class files

  -encoding <encoding>   Specify character encoding used by source files

  -target <release>      Generate class files for specific VM version

</error>

Process exitValue: 2

雖然程式醜了點，但至少結果是還OK的，更好的作法是create兩個thread分別把stdout與stderr的資料讀出來。不過這裡有一點需要注意，得到stdout的方法是呼叫getInputStream()名稱上比較容易搞混。

另一個常犯的錯誤是把console指令或shell指令當作是可執行檔，例如win32上的dir和copy:

import java.util.*;

import java.io.*;

public class BadExample3 {

    public static void main (String args[]) {

        try {

            Runtime rt = Runtime.getRuntime ();

            Process proc = rt.exec ("dir");

            InputStream stderr = proc.getErrorStream ();

            InputStreamReader esr = new InputStreamReader (stderr);

            BufferedReader ebr = new BufferedReader (esr);

            System.out.println ("<error>");

            while ( (line = ebr.readLine ()) != null)

                System.out.println(line);

            System.out.println ("</error>");

            InputStream stdout = proc.getInputStream ();

            InputStreamReader osr = new InputStreamReader (stdout);

            BufferedReader obr = new BufferedReader (osr);

            System.out.println ("<output>");

            while ( (line = obr.readLine ()) != null)

                System.out.println(line);

            System.out.println ("</output>");

            int exitVal = proc.waitFor ();

            System.out.println ("Process exitValue: " + exitVal);

        } catch (Exception e) {

            e.printStackTrace();

        }

    }

}

輸出結果：

java BadExample3

java.io.IOException: CreateProcess: dir error=2

        at java.lang.Win32Process.create(Native Method)

        at java.lang.Win32Process.<init>(Unknown Source)

        at java.lang.Runtime.execInternal(Native Method)

        at java.lang.Runtime.exec(Unknown Source)

        at java.lang.Runtime.exec(Unknown Source)

        at java.lang.Runtime.exec(Unknown Source)

        at java.lang.Runtime.exec(Unknown Source)

        at BadExecWinDir.main(BadExecWinDir.java:12)

error=2表示找不到這個檔案，也就是系統並不存在dir.exe，哪是因為dir只是window command interpreter(command.com或cmd.exe)的其中一個指令。所以我們把上面的例子再改寫:

import java.util.*;

import java.io.*;

class StreamConsumer extends Thread {

    InputStream is;

    String type;

    StreamConsumer (InputStream is, String type) {

        this.is = is;

        this.type = type;

    }

    public void run () {

        try {

            InputStreamReader isr = new InputStreamReader (is);

            BufferedReader br = new BufferedReader (isr);

            String line = null;

            while ((line = br.readLine()) != null)

                System.out.println (type + ">" + line);

        } catch (IOException ioe) {

            ioe.printStackTrace();

        }

    }

}

public class GoodExample1 {

    public static void main (String args[]) {

        if (args.length < 1) {

            System.out.println ("USAGE: java GoodWindowsExec <cmd>");

            System.exit (1);

        }

        try {

            String osName = System.getProperty ("os.name");

            String[] cmd = new String[3];

            if (osName.equals ("Windows NT")) {

                cmd[0] = "cmd.exe";

                cmd[1] = "/C";

                cmd[2] = args[0];

            } else if( osName.equals ("Windows 95")) {

                cmd[0] = "command.com";

                cmd[1] = "/C";

                cmd[2] = args[0];

            }

            Runtime rt = Runtime.getRuntime ();

            System.out.println ("Execing " + cmd[0] + " " + cmd[1]

                               + " " + cmd[2]);

            Process proc = rt.exec (cmd);

            // any error message?

            StreamConsumer errorConsumer = new

                StreamConsumer (proc.getErrorStream(), "error");            

            // any output?

            StreamConsumer outputConsumer = new

                StreamConsumer (proc.getInputStream(), "output");

            // kick them off

            errorConsumer.start ();

            outputCosumer.start ();

            // any error???

            int exitVal = proc.waitFor ();

            System.out.println ("ExitValue: " + exitVal);

        } catch (Exception e) {

            e.printStackTrace ();

        }

    }

}

輸出結果：

java GoodExample1 "dir *.java"

Execing cmd.exe /C dir *.java

output> Volume in drive E has no label.

output> Volume Serial Number is 5C5F-0CC9

output>

output> Directory of E:\classes\com\javaworld\jpitfalls\article2

output>

output>10/23/00  09:01p                   805 BadExecBrowser.java

output>10/22/00  09:35a                   770 BadExecBrowser1.java

output>10/24/00  08:45p                   488 BadExecJavac.java

output>10/24/00  08:46p                   519 BadExecJavac2.java

output>10/24/00  09:13p                   930 BadExecWinDir.java

output>10/22/00  09:21a                 2,282 BadURLPost.java

output>10/22/00  09:20a                 2,273 BadURLPost1.java

... (省略)

output>10/12/00  09:29p                   151 SuperFrame.java

output>10/24/00  09:23p                 1,814 TestExec.java

output>10/09/00  05:47p                23,543 TestStringReplace.java

output>10/12/00  08:55p                   228 TopLevel.java

output>              22 File(s)         46,661 bytes

output>                         19,678,420,992 bytes free

ExitValue: 0

還有一個常犯的錯誤是認為所有console或shell上可以執行的指令以為都可以透過exec()來達成，例如redirect >，請看:

import java.util.*;

import java.io.*;

public class BadExample4 {

    public static void main (String args[]) {

        try {

            Runtime rt = Runtime.getRuntime ();

            Process proc = rt.exec ("echo 'Hello World' > test.txt");

            // any error message?

            StreamGobbler errorConsumer = new

                StreamConsumer (proc.getErrorStream (), "error");            

            // any output?

            StreamGobbler outputConsumer = new

                StreamConsumer (proc.getInputStream (), "output");

            // kick them off

            errorConsumer.start();

            outputConsumer.start();

            // any error???

            int exitVal = proc.waitFor ();

            System.out.println ("ExitValue: " + exitVal);

        } catch (Exception e) {

            e.printStackTrace ();

        }

    }

}

輸出結果：

java BadExample4

OUTPUT>'Hello World' > test.txt

ExitValue: 0

如果這段command可以成功執行，那麼理論上test.txt應該會有一行'Hello World'，但是事實上test.txt並不存在，也就是說redirect無法正確的被執行。

解決的辦法是：

自己開檔案把字串寫到test.txt裡面去。
建立一個.bat(win32)或.sh(linux)然後去執行。

參考資料:

http://www.javaworld.com/javaworld/jw-12-2000/jw-1229-traps.html

如何正確的使用 Runtime.exec()的更多相关文章

Runtime.exec() sucks!!!!
自己项目中使用到了 Runtime rt = Runtime.getRuntime(); Process p = rt.exec("query session");p.waitFo ...
Java魔法堂：找外援的利器——Runtime.exec详解
一.前言 Java虽然五脏俱全但总有软肋,譬如获取CPU等硬件信息,当然我们可以通过JNI调用C/C++来获取,但对于对C/C++和Windows API不熟的码农是一系列复杂的学习和踩坑过程.那能不 ...
Java运行系统命令并获取值（Process java.lang.Runtime.exec(String[] cmdarray, String[] envp, File dir)
package test; import java.io.BufferedReader; import java.io.IOException; import java.io.InputStream; ...
权限执行[Android开发常见问题-4] RunTime.exec()如何以root权限执行多条指令？
每日一贴,今天的内容关键字为权限执行 RunTime.exec()这个接口可以说是给我们开发者供给了一个很好的直观操纵底层操纵系统的机遇,但是这个接口的使用还有很多需要注意的问题.由于要完全的分析这个 ...
Runtime.exec()
关于RunTime类的介绍: /** * Every Java application has a single instance of class * <code>Runtime< ...
Java Runtime.exec()的使用
Sun的doc里其实说明还有其他的用法: exec(String[] cmdarray, String[] envp, File dir) Executes the specified command ...
执行Runtime.exec()需要注意的陷阱
作为Java语言的一部分.java.lang包被隐藏的导入到每一个Java程序.这个包的表面陷阱,经常影响到大多数程序员.这个月,我将讨论运行时exec()方法时的潜伏陷阱. 陷阱4:当运行exec( ...
[转]Java中Runtime.exec的一些事
0 预备知识 1 不正确的调用exitValue 2不正确的调用waitFor 3 一种可接受的调用方式 4 调用认为是可执行程序的时候容易发生的错误 5 window执行的良好示例 6 不良好的重定 ...
WPF 正確理解ContentPresenter
我們先由下圖來看類層次,可知ContentControl繼承Control,ContentPresenter繼承FrameworkElement(Control也繼承FrameworkElement) ...

随机推荐

Aho-Corasick automaton（AC自动机）解析及其在算法竞赛中的典型应用举例
摘要: 本文主要讲述了AC自动机的基本思想和实现原理,如何构造AC自动机,着重讲解AC自动机在算法竞赛中的一些典型应用. 什么是AC自动机? 如何构造一个AC自动机? AC自动机在算法竞赛中的典型应用 ...
S5PV210 串口配置与实验(轮询方式)
S5PV210 UART 相关说明通用异步收发器简称 UART, 即 UNIVERSAL ASYNCHRONOUS RECEIVER AND TRANSMITTER,它用来传输串行数据.发送数据时, ...
JavaScript字符串常用方法
toUpperCase():把一个字符串全部变为大写 toLowerCase():把一个字符串全部变为小写 indexOf():会搜索制定字符串出现的位置,有返回索引,没有返回-1 substring ...
CentOS7下查看系统环境（内存CPU磁盘使用率）
1.方法一 yum install atop --安装atop sudo atop--开启监视 2.方法二 top 3.方法三 free --查看没存情况 ps ux --查看CPU 情况磁盘 df
C# 数据库并发的解决方案（通用版、EF版）
自ASP.NET诞生以来,微软提供了不少控制并发的方法,在了解这些控制并发的方法前,我们先来简单介绍下并发! 并发:同一时间或者同一时刻多个访问者同时访问某一更新操作时,会产生并发! 针对并发的处理, ...
[PHP] 数据结构-链表创建-插入-删除-查找的PHP实现
链表获取元素1.声明结点p指向链表第一个结点,j初始化1开始2.j<i,p指向下一结点,因为此时p是指向的p的next,因此不需要等于3.如果到末尾了,p还为null,就是没有查找到插入元素1 ...
Oracle索引失效原因及解决方法
一.Oracle索引失效的原因 1使用否定关键字 !=, <> ,not in,not exist select * fromdrama where id <> 1,Mysql ...
jquery之行自加自减
实现目标:点击按钮复制本行,修改后重新插入到本行后面,点击复制出的行可删除本行代码如下: <!DOCTYPE html> <html lang="en"> ...
从零开始学习html（二）认识标签(第一部分)——下
八.<blockquote>标签,长文本引用 <!DOCTYPE HTML> <html> <head> <meta http-equiv=&qu ...
python自动化开发-3
python里的集合 1.集合的概念集合(set):把不同的元素组成一起形成集合,是python基本的数据类型.set集合,是一个无序且不重复的元素集合. 2.集合的主要作用 1)去重举例说明: ...

如何正確的使用 Runtime.exec()

如何正確的使用 Runtime.exec()的更多相关文章

随机推荐

热门专题