使用 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);
        }
    }
}

这会输出：

开端处理数据...
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);
    }
}

这会输出：

主进程等候
开端处理数据...
1
2
3
4
5
6
7
8
9
数据处理完毕
进程履行完毕

ProcessBuilder 总结

在这篇文章中，咱们具体介绍了 ProcessBuilder 的具体用法，而且给出了常用的操作示例。同时也介绍了 Java 9 开端为 ProcessBuilder 引进的管道操作，最终介绍怎么对 Process 进程进行异步处理。

一如既往，文章中代码存放在 Github.com/niumoo/java….

本文原发于网站：www.wdbyte.com/java/os/pro…
我的公众号：ProcessBuilder API 运用教程

声明：本站所有文章，如无特殊说明或标注，均为本站原创发布。任何个人或组织，在未征得本站同意时，禁止复制、盗用、采集、发布本站内容到任何网站、书籍等各类媒体平台。如若本站内容侵犯了原著者的合法权益，可联系我们进行处理。

使用 ProcessBuilder API 优化你的流程

ProcessBuilder 介绍

ProcessBuilder 入门示例

ProcessBuilder 环境变量

ProcessBuilder 工作目录

ProcessBuilder I/O

输出到文件

输出到当时进程

ProcessBuilder 管道操作

ProcessBuilder 超时与停止

ProcessBuilder 异步处理

ProcessBuilder 总结

近期文章

近期评论