使用 ProcessBuilder API 優化你的流程

ProcessBuilder 介紹

Java 的 Process API 爲開發者提供了執行操作系統命令的強大功能，但是某些 API 方法可能讓你有些疑惑，沒關係，這篇文章將詳細介紹如何使用 ProcessBuilder API 來方便的操作系統命令。

ProcessBuilder 入門示例

我們通過演示如何調用 java -version 命令輸出 JDK 版本號，來演示 ProcessBuilder 的入門用法。

package com.wdbyte.os.process;

import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;

import org.apache.commons.io.IOUtils;

/**
 * Process 輸出Java 版本號
 * @author https://www.wdbyte.com
 */
public class ProcessBuilderTest1 {

    public static void main(String[] args) throws IOException, InterruptedException {
        // 構建執行命令
        ProcessBuilder processBuilder = new ProcessBuilder("java","-version");
        // 重定向 ERROR 流(有些 JDK 版本 Java 命令通過 ERROR 流輸出)
        processBuilder.redirectErrorStream(true);
        // 運行命令 java -version
        Process process = processBuilder.start();
        // 獲取PID，這是一個 Java 9 方法
        long pid = process.pid();
        // 一次性獲取運行結果
        String result = IOUtils.toString(process.getInputStream());
        // 等到運行結束
        int exitCode = process.waitFor();

        System.out.println("pid:" + pid);
        System.out.println("result:" + result);
        System.out.println("exitCode:" + exitCode);
    }
}

在這段代碼中，首先使用 ProcessBuilder 對象包裝了要執行的命令 java -version，緊接着重定向了要執行的進程的 ERROR 輸出流(有些 JDK 版本 Java 命令通過 ERROR 流輸出)。最後通過 start 方法執行命令，得到一個用於進程管理的 Process 對象，可以獲取其 pid 和輸出結果。

注意 IOUtils.toString(process.getInputStream());

這裏使用了 commons-io 中的工具類把 InputStream 轉爲字符串。

commons-io Maven 依賴：

<dependency>
    <groupId>commons-io</groupId>
    <artifactId>commons-io</artifactId>
    <version>2.12.0</version>
</dependency>

運行得到輸出：

pid:80885
result:java version "1.8.0_151"
Java(TM) SE Runtime Environment (build 1.8.0_151-b12)
Java HotSpot(TM) 64-Bit Server VM (build 25.151-b12, mixed mode)

exitCode:0

ProcessBuilder 環境變量

在下面這個示例中，演示如何獲取當前環境變量，以及如何修改環境變量並傳入子進程中。

輸出當前環境變量。

ProcessBuilder processBuilder = new ProcessBuilder();
Map<String, String> environment = processBuilder.environment();
environment.forEach((k, v) -> System.out.println(k + ":" + v));
processBuilder.environment().put("my_website","www.wdbyte.com");

這會打印出當前所有環境變量。

JAVA_HOME:/Library/Java/JavaVirtualMachines/jdk1.8.0_151.jdk/Contents/Home
COMMAND_MODE:unix2003
JAVA_MAIN_CLASS_81717:com.wdbyte.os.process.ProcessBuilderTest2
LOGNAME:darcy
.....

添加一個環境變量。

processBuilder.environment().put("my_website","www.wdbyte.com");

打印出剛纔添加的環境變量。

// Linux 或 MacOS 下 ，Windows 下無此命令
processBuilder.command("/bin/bash", "-c", "echo $my_website");
Process process = processBuilder.start();

long pid = process.pid();
String result = IOUtils.toString(process.getInputStream());
int exitCode = process.waitFor();

System.out.println("pid:" + pid);
System.out.println("result:" + result);
System.out.println("exitCode:" + exitCode);

這會輸出：

pid:81719
result:www.wdbyte.com
exitCode:0

ProcessBuilder 工作目錄

使用 directory 方法可以修改子進程默認的工作目錄，下面的示例中修改進程工作目錄爲 process 文件夾。

package com.wdbyte.os.process;

import java.io.File;
import java.io.IOException;

import org.apache.commons.io.IOUtils;

/**
 * 修改工作目錄
 * @author https://www.wdbyte.com
 */
public class ProcessBuilderTest3 {

    private static String BASE_DIR = "/Users/darcy/git/JavaNotes/core-java-modules/core-java-os/src/main/java/com/wdbyte/os/process";

    public static void main(String[] args) throws IOException, InterruptedException {
        ProcessBuilder processBuilder = new ProcessBuilder();
        processBuilder.directory(new File(BASE_DIR));
        // /bin/bash 命令只在 linux or macos 下有效
        processBuilder.command("/bin/bash", "-c", "pwd");
        Process process = processBuilder.start();

        long pid = process.pid();
        String result = IOUtils.toString(process.getInputStream());
        int exitCode = process.waitFor();

        System.out.println("pid:" + pid);
        System.out.println("result:" + result);
        System.out.println("exitCode:" + exitCode);
    }
}

輸出：

pid:82456
result:/Users/darcy/git/JavaNotes/core-java-modules/core-java-os/src/main/java/com/wdbyte/os/process
exitCode:0

ProcessBuilder I/O

在上面的示例中，都是把運行的新進程的輸出通過 getInputStream 的方式讀取到當前進程，然後輸出，這種方式很不方便。日誌輸出常見的方式是輸出到指定日誌文件，ProcessBuilder 對此也有很好的支持。

輸出到文件

使用 redirectOutput 可以指定日誌輸出的文件，這個方法會自動創建日誌文件。下面的例子在指定目錄下執行 ls-l 命令列出目錄下的所有文件。

package com.wdbyte.os.process;

import java.io.File;
import java.io.IOException;
import java.nio.file.Files;

/**
 * 輸出日誌到指定文件
 * @author https://www.wdbyte.com
 */
public class ProcessBuilderTest4 {
    private static String BASE_DIR = "/Users/darcy/git/JavaNotes/core-java-modules/core-java-os/src/main/java/com/wdbyte/os/process";

    public static void main(String[] args) throws IOException, InterruptedException {
        ProcessBuilder processBuilder = new ProcessBuilder();
        processBuilder.directory(new File(BASE_DIR));
        processBuilder.command("/bin/bash", "-c", "ls -l");

        File logFile = new File(BASE_DIR + "/process_log.txt");
        // 輸出到日誌文件
        processBuilder.redirectOutput(logFile);
        // 追加日誌到文件
        // processBuilder.redirectOutput(ProcessBuilder.Redirect.appendTo(logFile));
        // 是否輸出ERROR日誌到文件
        processBuilder.redirectErrorStream(true);

        Process process = processBuilder.start();
        long pid = process.pid();
        int exitCode = process.waitFor();
        System.out.println("pid:" + pid);
        System.out.println("exitCode:" + exitCode);

        // 讀取日誌文件
        Files.lines(logFile.toPath()).forEach(System.out::println);
    }
}

輸出日誌：

pid:30609
exitCode:0
total 96
-rw-r--r--  1 darcy  staff   749 Jun  6 22:34 ExecDemo.java
-rw-r--r--  1 darcy  staff   445 Jun  7 14:59 ExecDemo2.java
-rw-r--r--  1 darcy  staff  2011 Jun  7 15:33 ProcessBuilder10.java
-rw-r--r--  1 darcy  staff  1807 Jun  6 22:54 ProcessBuilderTest1.java
-rw-r--r--  1 darcy  staff  1054 Jun  6 23:01 ProcessBuilderTest2.java
-rw-r--r--  1 darcy  staff   963 Jun  6 23:05 ProcessBuilderTest3.java
-rw-r--r--  1 darcy  staff  1295 Jun  7 17:02 ProcessBuilderTest4.java
-rw-r--r--  1 darcy  staff  1250 Jun  6 22:34 ProcessBuilderTest5.java
-rw-r--r--  1 darcy  staff   929 Jun  6 22:34 ProcessBuilderTest6.java
-rw-r--r--  1 darcy  staff   911 Jun  6 22:34 ProcessBuilderTest7.java
-rw-r--r--  1 darcy  staff  1305 Jun  6 22:34 ProcessBuilderTest8.java
-rw-r--r--  1 darcy  staff  1278 Jun  7 14:59 ProcessBuilderTest9.java
-rw-r--r--  1 darcy  staff     0 Jun  7 17:03 process_log.txt

如果想要追加日誌到指定文件，應該使用：

processBuilder.redirectOutput(ProcessBuilder.Redirect.appendTo(logFile));

使用 processBuilder 也可以指定 INFO 和 ERROR 日誌到不同的文件。

ProcessBuilder processBuilder = new ProcessBuilder();
processBuilder.directory(new File(BASE_DIR));
// 執行命令 xxx，命令不存在，會報 ERROR 日誌
processBuilder.command("/bin/bash", "-c", "xxx");

File infoLogFile = new File(BASE_DIR + "/process_log_info.txt");
File errorLogFile = new File(BASE_DIR + "/process_log_error.txt");
// 日誌輸出到文件
processBuilder.redirectOutput(infoLogFile);
processBuilder.redirectError(errorLogFile);
Process process = processBuilder.start();

// 讀取 ERROR 日誌
Files.lines(errorLogFile.toPath()).forEach(System.out::println);

運行輸出：

/bin/bash: xxx: command not found

輸出到當前進程

在這個示例中，將看到 inheritIO() 方法的作用。當我們想將子進程的 I/O 重定向到當前進程的標準 I/O 時，可以使用這個方法：

package com.wdbyte.os.process;

import java.io.File;
import java.io.IOException;

/**
 * 子線程 I/O 重定向到當前線程
 * @author https://www.wdbyte.com
 */
public class ProcessBuilderTest6 {
    public static void main(String[] args) throws IOException, InterruptedException {
        ProcessBuilder processBuilder = new ProcessBuilder();
        processBuilder.directory(new File("./"));
        processBuilder.command("/bin/bash", "-c", "ls -l");
        // 把子線程 I/O 輸出重定向當前進程
        processBuilder.inheritIO();
        Process process = processBuilder.start();
        int exitCode = process.waitFor();
        System.out.println("exitCode:" + exitCode);
    }
}

這會輸出：

total 2904
-rw-r--r--   1 darcy  staff     5822 May  2 22:33 ArrayList.uml
-rw-r--r--   1 darcy  staff    16555 May 16 16:07 README.md
-rw-r--r--   1 darcy  staff      333 May  4 19:30 core-java-20.iml
drwxr-xr-x  16 darcy  staff      512 Jun  2 22:03 core-java-modules
exitCode:0

在這個示例中，通過使用inheritIO()方法，我們在 IDE 的控制檯中看到了一個簡單命令結果的輸出。

ProcessBuilder 管道操作

從 Java 9 開始，ProcessBuilder 引入了管道概念，可以把一個進程的輸出作爲另一個進程的輸入再次操作。

public static List<Process> startPipeline(List<ProcessBuilder> builders)

使用這個方法我們可以進行如這樣的常見操作：ls -l | wc -l

ls -l | wc -l ：列出文件目錄，然後統計輸出的行數。

下面演示如何使用 startPipeline.

package com.wdbyte.os.process;

import java.io.File;
import java.io.IOException;
import java.lang.ProcessBuilder.Redirect;
import java.nio.file.Files;
import java.util.Arrays;
import java.util.List;

/**
 * Java 9 中新增的管道操作
 * @author https://www.wdbyte.com
 */
public class ProcessBuilderTest8 {
    private static String BASE_DIR = "/Users/darcy/git/JavaNotes/core-java-modules/core-java-os/src/main/java/com/wdbyte/os/process";

    public static void main(String[] args) throws IOException, InterruptedException {
        ProcessBuilder ls = new ProcessBuilder("/bin/bash", "-c", "ls -l");
        ProcessBuilder wc = new ProcessBuilder("wc", "-l");
        // 追加日誌到文件
        File pipeLineLogFile = getFile(BASE_DIR + "/pipe_line_log.txt");
        wc.redirectOutput(Redirect.appendTo(pipeLineLogFile));

        List<Process> processes = ProcessBuilder.startPipeline(Arrays.asList(ls, wc));
        Process process = processes.get(processes.size() - 1);

        System.out.println("pid:" + process.pid());
        System.out.println("exitCode:" + process.waitFor());

        Files.lines(pipeLineLogFile.toPath()).forEach(System.out::println);
    }

    public static File getFile(String filePath) throws IOException {
        File logFile = new File(filePath);
        if (!logFile.exists()) {
            logFile.createNewFile();
        }
        return logFile;
    }
}

這會輸出：

pid:33518
exitCode:0
      21

ProcessBuilder 超時與終止

進程有時不能按照自己想要的情況運行，需要對進程進行管理，常見的操作是超時控制以及進程退出。下面通過一個例子來演示如何操作。

先編譯一個用於測試的 Java 類 ExecDemo.java，此類每隔一秒輸出一個數字，共輸出10個數字，預計需要10s輸出完畢。

下面是代碼部分：

import java.io.IOException;

/**
 * @author https://www.wdbyte.com
 */
public class ExecDemo {

    public static void main(String[] args) throws InterruptedException {
        System.out.println("開始處理數據...");
        for (int i = 0; i < 10; i++) {
            Thread.sleep(1000);
            System.out.println(i);
        }
        System.out.println("數據處理完畢");
    }
}

再編寫一個 ProcessBuilder 來執行 ExceDemo，但是在執行 3 秒後就判斷是否運行完成，如果沒有則殺死進程。

package com.wdbyte.os.process;

import java.io.File;
import java.io.IOException;
import java.util.concurrent.TimeUnit;

/**
 * 運行一個 Java 程序
 * 等待一定時間後檢查狀態，未結束則直接殺死進程。
 *
 * @author https://www.wdbyte.com
 */
public class ProcessBuilderTest9 {
    private static String BASE_DIR = "/Users/darcy/git/JavaNotes/core-java-modules/core-java-os/src/main/java/com/wdbyte/os/process";

    public static void main(String[] args) throws IOException, InterruptedException {
        ProcessBuilder processBuilder = new ProcessBuilder();
        processBuilder.directory(new File(BASE_DIR));
        processBuilder.command("java", "ExecDemo.java");
        // 把子線程 I/O 輸出重定向當前進程
        processBuilder.inheritIO();
        Process process = processBuilder.start();
        // 等待一定時間
        boolean waitFor = process.waitFor(3, TimeUnit.SECONDS);
        System.out.println("waitFor:" + waitFor);
        // 若未退出，殺死子進程
        if (!waitFor) {
            process.destroyForcibly();
            process.waitFor();
            System.out.println("殺死進程:" + process);
        }

    }
}

這會輸出：

開始處理數據...
0
1
waitFor:false
殺死進程:Process[pid=35084, exitValue=137]

在這段代碼中，destroyForcibly() 用於殺死進程，但是殺死進程並不是瞬間完成的，所以接着使用 waitFor() 來等待程序真正被殺死退出。

ProcessBuilder 異步處理

很多情況下，在執行一個命令啓動一個新線程後，我們不想阻塞等待進程的完成，想要異步化，在進程執行完成後進行通知回調。這時可以使用 CompletableFuture 來實現這個功能。

package com.wdbyte.os.process;

import java.io.File;
import java.io.IOException;
import java.util.concurrent.CompletableFuture;

/**
 * @author https://www.wdbyte.com
 */
public class ProcessBuilderTest10 {
    private static String BASE_DIR = "/Users/darcy/git/JavaNotes/core-java-modules/core-java-os/src/main/java/com/wdbyte/os/process";

    public static void main(String[] args) throws InterruptedException {
        ProcessBuilder processBuilder = new ProcessBuilder();
        processBuilder.directory(new File(BASE_DIR));
        processBuilder.command("java", "ExecDemo.java");
        // 把子線程 I/O 輸出重定向當前進程
        processBuilder.inheritIO();

        // 創建 CompletableFuture 對象
        CompletableFuture<Integer> future = CompletableFuture.supplyAsync(() -> {
            try {
                // 命令執行
                Process process = processBuilder.start();
                // 任務超時時間
                process.waitFor();
            } catch (IOException e) {
                throw new RuntimeException(e);
            } catch (InterruptedException e) {
                throw new RuntimeException(e);
            }
            return null;
        });

        // 註冊回調函數，處理異步等待的結果
        future.thenAccept(result -> {
            System.out.println("進程執行結束");
        });
        System.out.println("主進程等待");
        Thread.sleep(20 * 1000);
    }
}

這會輸出：

主進程等待
開始處理數據...
0
1
2
3
4
5
6
7
8
9
數據處理完畢
進程執行結束

ProcessBuilder 總結

在這篇文章中，我們詳細介紹了 ProcessBuilder 的具體用法，並且給出了常用的操作示例。同時也介紹了 Java 9 開始爲 ProcessBuilder 引入的管道操作，最後介紹如何對 Process 進程進行異步處理。

一如既往，文章中代碼存放在 Github.com/niumoo/javaNotes.

本文原發於網站：https://www.wdbyte.com/java/os/processbuilder/
我的公衆號：ProcessBuilder API 使用教程

使用 ProcessBuilder API 優化你的流程

ProcessBuilder 介紹

ProcessBuilder 入門示例

ProcessBuilder 環境變量

ProcessBuilder 工作目錄

ProcessBuilder I/O

輸出到文件

輸出到當前進程

ProcessBuilder 管道操作

ProcessBuilder 超時與終止

ProcessBuilder 異步處理

ProcessBuilder 總結

Java 斷言 Assert 使用教程與最佳實踐

把 Maven 提交到項目？Maven Wrapper的使用與好處

一掃即入，如何通過微信公衆號掃碼登錄網站？

GitHub WebHook 使用教程

Jpackage-製作無需預裝Java環境的Jar可執行程序

https://yachay.unat.edu.pe/blog/index.php?comment_area=format_blog&comment_component=blog&comment_co

linux以太網驅動總結