Java 的 Process API 為開發者提供了執行作業系統命令的強大功能，但是某些 API 方法可能讓你有些疑惑，沒關係，這篇文章將詳細介紹如何使用 ProcessBuilder API 來方便的作業系統命令。
我們通過演示如何呼叫 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 = 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
使用 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
在上面的範例中，都是把執行的新程序的輸出通過 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 的控制檯中看到了一個簡單命令結果的輸出。
從 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
程序有時不能按照自己想要的情況執行，需要對程序進行管理，常見的操作是超時控制以及程序退出。下面通過一個例子來演示如何操作。
先編譯一個用於測試的 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() 來等待程式真正被殺死退出。
很多情況下，在執行一個命令啟動一個新執行緒後，我們不想阻塞等待程序的完成，想要非同步化，在程序執行完成後進行通知回撥。這時可以使用 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 的具體用法，並且給出了常用的操作範例。同時也介紹了 Java 9 開始為 ProcessBuilder 引入的管道操作，最後介紹如何對 Process 程序進行非同步處理。
一如既往，文章中程式碼存放在 Github.com/niumoo/javaNotes.
本文原發於網站：https://www.wdbyte.com/java/os/processbuilder/
我的公眾號：ProcessBuilder API 使用教學