Apache commons-exec的使用
郑西岭
前言
在调用SHELL命令或DOS命令时，使用Runtime.getRuntime().exec(command);这个方法。但是执行某些命令时，程序可能就卡在那了，需要在执行的过程中新开启几个线程来不断地读取标准输出，以及错误输出，这样很不方便，好在commons-exec提供了更加友好的使用方式。
一、同步调用
commons-exec的command不需要考虑执行环境，比如windows下不需要添加"cmd /c "的前缀。
可以使用自定义的流来接受结果，比如使用文件流将结果保存到文件，使用网络流保存到远程服务器上等。
下面的例子模仿一个命令调用，这里只是一个ping localhost操作，这里为了方便，结果写在了内存中。
@Test
public void testCommonExec() throws IOException {
String command = "ping localhost";
//接收正常结果流
ByteArrayOutputStream susStream = new ByteArrayOutputStream();
//接收异常结果流
ByteArrayOutputStream errStream = new ByteArrayOutputStream();
CommandLine commandLine = CommandLine.parse(command);
DefaultExecutor exec = new DefaultExecutor();
PumpStreamHandler streamHandler = new PumpStreamHandler(susStream, errStream);
exec.setStreamHandler(streamHandler);
int code = exec.execute(commandLine);
System.out.println("退出代码: " + code);
System.out.println(susStream.toString("GBK"));
System.out.println(errStream.toString("GBK"));
}
如果使用JDK中的Runtime操作就复杂了：
@Test
public void testJdk() throws InterruptedException, IOException {
final Process process = Runtime.getRuntime().exec("cmd /c ping localhost");
new Thread(() -> {
try (BufferedReader br = new BufferedReader(new InputStreamReader(process.getInputStream(), "gbk"))) {
String line;
while ((line = br.readLine()) != null) {
try {
process.exitValue();
break; // exitValue没有异常表示进程执行完成，退出循环
} catch (IllegalThreadStateException e) {
// 异常代表进程没有执行完
}
//
System.out.println(line);
}
} catch (IOException e) {
throw new RuntimeException(e);
}
}).start();
process.waitFor();
}
二、异步调用
commons-exec支持异步调用
@Test
public void testCommonExec() throws InterruptedException, IOException {
String command = "ping localhost";
//接收正常结果流
ByteArrayOutputStream susStream = new ByteArrayOutputStream();
//接收异常结果流
ByteArrayOutputStream errStream = new ByteArrayOutputStream();
CommandLine commandLine = CommandLine.parse(command);
DefaultExecutor exec = new DefaultExecutor();
PumpStreamHandler streamHandler = new PumpStreamHandler(susStream, errStream);
exec.setStreamHandler(streamHandler);
ExecuteResultHandler erh = new ExecuteResultHandler() {
@Override
public void onProcessComplete(int exitValue) {
try {
String suc = susStream.toString("GBK");
System.out.println(suc);
System.out.println("3. 异步执行完成");
} catch (UnsupportedEncodingException uee) {
uee.printStackTrace();
}
}
@Override
public void onProcessFailed(ExecuteException e) {
try {
String err = errStream.toString("GBK");
System.out.println(err);
System.out.println("3. 异步执行出错");
} catch (UnsupportedEncodingException uee) {
uee.printStackTrace();
}
}
};
System.out.println("1. 开始执行");
exec.execute(commandLine, erh);
System.out.println("2. 做其他操作");
// 避免主线程退出导致程序退出
Thread.currentThread().join();
}
如果使用JDK中的Runtime就复杂了：
@Test
public void testJdk() throws IOException, InterruptedException {
System.out.println("1. 开始执行");
String cmd = "cmd /c ping localhost"; // 假设是一个耗时的操作
execAsync(cmd, processResult -> {
System.out.println("3. 异步执行完成，success=" + processResult.success + "; msg=" + processResult.result);
System.exit(0);
});
// 做其他操作 ... ...
System.out.println("2. 做其他操作");
// 避免主线程退出导致程序退出
Thread.currentThread().join();
}
private void execAsync(String command, Consumer<ProcessResult> callback) throws IOException {
final Process process = Runtime.getRuntime().exec(command);
new Thread(() -> {
StringBuilder successMsg = new StringBuilder();
try (BufferedReader br = new BufferedReader(new InputStreamReader(process.getInputStream(), "GBK"))) {
// 存放临时结果
String line;
while ((line = br.readLine()) != null) {
try {
successMsg.append(line).append("\r\n");
int exitCode = process.exitValue();
ProcessResult pr = new ProcessResult();
if (exitCode == 0) {
pr.success = true;
pr.result = successMsg.toString();
} else {
pr.success = false;
pr.result = IOUtils.toString(process.getErrorStream(), "utf-8");
}
callback.accept(pr); // 回调主线程注册的函数
break; // exitValue没有异常表示进程执行完成，退出循环
} catch (IllegalThreadStateException e) {
// 异常代表进程没有执行完
}
try {
// 等待100毫秒在检查是否完成
Thread.sleep(100);
} catch (InterruptedException e) {
e.printStackTrace();
}
}
} catch (IOException e) {
throw new RuntimeException(e);
}
}).start();
}
private static class ProcessResult {
boolean success;
String result;
}
三、处理超时
commons-exec主要通过ExecuteWatchdog类来处理超时
@Test
public void testCommonExecWatch() throws IOException {
String command = "ping localhost";
ByteArrayOutputStream susStream = new ByteArrayOutputStream();
ByteArrayOutputStream errStream = new ByteArrayOutputStream();
CommandLine commandLine = CommandLine.parse(command);
DefaultExecutor exec = new DefaultExecutor();
//设置一分钟超时
ExecuteWatchdog watchdog = new ExecuteWatchdog(60 * 1000);
exec.setWatchdog(watchdog);
PumpStreamHandler streamHandler = new PumpStreamHandler(susStream, errStream);
exec.setStreamHandler(streamHandler);
try {
int code = exec.execute(commandLine);
System.out.println("result code: " + code);
// 不同操作系统注意编码，否则结果乱码
String suc = susStream.toString("GBK");
String err = errStream.toString("GBK");
System.out.println(suc + err);
} catch (ExecuteException e) {
if (watchdog.killedProcess()) {
// 被watchdog故意杀死
System.err.println("超时了");
}
}
}
总结
Apache commons-exec提供一些常用的方法用来执行外部进程，Apache commons exec库提供了Watchdog来设监视进程的执行超时，同时也还实现了同步和异步功能，比JDK原生的Runtime要好用很多。
类似资料：