Qt开发：QProcess的使用

原创

已于 2025-08-04 19:59:47 修改 · 2k 阅读

18 ·

CC 4.0 BY-SA版权

文章标签：

#qt

于 2024-10-21 22:36:12 首次发布

文章目录

一、QProcess概述

QProcess是Qt框架提供的一个类，用于在应用程序中执行外部进程。它提供了一系列函数来启动、控制和与外部进程进行交互。它主要有以下一些重要特性和功能：

启动外部进程：QProcess可以用于启动外部应用程序或命令行工具。通过start函数可以指定要执行的程序路径以及相关的命令行参数。
进程状态和控制：QProcess提供了函数来获取和监控外部进程的状态，例如判断进程是否正在运行、等待进程完成、终止进程等。
进程通信：QProcess支持与外部进程进行通信。可以通过管道（标准输入、标准输出和标准错误输出）进行输入和输出操作，例如向进程发送输入数据并读取进程的输出结果。
信号和槽机制：QProcess使用信号和槽机制来处理与外部进程相关的事件。例如，当外部进程完成时，可以使用finished信号来通知应用程序。
环境设置：QProcess允许设置外部进程的环境变量。可以使用setEnvironment函数来指定进程的环境变量。
工作目录设置：QProcess允许设置外部进程的工作目录。可以使用setWorkingDirectory函数来指定进程的工作目录。

二、QProcess的常用接口函数

2.1 QStringList QProcess::arguments() const
作用：用于获取启动该进程时所设置的命令行参数列表。

返回值：

返回一个 QStringList 类型的参数列表（启动进程时设置的那些参数）

这些参数是通过 start()、setArguments()、或构造时传入的

用途说明：

查询当前 QProcess 对象启动时传递了哪些参数

调试用：可在日志中打印参数信息

判断是否设置了正确的命令行参数

使用示例：
示例 1：启动程序并查询参数

QProcess process;
QStringList args;
args << "-al" << "/home/user";  // 相当于 ls -al /home/user
process.start("ls", args);

qDebug() << "程序参数:" << process.arguments();  // 打印: ["-al", "/home/user"]

示例 2：配合 setProgram() / setArguments() 使用

QProcess process;
process.setProgram("ping");
process.setArguments(QStringList() << "www.baidu.com");

qDebug() << "参数列表:" << process.arguments();  // ["www.baidu.com"]

process.start();

注意事项：

如果你使用 start(commandLine) 单字符串方式启动（例如：start(“ping www.baidu.com”)），arguments() 会返回空，因为参数被包含在 commandLine 字符串中，没有单独解析出来。

所以如果你要用 arguments()，建议用分开形式：start(program, QStringList args) 或 setProgram() + setArguments()。

2.2 void QProcess::closeReadChannel(QProcess::ProcessChannel channel)
参数说明：channel 是枚举值 QProcess::ProcessChannel。
可选值有：

QProcess::StandardOutput：标准输出通道（stdout）

QProcess::StandardError：标准错误通道（stderr）

作用说明：
closeReadChannel() 会关闭指定的读取通道，也就是说你将无法再读取该通道的输出（通过 readAllStandardOutput() 或 readAllStandardError()）。

不会终止子进程

只是阻止当前 QProcess 实例继续读取某个通道的数据

有利于优化资源、控制只关心某个输出通道的场景

使用示例：
示例：只读取标准输出，忽略标准错误

QProcess* process = new QProcess(this);

// 忽略标准错误输出
process->closeReadChannel(QProcess::StandardError);

process->start("ping", QStringList() << "www.baidu.com");

connect(process, &QProcess::readyReadStandardOutput, [=]() {
   
   
    QString output = process->readAllStandardOutput();
    qDebug() << "stdout:" << output;
});

// 即使进程有标准错误输出，你也读不到了

注意事项：

这个函数只能用在进程启动之后或 waitForStarted() 之后

如果你用 setProcessChannelMode(QProcess::MergedChannels) 合并了标准输出和错误通道，那么关闭某个通道可能不会生效（因为已经混合了）

如果你不想让子进程产生标准输出，可以在子进程代码中手动重定向或关闭 stdout

2.3 void QProcess::closeWriteChannel()
作用：用于关闭进程的标准输入通道（stdin），也就是告诉子进程：“我不再给你输入数据了”。

功能说明：

关闭进程的标准输入（stdin）管道

表示：父进程写完了，不会再输入了

通常用于：完成向子进程输入数据之后，主动发出 EOF（文件结束）信号

适用场景：使用 QProcess::write() 向子进程写入数据时（例如交互式程序），子进程往往等待你输入完成（比如 sort、python、ffmpeg 等等）。这时候你要调用 closeWriteChannel()，让子进程知道：
“我写完了，你可以开始处理数据了。”

使用示例：
示例：向 sort 命令输入内容并读取输出

QProcess process;
process.start("sort");

if (process.waitForStarted()) {
   
   
    // 向 sort 程序写入几行文本
    process.write("Banana\n");
    process.write("Apple\n");
    process.write("Orange\n");

    // 写完后必须关闭写通道，否则 sort 会一直等你输入
    process.closeWriteChannel();

    // 等待处理完成
    process.waitForFinished();

    // 读取并输出排序结果
    QString output = process.readAllStandardOutput();
    qDebug() << "Sorted Result:\n" << output;
}

实际效果说明：
若不调用 closeWriteChannel()：

子进程（如 sort）会一直等待输入，不会继续处理

程序可能卡死在 waitForFinished()，因为子进程没结束

调用后效果：

向子进程发送了标准输入结束标志（EOF）

子进程立刻开始处理输入内容

2.4 QProcess::ProcessError QProcess::error() const
返回值：返回一个枚举值 QProcess::ProcessError，表示当前进程遇到的错误类型。如果没有错误，返回 QProcess::UnknownError。

错误类型枚举说明（QProcess::ProcessError）

QProcess::FailedToStart：进程无法启动（如程序路径不存在、权限不足）

QProcess::Crashed 进程启动成功但运行时崩溃（例如段错误）

QProcess::Timedout 等待进程响应时超时

QProcess::WriteError 写入进程标准输入失败

QProcess::ReadError 读取进程标准输出/错误失败

QProcess::UnknownError 未知错误或没有错误

典型用法：
示例 1：启动失败时检查错误

QProcess process;
process.start("not_existing_program");

if (!process.waitForStarted()) {
   
   
    QProcess::ProcessError err = process.error();
    switch (err) {
   
   
    case QProcess::FailedToStart:
        qDebug() << "程序无法启动，可能路径错误或权限不足";
        break;
    case QProcess::Timedout:
        qDebug() << "启动超时";
        break;
    default:
        qDebug() << "其他错误：" << err;
    }
}

示例 2：连接错误信号

QProcess* process = new QProcess(this);
connect(process, &QProcess::errorOccurred, this, [=](QProcess::ProcessError err){
   
   
    qDebug() << "QProcess 错误发生:" << err;

    if (err == QProcess::Crashed) {
   
   
        qDebug() << "子进程运行时崩溃";
    }
});

使用建议：

搭配 waitForStarted() 或 waitForFinished() 使用，检查失败原因

调试或日志输出：用于提示用户“进程未找到”或“访问被拒绝”

与 errorOccurred() 信号配合：可以实时响应错误（推荐异步处理）

2.5 int QProcess::exitCode() const
作用：用于获取子进程退出时返回的退出码（Exit Code）。

返回值：

子进程正常退出时由操作系统返回的整数退出码。

如果进程是异常退出（如崩溃），返回值没有意义（应结合 exitStatus() 判断）。

用途说明：
子进程退出时，通常会返回一个整数代码表示执行成功或失败：

0：正常退出，执行成功

非0：异常退出，执行出错（含义由程序定义）

使用示例：
示例：判断子进程是否执行成功

QProcess process;
process.start("ls", QStringList() << "/invalid_path");

if (process.waitForFinished()) {
   
   
    int code = process.exitCode();
    QProcess::ExitStatus status = process.exitStatus();

    if (status == QProcess::NormalExit && code == 0) {
   
   
        qDebug() << "执行成功";
    } else {
   
   
        qDebug() << "执行失败，退出码:" << code;
    }
}

结合 exitStatus() 使用
因为一个进程可能是因为崩溃而不是主动退出，应该同时检查：

if (process.exitStatus() == QProcess::NormalExit) {
   
   
    int code = process.exitCode();
    qDebug() << "进程正常退出，code=" << code;
} else {
   
   
    qDebug() << "进程崩溃或被终止";
}

实际示例（如启动 Python 脚本）：

process.start("python3", QStringList() << "myscript.py");
process.waitForFinished();

int code = process.exitCode();
qDebug() << "Python 脚本退出码：" << code;

假如你的 myscript.py 最后有：

import sys
sys.exit(3)

2.6 QProcess::ExitStatus QProcess::exitStatus() const
作用：用于判断子进程的退出状态 —— 是正常退出，还是因为崩溃或被系统终止。

返回值类型：QProcess::ExitStatus

QProcess::NormalExit：子进程通过 exit() 或正常结束

QProcess::CrashExit：子进程异常退出（崩溃、被 kill、信号中止等）

与 exitCode() 的关系：

exitStatus() 表示怎么退出的

exitCode() 表示退出时返回的数字

只有当 exitStatus() == NormalExit 时，exitCode() 才有意义。

使用示例：
示例：判断子进程是否崩溃

QProcess process;
process.start("some_executable");

if (process.waitForFinished()) {
   
   
    if (process.exitStatus() == QProcess::NormalExit) {
   
   
        qDebug() << "子进程正常退出，exitCode =" << process.exitCode();
    } else {
   
   
        qDebug() << "子进程异常退出（CrashExit）";
    }
}

典型用途：

判断是否正常完成：exitStatus() 是否为 NormalExit

获取返回结果/状态码如果 NormalExit，再用 exitCode()

判断程序是否崩溃 exitStatus() == CrashExit

补充：信号方式监听退出状态

connect(process, &QProcess::finished,
        [](int exitCode, QProcess::ExitStatus exitStatus){
   
   
    if (exitStatus == QProcess::NormalExit)
        qDebug() << "正常退出:" << exitCode;
    else
        qDebug() << "崩溃退出";
});

2.7 QProcess::InputChannelMode QProcess::inputChannelMode() const
作用：用于查询当前 QProcess 对象的输入通道模式（InputChannelMode），该模式决定了标准输入 (stdin) 是如何被处理或传递的。

返回值说明：QProcess::InputChannelMode 枚举类型
该枚举用于控制 QProcess 输入通道的工作方式：

QProcess::ManagedInputChannel (默认)：Qt 会管理输入通道，允许通过 write()、closeWriteChannel() 等函数给子进程写入数据。

QProcess::ForwardedInputChannel：将父进程的标准输入重定向给子进程（如终端中的输入），不可用 write()。

QProcess::ClosedInputChannel：输入通道关闭，子进程不会接收到任何输入（相当于 stdin 已关闭）。

常见使用场景：
示例 1：查看当前输入通道模式

QProcess process;
qDebug() << process.inputChannelMode();  // 默认输出：QProcess::ManagedInputChannel

示例 2：配合 setInputChannelMode() 使用

QProcess process;
process.setInputChannelMode(QProcess::ForwardedInputChannel);
qDebug() << "当前输入通道模式：" << process.inputChannelMode();

2.8 QString QProcess::nativeArguments() const
作用：用于获取通过 setNativeArguments() 设置的命令行原始参数字符串。它是 QProcess 在某些平台（尤其是 Windows）下提供的扩展功能，用于直接传递原始命令行参数给子进程。

返回值：返回一个 QString，即使用 setNativeArguments() 设置的原始参数字符串。

适用场景：
nativeArguments() / setNativeArguments() 主要适用于以下场景：

需要传递某些特殊参数，使用 QStringList 无法精确表达（比如包含引号、转义符等复杂结构）。

在 Windows 上调用某些程序，它们对命令行解析很特殊（如 cmd.exe、PowerShell）。

使用了 QProcess::setProgram() 设置程序，但希望使用原始字符串拼接方式传参数。

使用示例
示例：设置并获取原始参数

QProcess process;

// 设置程序路径
process.setProgram("ping");

// 设置原始参数字符串（不使用 QStringList）
process.setNativeArguments("www.baidu.com -n 5");

// 获取参数
qDebug() << "Native Args: " << process.nativeArguments();  // 输出： "www.baidu.com -n 5"

process.start();

和 setArguments() 区别对比：
在这里插入图片描述
注意事项：

nativeArguments() 和 arguments() 是互斥的：设置了 setNativeArguments() 后，调用 arguments() 会返回空。

nativeArguments() 是平台相关的 API，在 Linux/macOS 上调用它没有作用（等价于不使用参数）。

使用错误可能导致参数被误解，导致子进程行为异常。

2.9 QProcess::ProcessChannelMode QProcess::processChannelMode() const
返回值：
返回一个枚举值 QProcess::ProcessChannelMode，表示当前子进程的通道模式：

enum QProcess::ProcessChannelMode {
   
   
    QProcess::SeparateChannels,        // stdout 和 stderr 分开（默认）
    QProcess::MergedChannels,          // stderr 合并到 stdout
    QProcess::ForwardedChannels,       // 直接输出到