浅析ProcessBuilder

浅析ProcessBuilder

概述

ProcessBuilder类是J2SE 1.5在java.lang中新添加的一个新类,此类用于创建操作系统进程,它提供一种启动和管理进程(也就是应用程序)的方法。在J2SE 1.5之前,都是由Process类处理实现进程的控制管理。每个 ProcessBuilder 实例管理一个进程属性集。它的start() 方法利用这些属性创建一个新的 Process 实例。start() 方法可以从同一实例重复调用,以利用相同的或相关的属性创建新的子进程。

每个进程生成器(即ProcessBuilder对象)管理这些进程属性:

命令 command

是一个字符串列表,它表示要调用的外部程序文件及其参数(如果有)。在此,表示有效的操作系统命令的字符串列表是依赖于系统的。例如,每一个总体变量,通常都要成为此列表中的元素,但有一些操作系统,希望程序能自己标记命令行字符串——在这种系统中,Java 实现可能需要命令确切地包含这两个元素。

环境 environment

是从变量 到值 的依赖于系统的映射。初始值是当前进程环境的一个副本(请参阅 System.getenv())。

工作目录 working directory

默认值是当前进程的当前工作目录,通常根据系统属性 user.dir 来命名。

redirectErrorStream属性

最初,此属性为 false,意思是子进程的标准输出和错误输出被发送给两个独立的流,这些流可以通过 Process.getInputStream() 和 Process.getErrorStream() 方法来访问。如果将值设置为 true,标准错误将与标准输出合并。这使得关联错误消息和相应的输出变得更容易。在此情况下,合并的数据可从 Process.getInputStream() 返回的流读取,而从 Process.getErrorStream() 返回的流读取将直接到达文件尾。

既然有Process类,那为什么还要发明个ProcessBuilder类呢?ProcessBuilder和Process两个类有什么区别呢?

原来,ProcessBuilder为进程提供了更多的控制,例如,可以设置当前工作目录,还可以改变环境参数。而Process的功能相对来说简单的多。

ProcessBuilder是一个final类,有两个带参数的构造方法,你可以通过构造方法来直接创建ProcessBuilder的对象。而Process是一个抽象类,一般都通过Runtime.exec()和ProcessBuilder.start()来间接创建其实例。(有关Process类的详细介绍可以看下一节。)

修改进程构造器的属性将影响后续由该对象的 start() 方法启动的进程,但从不会影响以前启动的进程或 Java 自身的进程。
ProcessBuilder类不是同步的。如果多个线程同时访问一个 ProcessBuilder,而其中至少一个线程从结构上修改了其中一个属性,它必须 保持外部同步。

很容易启动一个使用默认工作目录和环境的新进程:(沿用JDK7中的例子)

Process p = new ProcessBuilder("myCommand", "myArg").start();

下面是一个利用修改过的工作目录和环境启动进程的例子:

ProcessBuilder pb = new ProcessBuilder("myCommand", "myArg1", "myArg2");
Map<String, String> env = pb.environment();
env.put("VAR1", "myValue");
env.remove("OTHERVAR");
env.put("VAR2", env.get("VAR1") + "suffix");
pb.directory("myDir");
Process p = pb.start();

要利用一组明确的环境变量启动进程,在添加环境变量之前,首先调用 Map.clear()。

Process类

Process类是一个抽象类(所有的方法均是抽象的),封装了一个进程(即一个执行程序)。

Process 类提供了执行从进程输入、执行输出到进程、等待进程完成、检查进程的退出状态以及销毁(杀掉)进程的方法。创建进程的方法可能无法针对某些本机平台上的特定进程很好地工作,比如,本机窗口进程,守护进程,Microsoft Windows 上的 Win16/DOS 进程,或者 shell 脚本。创建的子进程没有自己的终端或控制台。它的所有标准 io(即 stdin、stdout 和 stderr)操作都将通过三个流 (getOutputStream()、getInputStream() 和 getErrorStream()) 重定向到父进程。父进程使用这些流来提供到子进程的输入和获得从子进程的输出。因为有些本机平台仅针对标准输入和输出流提供有限的缓冲区大小,如果读写子 进程的输出流或输入流迅速出现失败,则可能导致子进程阻塞,甚至产生死锁。 当没有 Process 对象的更多引用时,不是删掉子进程,而是继续异步执行子进程。 对于带有 Process 对象的 Java 进程,没有必要异步或并发执行由 Process 对象表示的进程。

Process抽象类有以下6个抽象方法:

destroy()

杀掉子进程。

exitValue()

返回子进程的出口值。

InputStream getErrorStream()

获得子进程的错误流。

InputStream getInputStream()

获得子进程的输入流。

OutputStream getOutputStream()

获得子进程的输出流。

waitFor()

导致当前线程等待,如果必要,一直要等到由该 Process 对象表示的进程已经终止。

如何创建Process对象?

一般有两种方法:

  • 使用命令名和命令的参数选项构造ProcessBuilder对象,它的start方法执行命令,启动一个进程,返回一个Process对象。
  • Runtime.exec() 方法创建一个本机进程,并返回 Process 子类的一个实例。

Runtime.exec()

ProcessBuilder与Runtime.exec()的区别?

ProcessBuilder.start() 和 Runtime.exec() 方法都被用来创建一个操作系统进程(执行命令行操作),并返回 Process 子类的一个实例,该实例可用来控制进程状态并获得相关信息。

ProcessBuilder.start() 和 Runtime.exec()传递的参数有所不同,Runtime.exec()可接受一个单独的字符串,这个字符串是通过空格来分隔可执行命令程序和参数的;也可以接受字符串数组参数。而ProcessBuilder的构造函数是一个字符串列表或者数组。列表中第一个参数是可执行命令程序,其他的是命令行执行是需要的参数。

通过查看JDK源码可知,Runtime.exec最终是通过调用ProcessBuilder来真正执行操作的。

为了能够详细的说明ProcessBuilder和Runtime.exec的“功效”,下面先做一个测试jar包(ProcessJar.jar),这个jar包里就一个类,如下:

public class PrintArgs {
public static void main(String args[]){
System.out.println("This is a program test about Process, ProcessBuilder, Runtime.exec etc.");
System.out.println("Now Print the args:");
for(int i=0;i<args.length;i++){
System.out.println(" [args-"+i+"]:"+args[i]);
}
}
}

然后放在classpath下。之后可以调用命令行:java -jar ProcessJar.jar [args1….n]

Runtime.getRuntime.exec的使用Demo:

package com.java;

import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;

/**
* Created by hidden on 2017/1/17.
*/
public class RuntimeTest {
public static void main(String[] args) {
try {
Process process = Runtime.getRuntime().exec("java -jar ProcessJar.jar args1 agrs2 args3");
InputStream is = process.getInputStream();
BufferedReader br = new BufferedReader(new InputStreamReader(is));

String line;
while ((line = br.readLine()) != null) {
System.out.println(line);
}

int exitCode = process.waitFor();
System.out.println(exitCode);
} catch (IOException e) {
e.printStackTrace();
}
}
}

输出结果:

This is a program test about Process, ProcessBuilder, Runtime.exec etc.
Now Print the args:
[args-0]:args1
[args-1]:agrs2
[args-2]:args3
0

由于调用Runtime.exec方法所创建的子进程没有自己的终端或控制台,因此该子进程的标准IO(如stdin,stdou,stderr)都通过Process.getOutputStream(),Process.getInputStream(),Process.getErrorStream()方法重定向给它的父进程了。用户需要用这些stream来向子进程输入数据或获取子进程的输出。

ProcessBuilder API

构造方法摘要

ProcessBuilder(List<String> command)

利用指定的操作系统程序和参数构造一个进程生成器。

ProcessBuilder(String… command)

利用指定的操作系统程序和参数构造一个进程生成器。

方法摘要

command()

返回此进程生成器的操作系统程序和参数。

command(List<String> command)

设置此进程生成器的操作系统程序和参数。

command(String… command)

设置此进程生成器的操作系统程序和参数。

directory()

返回此进程生成器的工作目录。

directory(File directory)

设置此进程生成器的工作目录。

environment()

返回此进程生成器环境的字符串映射视图。 environment方法获得运行进程的环境变量,得到一个Map,可以修改环境变量

redirectErrorStream()

通知进程生成器是否合并标准错误和标准输出。

redirectErrorStream(boolean redirectErrorStream)

设置此进程生成器的 redirectErrorStream 属性。

start()

使用此进程生成器的属性启动一个新进程。

ProcessBuilder Demo

这里演示一个ProcessBuilder的demo,和Runtime.exec()方法差不多,同样是采用ProcessJar.jar进行测试。

public class ProcessBuilderTest {
public static void main(String[] args) {
List<String> params = new ArrayList<String>();
params.add("java");
params.add("-jar");
params.add("ProcessJar.jar");
params.add("args1");
params.add("args2");
params.add("args3");

ProcessBuilder processBuilder = new ProcessBuilder(params);
// System.out.println(processBuilder.directory());
// System.out.println(processBuilder.environment());
processBuilder.redirectErrorStream(true);
try {
Process process = processBuilder.start();
BufferedReader br = new BufferedReader(new InputStreamReader(process.getInputStream()));
String line;
while ((line = br.readLine()) != null) {
System.out.println(line);
}
int exitCode = process.waitFor();
System.out.println("exitCode = "+exitCode);
} catch (IOException e) {
e.printStackTrace();
} catch (InterruptedException e) {
e.printStackTrace();
}
}
}

输出结果:

This is a program test about Process, ProcessBuilder, Runtime.exec etc.
Now Print the args:
[args-0]:args1
[args-1]:args2
[args-2]:args3
exitCode = 0

为了更形象的说明ProcessBuilder的用法,下面再举几个例子:

/**
* 查看"D:\"目录, Windows系统下查看目录的命令是dir
*/
public static void checkDirectory() throws IOException {
ProcessBuilder processBuilder = new ProcessBuilder("cmd","/c","dir");
processBuilder.directory(new File("D:/"));
Process process = processBuilder.start();
BufferedReader br = new BufferedReader(new InputStreamReader(process.getInputStream(), "GBK"));
String line;
while ((line = br.readLine()) != null) {
System.out.println(line);
}
}

/**
* 查看ip地址【Windows系统下】
*/
public static void checkPhysicAddress() {
ProcessBuilder processBuilder = new ProcessBuilder("ipconfig", "/all");
try {
Process process = processBuilder.start();
BufferedReader br = new BufferedReader(new InputStreamReader(process.getInputStream(), "GBK"));
String line;
while ((line = br.readLine()) != null) {
if (line.indexOf("IPv4") != -1) {
System.out.println(line);
}
}
} catch (IOException e) {
e.printStackTrace();
}
}

欢迎支持笔者的作品《深入理解Kafka: 核心设计与实践原理》和《RabbitMQ实战指南》,同时欢迎关注笔者的微信公众号:朱小厮的博客(ID: hiddenkafka)。
本文作者: 朱小厮

评论

Your browser is out-of-date!

Update your browser to view this website correctly. Update my browser now

×