QThread类提供了一种独立于平台的方式来管理线程。
详细描述
QThread对象管理程序中的一个控制线程。Q线程开始在run()中执行。默认情况下,run()通过调用exec()启动事件循环,并在线程内运行Qt事件循环。
您可以通过使用QObject::moveToThread()将工作对象移动到线程来使用它们。
class Worker : public QObject
{
Q_OBJECT
public slots:
void doWork(const QString ¶meter) {
QString result;
/* ... here is the expensive or blocking operation ... */
emit resultReady(result);
}
signals:
void resultReady(const QString &result);
};
class Controller : public QObject
{
Q_OBJECT
QThread workerThread;
public:
Controller() {
Worker *worker = new Worker;
worker->moveToThread(&workerThread);
connect(&workerThread, &QThread::finished, worker, &QObject::deleteLater);
connect(this, &Controller::operate, worker, &Worker::doWork);
connect(worker, &Worker::resultReady, this, &Controller::handleResults);
workerThread.start();
}
~Controller() {
workerThread.quit();
workerThread.wait();
}
public slots:
void handleResults(const QString &);
signals:
void operate(const QString &);
};
Worker槽函数中的代码将在一个单独的线程中执行。但是,您可以自由地将Worker的槽函数连接到任何线程中任何对象的任何信号。由于一种称为排队连接的机制,跨不同线程连接信号和槽函数是安全的。
另一种使代码在单独的线程中运行的方法是子类化QThread并重新实现run()。例如
class WorkerThread : public QThread
{
Q_OBJECT
void run() override {
QString result;
/* ... here is the expensive or blocking operation ... */
emit resultReady(result);
}
signals:
void resultReady(const QString &s);
};
void MyObject::startWorkInAThread()
{
WorkerThread *workerThread = new WorkerThread(this);
connect(workerThread, &WorkerThread::resultReady, this, &MyObject::handleResults);
connect(workerThread, &WorkerThread::finished, workerThread, &QObject::deleteLater);
workerThread->start();
}
在该示例中,在run函数返回后,线程将退出。除非调用exec(),否则线程中不会运行任何事件循环。
重要的是要记住,QThread实例位于实例化它的旧线程中,而不是位于调用run()的新线程中。这意味着QThread的所有排队槽和调用的方法都将在旧线程中执行。因此,希望在新线程中调用槽函数的开发人员必须使用工作者对象方法;槽函数不应直接实现到子类QThread中。
与排队槽或调用的方法不同,直接在QThread对象上调用的方法将在调用该方法的线程中执行。当对QThread进行子类化时,请记住构造函数在旧线程中执行,而run()在新线程中执行。如果从两个函数都访问成员变量,则从两个不同的线程访问该变量。检查这样做是否安全。
注意:在跨不同线程与对象交互时必须小心。一般来说,函数只能从创建QThread对象本身的线程调用(例如setPriority()),除非文档另有说明。有关详细信息,请参阅同步线程。
管理线程
当线程started()和finished时,QThread会通过信号通知您,或者您可以使用isFinished()和isRunning()来查询线程的状态。
您可以通过调用exit()或quit()来停止线程。在极端情况下,您可能希望强制terminate()一个正在执行的线程。然而,这样做是危险和令人气馁的。有关详细信息,请阅读terminate()和setTerminationEnabled()的文档。
您通常希望在线程结束时解除分配线程中的对象。为此,请将finished()信号连接到QObject::deleteLater()。
使用wait()阻塞调用线程,直到另一个线程完成执行(或直到指定的时间过去)。
QThread还提供静态的、独立于平台的睡眠函数:sleep()、msleep()和usleep()分别允许秒、毫秒和微秒的分辨率。
注意:一般来说,wait()和sleep()函数应该是不必要的,因为Qt是一个事件驱动的框架。考虑监听finished()信号,而不是等待()。考虑使用QTimer而不是sleep()函数。
静态函数currentThreadId()和currentThread()返回当前执行线程的标识符。前者返回线程的平台特定ID;后者返回一个QThread指针。
要选择线程的名称(例如,在Linux上由命令ps-L标识),可以在启动线程之前调用setObjectName()。如果不调用setObjectName(),则给线程的名称将是线程对象的运行时类型的类名(例如,在Mandelbrot示例中为“RenderThread”,因为这是QThread子类的名称)。请注意,这目前不适用于Windows上的发布版本。
成员函数
1. QThread::QThread(QObject *parent = nullptr)
构造一个新的QThread来管理一个新线程。父级拥有QThread的所有权。在调用start()之前,线程不会开始执行。
2.QThread::~QThread()
销毁QThread。
请注意,删除QThread对象不会停止其管理的线程的执行。删除正在运行的QThread(即isFinished()返回false)将导致程序崩溃。在删除QThread之前,请等待finished()信号。
自Qt 6.3以来,即使相应的线程仍在运行,也允许删除通过调用QThread::create()创建的QThread实例。在这种情况下,Qt将向该线程发布中断请求(通过requestInterruption());将要求线程的事件循环(如果有的话)退出(通过quit());并且将阻塞直到线程完成。
3. int QThread::exec()
进入事件循环并等待,直到调用exit(),返回传递给exit()的值。如果通过quit()调用exit(),则返回的值为0。
这个函数是从run()中调用的。有必要调用此函数来启动事件处理。
注意:这只能在线程本身内调用,即当它是当前线程时。
4.void QThread::exit(int returnCode = 0)
告诉线程的事件循环退出并返回代码。
调用此函数后,线程将离开事件循环,并从对QEventLoop::exec()的调用中返回。QEventLoop::exec()函数返回returnCode。
按照惯例,returnCode为0表示成功,任何非零值都表示错误。
请注意,与同名的C库函数不同,此函数确实会返回给调用者 - 停止的是事件处理。
在再次调用QThread::exec()之前,将不再在此线程中启动任何QEventLoop。如果QThread::exec()中的事件循环没有运行,那么对QThread::exec()的下一个调用也将立即返回。
注意:此函数是线程安全的。
5.void QThread::finished()
这个信号是在相关线程完成执行之前从它发出的。
当发出此信号时,事件循环已经停止运行。线程中将不再处理任何事件,但延迟删除事件除外。这个信号可以连接到QObject::deleteLater(),以释放该线程中的对象。
注意:如果关联线程是使用terminate()终止的,则未定义此信号是从哪个线程发出的。
注意:这是一个私人信号。它可以用于信号连接,但不能由用户发出。
6.bool QThread::isFinished() const
如果线程已完成,则返回true;否则返回false。
注意:此函数是线程安全的。
7.bool QThread::isRunning() const
如果线程正在运行,则返回true;否则返回false。
注意:此函数是线程安全的。
8.void QThread::quit()
告诉线程的事件循环退出,返回代码为0(成功)。相当于调用QThread::exit(0)。
如果线程没有事件循环,此函数将不执行任何操作。
注意:此函数是线程安全的。
9.void QThread::run()
线程的起点。在调用start()之后,新创建的线程将调用此函数。默认实现只调用exec()。
您可以重新实现此功能以方便高级线程管理。从该方法返回将结束线程的执行。
10.void QThread::start(QThread::Priority priority = InheritPriority)
通过调用run()开始执行线程。操作系统将根据优先级参数来调度线程。如果线程已经在运行,则此函数不执行任何操作。
优先级参数的影响取决于操作系统的调度策略。特别是,在不支持线程优先级的系统上(例如在Linux上,有关更多详细信息,请参阅sched_setscheduler文档),优先级将被忽略。
11.void QThread::started()
当相关线程开始执行时,在调用run()函数之前,会从该线程发出此信号。
注意:这是一个私人信号。它可以用于信号连接,但不能由用户发出。
12.void QThread::terminate()
终止线程的执行。线程可以立即终止,也可以不立即终止,这取决于操作系统的调度策略。请在terminate()之后使用QThread::wait()。
当线程终止时,所有等待线程完成的线程都将被唤醒。
警告:此功能很危险,不鼓励使用。线程可以在其代码路径中的任何点终止。修改数据时可以终止线程。线程没有机会在自己之后进行清理、解锁任何持有的互斥体等。简而言之,只有在绝对必要的情况下才使用此函数。
可以通过调用QThread::setTerminationEnabled()显式启用或禁用终止。在终止被禁用时调用此函数会导致终止被推迟,直到重新启用终止。有关更多信息,请参阅QThread::setTerminationEnabled()的文档。
注意:此函数是线程安全的。
13.bool QThread::wait(QDeadlineTimer deadline = QDeadlineTimer(QDeadlineTimer::Forever))
阻塞线程,直到满足以下任一条件:
1.与此QThread对象关联的线程已完成执行(即,当它从run()返回时)。如果线程已完成,此函数将返回true。如果线程还没有启动,它也会返回true。
2.截止日期已到。如果达到截止日期,此函数将返回false。
设置为QDeadlineTimer::Forever的最后期限计时器永远不会超时:在这种情况下,只有当线程从run()返回时,或者当线程尚未启动时,函数才会返回。
这提供了与POSIX pthread_join()函数类似的功能。