Apache Commons Exec 技术文档

最新推荐文章于 2025-05-06 23:15:33 发布

富涌嵘

最新推荐文章于 2025-05-06 23:15:33 发布

阅读量931

点赞数 7

CC 4.0 BY-SA版权

本文链接：https://blog.youkuaiyun.com/gitblog_01295/article/details/143043890

Apache Commons Exec 技术文档

commons-exec Apache Commons Exec 项目地址: https://gitcode.com/gh_mirrors/co/commons-exec

Apache Commons Exec 是一个专为Java虚拟机内部可靠执行外部进程设计的库。它解决了跨操作系统执行命令行操作的一系列复杂问题，并提供了一套高效且易于使用的API。以下是使用该库所需的详细步骤和技术详情。

安装指南

Maven 用户

对于使用Maven管理项目的开发者，只需在您的pom.xml中加入以下依赖：

<dependency>
  <groupId>org.apache.commons</groupId>
  <artifactId>commons-exec</artifactId>
  <version>1.4.0</version>
</dependency>

这将会自动从中央Maven仓库下载最新的库文件。

非Maven 用户

可以直接访问 Apache Commons Exec 下载页面，下载对应的jar包，并将其添加到项目的类路径中。

项目的使用说明

Apache Commons Exec 提供了一个高级接口来执行外部命令，简化了传统使用Runtime.exec()的方式。

基本使用示例

同步执行命令，并捕获输出：

import org.apache.commons.exec.*;

public class BasicUsage {
    public static void main(String[] args) throws Exception {
        CommandLine cmdLine = CommandLine.parse("ping 192.168.1.1");
        DefaultExecutor executor = new DefaultExecutor();
        executor.setExitValue(0);
        
        try (ByteArrayOutputStream out = new ByteArrayOutputStream()) {
            PumpStreamHandler streamHandler = new PumpStreamHandler(out);
            executor.setStreamHandler(streamHandler);
            
            executor.execute(cmdLine);
            System.out.println(new String(out.toByteArray()));
        }
    }
}

项目API使用文档

关键类和方法

CommandLine: 表示要执行的命令及其参数。
- parse(String command): 解析命令字符串为CommandLine对象。
DefaultExecutor: 执行命令的主类。
- execute(CommandLine commandLine): 执行命令。
- setStreamHandler(StreamHandler handler): 设置用于处理输入/输出流的处理器。
PumpStreamHandler: 一种StreamHandler，用于泵送来自执行过程的输出流到指定的流。
ExecuteWatchdog: 可以设置超时时间，以防止长时间运行的进程阻塞程序。

示例：带有超时和错误处理

ExecuteWatchdog watchdog = new ExecuteWatchdog(3000); // 设置超时时间为3秒
executor.setWatchdog(watchdog);

try {
    executor.execute(cmdLine);
} catch (ExecuteException e) {
    if (watchdog.killedProcess()) {
        System.err.println("命令执行超时");
    } else {
        // 处理其他执行异常
    }
}