使用 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 优化你的流程的更多相关文章
- 【百度地图API】今日小年大进步，齐头共进贺佳节——API优化升级上线，不再增加内存消耗
原文:[百度地图API]今日小年大进步,齐头共进贺佳节--API优化升级上线,不再增加内存消耗 任务描述: 今天是2011年01月26日,小年夜.百度地图API在小年夜献给广大API爱好者一份给力的礼 ...
- 工作流JBPM_day01：3-使用JBPM的API添加与执行流程
工作流JBPM_day01:3-使用JBPM的API添加与执行流程 流程定义画完得到压缩文件--->部署流程定义-->启动流程实例-->查询我的个人任务列表-->办理任务--& ...
- 第六节：框架搭建之EF的Fluent Api模式的使用流程
一. 前言 沉寂了约一个月的时间,今天用一篇简单的文章重新回归博客,主要来探讨一下Fluent Api模式在实际项目中的使用流程. 1. Fluent API属于EF CodeFirst模式的一种,E ...
- 数据筛选和API优化
筛选数据 需求:如果数据库中存在OrderNum相同,且IsDefault不同的记录,那么IsDefault值为0的记录将替换值为1的记录(IsDefault值为1的记录不展示). 由于查出来的数据不 ...
- 使用flowable 6.1.2 REST API 运行请假审批流程
一.下载 flowable rest war 包 http://download.csdn.net/detail/teamlet/9913312 二.部署 复制flowable REST.war到To ...
- AS3 巧用事件api简化鼠标拖动流程
拖动,按照一般人的定义,拖动就是鼠标按下的时候移动鼠标,这里面有三个过程,分别是按下.移动鼠标和弹起.以stage为例,大家的实现步骤通常如下:(PS:此处不讨论startDrag和stopDrag ...
- CMDB学习之六 --客户端请求测试,服务端api优化
客户端使用agent 请求测试,agent使用的POST 请求,使用requests模块 本地采集,汇报服务端 #!/usr/bin/env python # -*- coding:utf-8 -*- ...
- 项目API接口鉴权流程总结
权益需求对接中,公司跟第三方公司合作,有时我们可能作为甲方,提供接口给对方,有时我们也作为乙方,调对方接口,这就需要API使用签名方法(Sign)对接口进行鉴权.每一次请求都需要在请求中包含签名信息, ...
- HTML5的classList API优化对样式名className的操作
//添加一个class elem.classList.add(classname); //删除一个class elem.classList.remove(classname); //判断一个class ...
- Mali GPU OpenGL ES 应用性能优化--測试+定位+优化流程
1. 使用DS-5 Streamline定位瓶颈 DS-5 Streamline要求GPU驱动启用性能測试,在Mali GPU驱动中激活性能測试对性能影响微不足道. 1.1 DS-5 Streamli ...
随机推荐
- Redis - 对象结构
简介 Redis 使用对象存储数据库中的键和值,每当在 Redis 中创建一个新的键值对时,都会创建两个对象:一个是键对象,另一个是值对象. 其中,Redis 的每种对象都由对象结构和对应编码的数据结 ...
- uniapp安卓离线打包权限问题
安卓离线打包需要在androidManifest.xml配置 在 manifest 节点下面加上权限(对应uniapp当中manifest.json当中安卓的权限配置),例如: <manifes ...
- ICMP隐蔽隧道攻击分析与检测（四）
• ICMP隧道攻击通讯特征和特征提取 一.ICMP Ping正常通讯特征总结 一个正常的 ping 每秒最多只会发送两个数据包,而使用 ICMP隧道的服务器在同一时间会产生大量 ICMP 数据包 正 ...
- [Java]排序算法>插入排序>【折半插入排序】(O(N*N)/稳定/N较大/无序/顺序存储)
1 折半插入排序 1.1 算法思想 相比于[直接插入排序]:采用"顺序查找法"查找当前记录在已排好序的序列中的插入位置, 折半插入排序利用"折半查找法"快速查出 ...
- idea快捷键--增强for循环
增强for循环,用于遍历:数组或单列集合 快捷键: 数组.for
- java中的装箱 拆箱 以及 字符串与基本数据类型的转化
java中的装箱 拆箱 装箱就是 自动将基本数据类型转换为包装器类型:拆箱就是 自动将包装器类型转换为基本数据类型 ; Integer i =5;//装箱 int j=i;//拆箱 在装箱的时候自动调 ...
- 前端获取不到环境变量NODE_ENV
有时候我们期望通过执行不同的 npm script 来区分诸如 dev.prod.uat.sit等多环境下使用的不同变量 今天我也在整环境变量,碰到一个小小的bug.装了 cross-env 但还是没 ...
- 【原型设计模式详解】C/Java/JS/Go/Python/TS不同语言实现
简介 原型模式(Prototype Pattern)是一种创建型设计模式,使你能够复制已有对象,而无需使代码依赖它们所属的类,同时又能保证性能. 这种模式是实现了一个原型接口,该接口用于创建当前对象的 ...
- C# 闭包类对弱引用的坑
闭包.弱引用的简单概念,大佬们描述的很多,有不了解的可以看看: 理解C#中的闭包 - 黑洞视界 - 博客园 (cnblogs.com) C#弱引用(WeakReference) - 简书 (jians ...
- Nuget 多项目复合打包
问题描述 我这里有个进程间通信组件,用于提供多应用间通信的解决方案. 进程间通信,分为客户端和服务端,俩端肯定会有些共性代码,所以加了个H3C.Channel.Core项目 因为之前还不太了解nuge ...