Qt多线程编程之QThreadPool 和 QRunnable使用

说到线程通常会想到QThread，但其实Qt中创建线程的方式有多种，这里主要介绍其中一种QRunnable，QRunnable和QThread用法有些不同，并且使用场景也有区别。要介绍QRunnable的用法、使用场景以及注意事项，首先还要先来看看QThreadPool，因为QRunnable任务需要使用QThreadPool启动线程。

一、QThreadPool 线程池

1.1 线程池介绍

在一个应用程序中，我们需要多次使用线程，也就意味着，我们需要多次创建并销毁线程。而创建并销毁线程的过程势必会消耗内存。而在日常开发中，内存资源是及其宝贵的，所以线程池QThreadPool就建议用来管理多个线程的并发执行。在程序逻辑中经常会碰到需要处理大批量任务的情况，比如密集的网络请求，日志分析、加载工程中多个子工程、保存工程等等。一般会创建一个队列，用一个或者多个线程去消费这个队列，一般也要处理队列的加锁和解锁的问题。

1.2 线程池的优点

• 创建和销毁线程需要和OS交互，少量线程影响不大，但是线程数量太大，势必会影响性能，使用线程池可以减少这种开销；
• 线程池维护一定数量的线程，使用时，将指定函数传递给线程池，线程池会在线程中执行任务

1.3 QThreadPool类成员函数

主要属性：

1、activeThreadCount: 此属性表示线程池中的活动线程数，通过activeThreadCount() 调用。
2、expiryTimeout: 线程活着的时间。没有设置expiryTimeout毫秒的线程会自动退出，此类线程将根据需要重新启动。默认的expiryTimeout为30000毫秒 (30 秒)。如果expiryTimeout为负, 则新创建的线程将不会过期, 在线程池被销毁之前, 它们将不会退出。通过expiryTimeout()调用，通setExpiryTimeout(int expiryTimeout)设置 。
3、maxThreadCount : int 表示线程池使用的最大线程数。
通过maxThreadCount() 调用，通过setMaxThreadCount(int maxThreadCount) 设置
注意:即使maxThreadCount限制为零或为负数, 线程池也至少有1个线程。

主要成员函数

QThreadPool *QThreadPool::globalInstance()
返回Qt应用程序全局线程池实例。
void reserveThread()
预约一个线程，这个函数总是会增加活动线程的数量。这意味着通过使用这个函数，activeThreadCount()可以返回一个大于maxThreadCount()的值。
void releaseThread()
释放以前通过调用reserveThread()预约的线程。
如果不先预约一个线程，调用这个函数会临时增加maxThreadCount()。当线程进入休眠等待时，能够允许其他线程继续。
要记得在完成等待时调用reserveThread()，以便线程池可以正确控制activeThreadCount()。
void QThreadPool :: start（QRunnable * runnable，int priority = 0）

在任务数量小于maxThreadCount时，为每个runnable任务预约一个线程。超过maxThreadCount时，将任务放入运行队列中。priority 参数用来设置线程运行优先级。

bool tryStart(QRunnable *runnable)
此方法尝试预约一个线程来运行runnable。
如果在调用的时候没有线程可用，那么这个函数什么都不做，并返回false。否则，将使用一个可用线程立即运行runnable，并返回此函数true。

　　void start(QRunnable *runnable, int priority = 0)

　　保留一个线程并使用该线程来运行runnable，（除非该线程会使当前线程计数超过maxThreadCount()）。runnable 会被添加到运行队列中。优先级参数可用于控制运行队列的执行顺序。

　　　　如果 runnable->autoDelete() 返回 true，线程池将拥有 runnable 的所有权，并且 runnable->run() 返回后，线程池将自动删除 runnable。
　　　　如果 runnable->autoDelete() 返回 false，则 runnable 的所有权仍归调用者所有。
　 在调用此函数后更改 runnable 的自动删除（QRunnable::setAutoDelete()）会导致未定义的行为。

void clear()
用于删除在任务队列中，还没有启动的任务。
bool tryTake(QRunnable *runnable)
如果runnable任务还没开始运行，那么从队列中删除此runable任务，此时函数返回true；如果runnable任务已经运行，返回false。
只用来删除runnable->autoDelete() == false的runnable任务，否则可能会删错任务.

　　void setAutoDelete(bool autoDelete)

　　如果autoDelete为 true, 则启用自动删除。否则自动删除将被禁用。
　　如果启用了自动删除, QThreadPool将在调用 run () 函数返回后自动删除此runable对象。否则, runable对象所有权不属于线程池，由开发人员管理。
　　请注意, 必须先设置此标志，(默认构造函数已经将其设置为true)，然后才能调用QThreadPool:: start()。在QThreadPool:: start() 之后调用此函数将导致不可预测后果。

bool waitForDone(int msecs = -1)
等待msecs毫秒, 以便所有线程退出并从线程池中移除所有线程。如果删除了所有线程, 则返回true ，否则, 它将返回false。默认等待时间为-1，即等待最后一个线程退出。

内容出自： https://blog.csdn.net/y396397735/article/details/78637634

1.4 总结

• QThreadPool 类管理 QRunnable /QThread 的集合。
• QThreadPool 管理和回收单独的 QThread 对象，以减少使用线程的程序中的线程创建成本。
• 每个 Qt 应用程序都有一个全局 QThreadPool 对象，可以通过调用 globalInstance() 来访问它。
• 要使用 QThreadPool，需要子类化 QRunnable 并实现 run() 虚函数。然后创建该类的对象并将其传递给 QThreadPool::start()。QThreadPool 默认自动删除 QRunnable。
• QThreadPool 是管理线程的低级类，Qt Concurrent 模块是更高级的方案。

二、QRunnable [ 不继承QObject,不属于Qt的元对象系统]

2.1 介绍

2.1.1 定义及其用法

QRunnable 类是一个接口，用于表示需要执行的任务或代码段，由重新实现的 run() 函数表示。
一般使用 QThreadPool 在单独的线程中执行代码。要使用QRunnable创建线程，步骤如下：

• 继承QRunnable。和QThread使用一样， 首先需要将你的线程类继承于QRunnable。
• 重写run函数。还是和QThread一样，需要重写run函数，run是一个纯虚函数，必须重写。
• 使用QThreadPool启动线程

2.1.2 与QThread的区别

• 与外界通信方式不同。由于QThread是继承于QObject的，但QRunnable不是，所以在QThread线程中可以直接将线程中执行的结果通过信号的方式发到主程序，而QRunnable线程不能用信号槽，只能通过别的方式。
• 启动线程方式不同。QThread线程可以直接调用start()函数启动，而QRunnable线程需要借助QThreadPool进行启动。
• 资源管理不同。QThread线程对象需要手动去管理删除和释放，而QRunnable则会在QThreadPool调用完成后自动释放。

2.1.3 总结

• 作为Qt类中少有的基类， QRunnable提供了简洁有效的可运行对象的创建. 用QRunnable来创建独立的运行对象来运行 不涉及界面元素的数据处理过程 非常合适.
• 优点: 创建过程简洁， 使用方便， 配合着自身的autoDelete特性， 有点“招之即来， 挥之即去”的感觉.
• 缺点: 无法实时提供自身的运行状态.

2.2 两种启动线程方式 [ 全局线程池和非全局线程池 ]

上面我们说到要启动QRunnable线程，需要QThreadPool配合使用，而调用方式有两种：全局线程池和非全局线程池。

2.2.1 全局线程池 [ QThreadPool::globalInstance() ]

每个 Qt 应用程序都有一个全局 QThreadPool 对象，可以通过调用 globalInstance() 来访问它。上面示例中启动方式就是用的全局线程池来启动QRunnable，使用很简单：

QThreadPool::globalInstance()->start(m_pRunnable);

2.2.2  非全局线程池

除此之外，还可以使用非全局线程池的方式来实现，该方式可以控制线程最大数量， 以及其他设置，比较灵活，具体参照帮助文档

    QThreadPool      threadpool;
    threadpool.setMaxThreadCount(1);
    threadpool.start(m_pRunnable);

2.3 外界通信 [ QRunnable+QMetaObject::invokeMethod ]

前面我们提到，因为QRunnable没有继承于QObject，所以没法使用信号槽与外界通信，那么，如果要在QRunnable线程中和外界通信怎么办呢，通常有两种做法：

• 使用多继承。让我们的自定义线程类同时继承于QRunnable和QObject，这样就可以使用信号和槽，但是多线程使用比较麻烦，特别是继承于自定义的类时，容易出现接口混乱，所以在项目中尽量少用多继承。
• 使用QMetaObject::invokeMethod。

2.3.1 QMetaObject::invokeMethod介绍

该函数就是尝试调用obj的member函数，可以是信号、槽或者Q_INVOKABLE声明的函数（能够被Qt元对象系统唤起），如果调用成功，返回true，失败返回false，具体使用方法就不在这里介绍。

//函数定义
[static] bool QMetaObject::invokeMethod(QObject *obj, const char *member, Qt::ConnectionType type, QGenericReturnArgument ret, QGenericArgument val0 = QGenericArgument( Q_NULLPTR ), QGenericArgument val1 = QGenericArgument(), QGenericArgument val2 = QGenericArgument(), QGenericArgument val3 = QGenericArgument(), QGenericArgument val4 = QGenericArgument(), QGenericArgument val5 = QGenericArgument(), QGenericArgument val6 = QGenericArgument(), QGenericArgument val7 = QGenericArgument(), QGenericArgument val8 = QGenericArgument(), QGenericArgument val9 = QGenericArgument())

QMetaObject::invokeMethod可以是异步调用，也可以是同步调用。这取决与它的连接方式Qt::ConnectionType type。如果type为Qt::DirectConnection，则为同步调用，若为Qt::QueuedConnection，则为异步调用。

来看一下，在上面的示例中，我们如何通过QMetaObject::invokeMethod让QRunnable线程与外部主线程通信。

假如我们在主界面中定一个函数 [该函数为QObject类型中一个成员函数] ，用于更新界面内容：

Q_INVOKABLE void setText(QString msg);

线程类：

// .h
class CusRunnable : public QRunnable
{
public:
    explicit CusRunnable(QObject *obj);
    ~CusRunnable();
    void run();

private:
    QObject * m_pObj = nullptr;//主界面需要刷新对象，即setText()对应的类对象
};

// .cpp
CusRunnable::CusRunnable(QObject * obj):
    m_pObj(obj)
{}

CusRunnable::~CusRunnable()
{
    qDebug() << __FUNCTION__;
}

void CusRunnable::run()
{
    qDebug() << __FUNCTION__ << QThread::currentThreadId();

　　//其中"setText"就是要调用的函数,
　　//传参方式Q_ARG(QString,"this is AA!")，表示传入一个QString类型，值为"this is AA!"
　　QMetaObject::invokeMethod(m_pObj,"setText",Q_ARG(QString,"this is AA!"));
    QThread::msleep(1000);
}

参考文章：
原文链接：https://blog.csdn.net/L_Andy/article/details/108608749

原文链接：https://blog.csdn.net/kenfan1647/article/details/118604254