基於Process#waitFor()阻塞問題的解決

Posted on by

Process#waitFor()阻塞問題

有時需要在程序中調用可執行程序或腳本命令：

Process process = Runtime.getRuntime().exec(shPath);
int exitCode = process .waitFor();

Runtime.getRuntime()返回當前應用程序的Runtime對象，該對象的exec()方法指示Java虛擬機創建一個子進程執行指定的可執行程序，並返回與該子進程對應的Process對象實例。通過Process可以控制該子進程的執行或獲取該子進程的信息。

它的所有標準io(即stdin，stdout，stderr)操作都將通過三個流(getOutputStream()，getInputStream()，getErrorStream())重定向到父進程。父進程使用這些流來提供到子進程的輸入和獲得從子進程的輸出。因為輸入和輸出流提供有限的緩沖區大小，如果讀寫子進程的輸出流或輸入流出現失敗，當緩沖區滿之後將無法繼續寫入數據，則可能導致子進程阻塞，最終造成阻塞在waifor()這裡。

針對這種情況，解法是要清空getInputStream()和getErrorStream()這兩個流。而且兩個流的清空一定是異步的。

static void drainInBackground(final InputStream is) {  
            new Thread(new Runnable(){  
                public void run(){  
                    try{  
                        while( is.read() >= 0 );  
                    } catch(IOException e){   
                        // return on IOException                  
                    }  
                }  
            }).start();  
        }

還有一種解法是用ProcessBuilder來創建Process對象，必須要使用ProcessBuilder的redirectErrorStream方法。redirectErrorStream方法設置為ture的時候，會將getInputStream()，getErrorStream()兩個流合並，自動會清空流，無需自己處理。如果是false，getInputStream()，getErrorStream()兩個流分開，就必須自己處理，程序如下：

        try {  
            ProcessBuilder pbuilder=new ProcessBuilder("ping","192.168.0.125");  
            pbuilder.redirectErrorStream(true);  
            process=pbuilder.start();  
            reader=new BufferedReader(new InputStreamReader(process.getInputStream()));  
            String line=null;  
            while((line=reader.readLine())!=null){  
                System.out.println(line);  
            }     
            int result=process.waitFor();  
            System.out.println(result);  
        } catch (IOException e) {  
            // TODO Auto-generated catch block  
            e.printStackTrace();  
        } catch (InterruptedException e) {  
            // TODO Auto-generated catch block  
            e.printStackTrace();  
        } 
            Process process = null;
            try {
                process = launchProcess(cmdlist, environment);
                StringBuilder sb = new StringBuilder();
                String output = getOutput(process.getInputStream());
                String errorOutput = getOutput(process.getErrorStream());
                sb.append(output);
                sb.append("\n");
                sb.append(errorOutput);
                boolean ret = process.waitFor(1L, TimeUnit.SECONDS);
                if (!ret) {
                    System.out.println(command + " is terminated abnormally. ret={}, str={}" + ret + " " + sb.toString());
                }
                return sb.toString();
            } catch (Throwable e) {
                System.out.println("Failed to run " + command + ", ");
                e.printStackTrace();
            } finally {
                if (null != process) {
                    process.destroy();
                }
            }
            return "";

註意process一定要釋放

Process.waitFor()導致主線程堵塞

今日開發的時候使用jdk自帶的運行時變量 RunTime.getRunTime() 去執行bash命令。

因為該bash操作耗時比較長，所以使用瞭Process.waitFor()去等待子線程運行結束。

這個時候發現程序卡在waitFor()沒有繼續往下執行。

看瞭官方解釋：

  • waitFor：等待子進程執行結束，或者已終止子進程，此方法立即返回。

當RunTime對象調用exec方法後，jvm會創建一個子進程，該子進程與jvm建立三個管道連接：標準輸入流、標準輸出流、標準錯誤流。假設該子進程不斷向標準輸入流、標準輸出流寫數據，而jvm不讀取的話，會導致緩沖區塞滿而無法繼續寫數據，最終堵塞在waitFor這裡。

知道瞭問題所在就好處理瞭， 我們隻需要將子進程返回的信息從緩沖區讀取出來，便可以避免主線程堵塞問題。

public static void main(String[] args){
    Process proc = RunTime.getRunTime().exec("sh /home/winnie/dataExtract.sh")
 
    // 標準輸入流（必須寫在 waitFor 之前）
    String inStr = consumeInputStream(proc.getInputStream());
    // 標準錯誤流（必須寫在 waitFor 之前）
    String errStr = consumeInputStream(proc.getErrorStream());
 
    int retCode = proc.waitFor();
    if(retCode == 0){
        System.out.println("程序正常執行結束");
    }
}
 
/**
*   消費inputstream，並返回
*/
public static String consumeInputStream(InputStream is){
    BufferedReader br = new BufferedReader(new InputStreamReader(is));
    String s ;
    StringBuilder sb = new StringBuilder();
    while((s=br.readLine())!=null){
        System.out.println(s);
        sb.append(s);
    }
    return sb.toString();
}

以上為個人經驗，希望能給大傢一個參考，也希望大傢多多支持WalkonNet。

推薦閱讀：