ProcessBuilder 介紹

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

ProcessBuilder 入門示例

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

java複制代碼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 依賴：

xml複制代碼<dependency>
    <groupId>commons-io</groupId>
    <artifactId>commons-io</artifactId>
    <version>2.12.0</version>
</dependency>

運作得到輸出：

java複制代碼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 環境變量

在下面這個示例中，示範如何擷取目前環境變量，以及如何修改環境變量并傳入子程序中。

輸出目前環境變量。

java複制代碼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複制代碼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
.....

添加一個環境變量。

java複制代碼processBuilder.environment().put("my_website","www.wdbyte.com");

列印出剛才添加的環境變量。

java複制代碼// 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);

這會輸出：

java複制代碼pid:81719
result:www.wdbyte.com
exitCode:0

ProcessBuilder 工作目錄

使用 directory 方法可以修改子程序預設的工作目錄，下面的示例中修改程序工作目錄為 process 檔案夾。

java複制代碼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);
    }
}

輸出：

java複制代碼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 指令列出目錄下的所有檔案。

java複制代碼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);
    }
}

輸出日志：

shell複制代碼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

如果想要追加日志到指定檔案，應該使用：

java複制代碼processBuilder.redirectOutput(ProcessBuilder.Redirect.appendTo(logFile));

使用 processBuilder 也可以指定 INFO 和 ERROR 日志到不同的檔案。

java複制代碼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);

運作輸出：

java複制代碼/bin/bash: xxx: command not found

輸出到目前程序

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

java複制代碼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);
    }
}

這會輸出：

shell複制代碼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 引入了管道概念，可以把一個程序的輸出作為另一個程序的輸入再次操作。

java複制代碼public static List<Process> startPipeline(List<ProcessBuilder> builders)

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

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

下面示範如何使用 startPipeline.

java複制代碼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;
    }
}

這會輸出：

java複制代碼pid:33518
exitCode:0
      21

ProcessBuilder 逾時與終止

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

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

下面是代碼部分：

java複制代碼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 秒後就判斷是否運作完成，如果沒有則殺死程序。

java複制代碼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);
        }

    }
}

這會輸出：

shell複制代碼開始處理資料...
0
1
waitFor:false
殺死程序:Process[pid=35084, exitValue=137]

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

ProcessBuilder 異步處理

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

java複制代碼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);
    }
}

這會輸出：

shell複制代碼主程序等待
開始處理資料...
0
1
2
3
4
5
6
7
8
9
資料處理完畢
程序執行結束

ProcessBuilder 總結

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

作者：程式猿阿朗

原文連結：https://juejin.cn/post/7244192848064299069

使用 ProcessBuilder API 優化你的流程

ProcessBuilder 介紹

ProcessBuilder 入門示例

ProcessBuilder 環境變量

ProcessBuilder 工作目錄

ProcessBuilder I/O

輸出到檔案

輸出到目前程序

ProcessBuilder 管道操作

ProcessBuilder 逾時與終止

ProcessBuilder 異步處理

ProcessBuilder 總結

繼續閱讀

2022.5.1往年今日。回來了，我就叫豬豬豬豬。人到七八十住斜闆别墅把冷速好事，一Changes賭一賭賭一籃子，主管工

【晶片封裝】晶片封裝流程（IC Assembly Process Flow）

Java編譯器注解處理器AbstractProcessor

Spring源碼之BeanFactoryPostProcessor的執行順序

QT如何利用QProcess擷取計算機硬體資訊

李伯曼鋼琴作品《奇異石雕》音樂修辭分析與演奏探究首先，從樂曲的整體結構來看，第一首樂曲采用了6/8拍的三部曲式ABA，這

防lombok實作一個Getter注解，AbstractProcessor執行個體

國外常見RPA(Robotic Process Automation)一覽

一個強大的工具，解決絕大部分系統問題：Process Explorer

目前有多少種3D列印技術？工作原理分别是什麼？目前3D列印技術的種類已經非常豐富，以下是常見的幾種3D列印技術及其工作原

Bean生命周期的擴充點：BeanPostProcessor

深入探究Bean生命周期的擴充點：Bean Post Processor

java調用Windows指令行

Java中ProcessBuilder使用

如何使用ProcessBuilder執行外部指令行執行普通指令執行有輸出内容的指令

Java實作第三方程式調用Java中提供Runtime類和Process Builder類兩種方式來執行外部程式