Java 的 Process API 為開發(fā)者提供了執(zhí)行操作系統(tǒng)命令的強(qiáng)大功能,但是某些 API 方法可能讓你有些疑惑,沒關(guān)系,這篇文章將詳細(xì)介紹如何使用 ProcessBuilder API 來方便的操作系統(tǒng)命令。
ProcessBuilder 入門示例我們通過演示如何調(diào)用 java -version
命令輸出 JDK 版本號(hào),來演示 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 版本號(hào) * @author https://www.wdbyte.com */public class ProcessBuilderTest1 { public static void main(String[] args) throws IOException, InterruptedException { // 構(gòu)建執(zhí)行命令 ProcessBuilder processBuilder = new ProcessBuilder("java","-version"); // 重定向 ERROR 流(有些 JDK 版本 Java 命令通過 ERROR 流輸出) processBuilder.redirectErrorStream(true); // 運(yùn)行命令 java -version Process process = processBuilder.start(); // 獲取PID,這是一個(gè) Java 9 方法 long pid = process.pid(); // 一次性獲取運(yùn)行結(jié)果 String result = IOUtils.toString(process.getInputStream()); // 等到運(yùn)行結(jié)束 int exitCode = process.waitFor(); System.out.println("pid:" + pid); System.out.println("result:" + result); System.out.println("exitCode:" + exitCode); }}
在這段代碼中,首先使用 ProcessBuilder 對(duì)象包裝了要執(zhí)行的命令 java -version
,緊接著重定向 了要執(zhí)行的進(jìn)程的 ERROR 輸出流(有些 JDK 版本 Java 命令通過 ERROR 流輸出)。最后通過 start
方法執(zhí)行命令,得到一個(gè)用于進(jìn)程管理的 Process
對(duì)象,可以獲取其 pid
和輸出結(jié)果。
【資料圖】
注意
IOUtils.toString(process.getInputStream());
這里使用了 commons-io 中的工具類把 InputStream 轉(zhuǎn)為字符串。
commons-io
Maven 依賴:
commons-io commons-io 2.12.0
運(yùn)行得到輸出:
pid:80885result: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 環(huán)境變量在下面這個(gè)示例中,演示如何獲取當(dāng)前環(huán)境變量,以及如何修改環(huán)境變量并傳入子進(jìn)程中。
輸出當(dāng)前環(huán)境變量。
ProcessBuilder processBuilder = new ProcessBuilder();Map environment = processBuilder.environment();environment.forEach((k, v) -> System.out.println(k + ":" + v));processBuilder.environment().put("my_website","www.wdbyte.com");
這會(huì)打印出當(dāng)前所有環(huán)境變量。
JAVA_HOME:/Library/Java/JavaVirtualMachines/jdk1.8.0_151.jdk/Contents/HomeCOMMAND_MODE:unix2003JAVA_MAIN_CLASS_81717:com.wdbyte.os.process.ProcessBuilderTest2LOGNAME:darcy.....
添加一個(gè)環(huán)境變量。
processBuilder.environment().put("my_website","www.wdbyte.com");
打印出剛才添加的環(huán)境變量。
// 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);
這會(huì)輸出:
pid:81719result:www.wdbyte.comexitCode:0
ProcessBuilder 工作目錄使用 directory
方法可以修改子進(jìn)程默認(rèn)的工作目錄,下面的示例中修改進(jìn)程工作目錄為 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:82456result:/Users/darcy/git/JavaNotes/core-java-modules/core-java-os/src/main/java/com/wdbyte/os/processexitCode:0
ProcessBuilder I/O在上面的示例中,都是把運(yùn)行的新進(jìn)程的輸出通過 getInputStream
的方式讀取到當(dāng)前進(jìn)程,然后輸出,這種方式很不方便。日志輸出常見的方式是輸出到指定日志文件,ProcessBuilder
對(duì)此也有很好的支持。
使用 redirectOutput
可以指定日志輸出的文件,這個(gè)方法會(huì)自動(dòng)創(chuàng)建日志文件。下面的例子在指定目錄下執(zhí)行 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:30609exitCode:0total 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
如果想要追加日志到指定文件,應(yīng)該使用:
processBuilder.redirectOutput(ProcessBuilder.Redirect.appendTo(logFile));
使用 processBuilder
也可以指定 INFO
和 ERROR
日志到不同的文件。
ProcessBuilder processBuilder = new ProcessBuilder();processBuilder.directory(new File(BASE_DIR));// 執(zhí)行命令 xxx,命令不存在,會(huì)報(bào) 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);
運(yùn)行輸出:
/bin/bash: xxx: command not found
輸出到當(dāng)前進(jìn)程在這個(gè)示例中,將看到 inheritIO()
方法的作用。當(dāng)我們想將子進(jìn)程的 I/O 重定向到當(dāng)前進(jìn)程的標(biāo)準(zhǔn) I/O 時(shí),可以使用這個(gè)方法:
package com.wdbyte.os.process;import java.io.File;import java.io.IOException;/** * 子線程 I/O 重定向到當(dāng)前線程 * @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 輸出重定向當(dāng)前進(jìn)程 processBuilder.inheritIO(); Process process = processBuilder.start(); int exitCode = process.waitFor(); System.out.println("exitCode:" + exitCode); }}
這會(huì)輸出:
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.imldrwxr-xr-x 16 darcy staff 512 Jun 2 22:03 core-java-modulesexitCode:0
在這個(gè)示例中,通過使用inheritIO()方法,我們?cè)?IDE 的控制臺(tái)中看到了一個(gè)簡(jiǎn)單命令結(jié)果的輸出。
ProcessBuilder 管道操作從 Java 9 開始,ProcessBuilder 引入了管道概念,可以把一個(gè)進(jìn)程的輸出作為另一個(gè)進(jìn)程的輸入再次操作。
public static List startPipeline(List builders)
使用這個(gè)方法我們可以進(jìn)行如這樣的常見操作:ls -l | wc -l
ls -l | wc -l
:列出文件目錄,然后統(tǒng)計(jì)輸出的行數(shù)。
下面演示如何使用 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 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; }}
這會(huì)輸出:
pid:33518exitCode:0 21
ProcessBuilder 超時(shí)與終止進(jìn)程有時(shí)不能按照自己想要的情況運(yùn)行,需要對(duì)進(jìn)程進(jìn)行管理,常見的操作是超時(shí)控制以及進(jìn)程退出。下面通過一個(gè)例子來演示如何操作。
先編譯一個(gè)用于測(cè)試的 Java 類 ExecDemo.java
,此類每隔一秒輸出一個(gè)數(shù)字,共輸出10個(gè)數(shù)字,預(yù)計(jì)需要10s輸出完畢。
下面是代碼部分:
import java.io.IOException;/** * @author https://www.wdbyte.com */public class ExecDemo { public static void main(String[] args) throws InterruptedException { System.out.println("開始處理數(shù)據(jù)..."); for (int i = 0; i < 10; i++) { Thread.sleep(1000); System.out.println(i); } System.out.println("數(shù)據(jù)處理完畢"); }}
再編寫一個(gè) ProcessBuilder
來執(zhí)行 ExceDemo
,但是在執(zhí)行 3 秒后就判斷是否運(yùn)行完成,如果沒有則殺死進(jìn)程。
package com.wdbyte.os.process;import java.io.File;import java.io.IOException;import java.util.concurrent.TimeUnit;/** * 運(yùn)行一個(gè) Java 程序 * 等待一定時(shí)間后檢查狀態(tài),未結(jié)束則直接殺死進(jìn)程。 * * @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 輸出重定向當(dāng)前進(jìn)程 processBuilder.inheritIO(); Process process = processBuilder.start(); // 等待一定時(shí)間 boolean waitFor = process.waitFor(3, TimeUnit.SECONDS); System.out.println("waitFor:" + waitFor); // 若未退出,殺死子進(jìn)程 if (!waitFor) { process.destroyForcibly(); process.waitFor(); System.out.println("殺死進(jìn)程:" + process); } }}
這會(huì)輸出:
開始處理數(shù)據(jù)...01waitFor:false殺死進(jìn)程:Process[pid=35084, exitValue=137]
在這段代碼中,destroyForcibly()
用于殺死進(jìn)程,但是殺死進(jìn)程并不是瞬間完成的,所以接著使用 waitFor()
來等待程序真正被殺死退出。
很多情況下,在執(zhí)行一個(gè)命令啟動(dòng)一個(gè)新線程后,我們不想阻塞等待進(jìn)程的完成,想要異步化,在進(jìn)程執(zhí)行完成后進(jìn)行通知回調(diào)。這時(shí)可以使用 CompletableFuture
來實(shí)現(xiàn)這個(gè)功能。
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 輸出重定向當(dāng)前進(jìn)程 processBuilder.inheritIO(); // 創(chuàng)建 CompletableFuture 對(duì)象 CompletableFuture future = CompletableFuture.supplyAsync(() -> { try { // 命令執(zhí)行 Process process = processBuilder.start(); // 任務(wù)超時(shí)時(shí)間 process.waitFor(); } catch (IOException e) { throw new RuntimeException(e); } catch (InterruptedException e) { throw new RuntimeException(e); } return null; }); // 注冊(cè)回調(diào)函數(shù),處理異步等待的結(jié)果 future.thenAccept(result -> { System.out.println("進(jìn)程執(zhí)行結(jié)束"); }); System.out.println("主進(jìn)程等待"); Thread.sleep(20 * 1000); }}
這會(huì)輸出:
主進(jìn)程等待開始處理數(shù)據(jù)...0123456789數(shù)據(jù)處理完畢進(jìn)程執(zhí)行結(jié)束
ProcessBuilder 總結(jié)在這篇文章中,我們?cè)敿?xì)介紹了 ProcessBuilder 的具體用法,并且給出了常用的操作示例。同時(shí)也介紹了 Java 9 開始為 ProcessBuilder 引入的管道操作,最后介紹如何對(duì) Process 進(jìn)程進(jìn)行異步處理。
一如既往,文章中代碼存放在 Github.com/niumoo/javaNotes.
本文原發(fā)于網(wǎng)站:https://www.wdbyte.com/java/os/processbuilder/我的公眾號(hào):ProcessBuilder API 使用教程
責(zé)任編輯: