QtPromise是Promises/A+规范的Qt/C++实现。该规范的译文见附录。
QtPromise基于Qt5.6及以上版本,当然也包括Qt6。
github地址:https://github.com/simonbrunel/qtpromise
新手导航:Getting Started | QtPromise
API手册:API Reference,每个API都提供了示例。
Promise是一种异步编程的解决方案,可以替代传统的解决方案——回调函数和事件。
Promise的三个特点:
☆对象的状态不受外界影响。
☆一旦状态改变了就不会在变,也就是说任何时候Promise都只有一种状态。
☆以同步的方式调用异步,通过返回新的promise来实现then链式调用。
Promise的三个缺点:
☆无法取消Promise,一旦新建它就会立即执行,无法中途取消。
☆如果不设置回调函数,Promise内部抛出的错误,不会反映到外部。
☆当处于pending状态时,无法得知目前进展到哪一个阶段,是刚刚开始还是即将完成。
做Qt开发的家人们如果对异步编程有需求,可以尝试使用此开源库。
使用方法很简单,QtPromise源码只有头文件,将源码目录中的qtpromise.pri添加到自己工程的pro文件中即可。
include($$PWD/qtpromise/qtpromise.pri)
然后包含模块的头文件
#include
一个简单的demo
#include
#include
#include
#include
using namespace QtPromise;
int main(int argc, char *argv[])
{
QCoreApplication a(argc, argv);
QNetworkAccessManager *manager = new QNetworkAccessManager();
QString url = "http://www.baidu.com";
// 360安全卫士用于测试超时.
// QString url = "http://dl.360safe.com/setup.exe";
// 可以断网验证网络错误.
QPromise{[&](
const QtPromise::QPromiseResolve& resolve,
const QtPromise::QPromiseReject& reject) {
QNetworkReply* reply = manager->get(QNetworkRequest{url});
QObject::connect(reply, &QNetworkReply::finished, [=]() {
if (reply->error() == QNetworkReply::NoError) {
resolve(reply->readAll());
} else {
reject(reply->error());
}
reply->deleteLater();
});
}}
.timeout(5000)
.then([](const QByteArray &data){
// 如果5秒内下载成功,进行下一步处理.
qDebug()<
需要注意的是then的定义:
QPromise
QPromise
onRejected是可选的, 此时的拒因与调用它的QPromise拒因相同。建议用fail来处理错误,如果非要用onRejected来处理,可改成下面这样。
.then([](const QByteArray &data){
// 如果5秒内下载成功,进行下一步处理.
qDebug()<
一个开放、健全且通用的 JavaScript Promise 标准。由开发者制定,供开发者参考。
译文术语
fulfill
来表示解决,但在后世的 promise 实现多以 resolve
来指代之。Promise 表示一个异步操作的最终结果,与之进行交互的方式主要是 then
方法,该方法注册了两个回调函数,用于接收 promise 的终值或本 promise 不能执行的原因。
本规范详细列出了 then
方法的执行过程,所有遵循 Promises/A+ 规范实现的 promise 均可以本标准作为参照基础来实施 then
方法。因而本规范是十分稳定的。尽管 Promise/A+ 组织有时可能会修订本规范,但主要是为了处理一些特殊的边界情况,且这些改动都是微小且向下兼容的。如果我们要进行大规模不兼容的更新,我们一定会在事先进行谨慎地考虑、详尽的探讨和严格的测试。
从历史上说,本规范实际上是把之前 Promise/A 规范 中的建议明确成为了行为标准:我们一方面扩展了原有规范约定俗成的行为,一方面删减了原规范的一些特例情况和有问题的部分。
最后,核心的 Promises/A+ 规范不设计如何创建、解决和拒绝 promise,而是专注于提供一个通用的 then
方法。上述对于 promises 的操作方法将来在其他规范中可能会提及。
promise 是一个拥有 then
方法的对象或函数,其行为符合本规范;
是一个定义了 then
方法的对象或函数,文中译作“拥有 then
方法”;
指任何 JavaScript 的合法值(包括 undefined
, thenable 和 promise);
是使用 throw
语句抛出的一个值。
表示一个 promise 的拒绝原因。
一个 Promise 的当前状态必须为以下三种状态中的一种:等待态(Pending)、执行态(Fulfilled)和拒绝态(Rejected)。
处于等待态时,promise 需满足以下条件:
处于执行态时,promise 需满足以下条件:
处于拒绝态时,promise 需满足以下条件:
这里的不可变指的是恒等(即可用 ===
判断相等),而不是意味着更深层次的不可变(译者注: 盖指当 value 或 reason 不是基本值时,只要求其引用地址相等,但属性值可被更改)。
一个 promise 必须提供一个 then
方法以访问其当前值、终值和据因。
promise 的 then
方法接受两个参数:
promise.then(onFulfilled, onRejected)
onFulfilled
和 onRejected
都是可选参数。
onFulfilled
不是函数,其必须被忽略onRejected
不是函数,其必须被忽略onFulfilled
特性如果 onFulfilled
是函数:
promise
执行结束后其必须被调用,其第一个参数为 promise
的终值promise
执行结束前其不可被调用onRejected
特性如果 onRejected
是函数:
promise
被拒绝执行后其必须被调用,其第一个参数为 promise
的据因promise
被拒绝执行前其不可被调用onFulfilled
和 onRejected
只有在执行环境堆栈仅包含平台代码时才可被调用 注1
onFulfilled
和 onRejected
必须被作为函数调用(即没有 this
值)注2
then
方法可以被同一个 promise
调用多次
promise
成功执行时,所有 onFulfilled
需按照其注册顺序依次回调promise
被拒绝执行时,所有的 onRejected
需按照其注册顺序依次回调then
方法必须返回一个 promise
对象 注3
promise2 = promise1.then(onFulfilled, onRejected);
onFulfilled
或者 onRejected
返回一个值 x
,则运行下面的 Promise 解决过程:[[Resolve]](promise2, x)
onFulfilled
或者 onRejected
抛出一个异常 e
,则 promise2
必须拒绝执行,并返回拒因 e
onFulfilled
不是函数且 promise1
成功执行, promise2
必须成功执行并返回相同的值onRejected
不是函数且 promise1
拒绝执行, promise2
必须拒绝执行并返回相同的据因译者注: 理解上面的“返回”部分非常重要,即:不论 promise1
被 reject 还是被 resolve 时 promise2
都会被 resolve,只有出现异常时才会被 rejected。
Promise 解决过程 是一个抽象的操作,其需输入一个 promise
和一个值,我们表示为 [[Resolve]](promise, x)
,如果 x
有 then
方法且看上去像一个 Promise ,解决程序即尝试使 promise
接受 x
的状态;否则其用 x
的值来执行 promise
。
这种 thenable 的特性使得 Promise 的实现更具有通用性:只要其暴露出一个遵循 Promise/A+ 协议的 then
方法即可;这同时也使遵循 Promise/A+ 规范的实现可以与那些不太规范但可用的实现能良好共存。
运行 [[Resolve]](promise, x)
需遵循以下步骤:
x
与 promise
相等如果 promise
和 x
指向同一对象,以 TypeError
为据因拒绝执行 promise
x
为 Promise如果 x
为 Promise ,则使 promise
接受 x
的状态 注4:
x
处于等待态, promise
需保持为等待态直至 x
被执行或拒绝x
处于执行态,用相同的值执行 promise
x
处于拒绝态,用相同的据因拒绝 promise
x
为对象或函数如果 x
为对象或者函数:
x.then
赋值给 then
注5x.then
的值时抛出错误 e
,则以 e
为据因拒绝 promise
then
是函数,将 x
作为函数的作用域 this
调用之。传递两个回调函数作为参数,第一个参数叫做 resolvePromise
,第二个参数叫做 rejectPromise
:
resolvePromise
以值 y
为参数被调用,则运行 [[Resolve]](promise, y)
rejectPromise
以据因 r
为参数被调用,则以据因 r
拒绝 promise
resolvePromise
和 rejectPromise
均被调用,或者被同一参数调用了多次,则优先采用首次调用并忽略剩下的调用then
方法抛出了异常 e
:
resolvePromise
或 rejectPromise
已经被调用,则忽略之e
为据因拒绝 promise
then
不是函数,以 x
为参数执行 promise
x
不为对象或者函数,以 x
为参数执行 promise
如果一个 promise 被一个循环的 thenable 链中的对象解决,而 [[Resolve]](promise, thenable)
的递归性质又使得其被再次调用,根据上述的算法将会陷入无限递归之中。算法虽不强制要求,但也鼓励施者检测这样的递归是否存在,若检测到存在则以一个可识别的 TypeError
为据因来拒绝 promise
注6。
注1 这里的平台代码指的是引擎、环境以及 promise 的实施代码。实践中要确保 onFulfilled
和 onRejected
方法异步执行,且应该在 then
方法被调用的那一轮事件循环之后的新执行栈中执行。这个事件队列可以采用“宏任务(macro-task)”机制或者“微任务(micro-task)”机制来实现。由于 promise 的实施代码本身就是平台代码(译者注: 即都是 JavaScript),故代码自身在处理在处理程序时可能已经包含一个任务调度队列或『跳板』)。
译者注: 这里提及了 macrotask 和 microtask 两个概念,这表示异步任务的两种分类。在挂起任务时,JS 引擎会将所有任务按照类别分到这两个队列中,首先在 macrotask 的队列(这个队列也被叫做 task queue)中取出第一个任务,执行完毕后取出 microtask 队列中的所有任务顺序执行;之后再取 macrotask 任务,周而复始,直至两个队列的任务都取完。
两个类别的具体分类如下:
setTimeout
, setInterval
, setImmediate
, I/O, UI renderingmicro-task: process.nextTick
, Promises
(这里指浏览器实现的原生 Promise), Object.observe
, MutationObserver
注2 也就是说在 严格模式(strict) 中,函数 this
的值为 undefined
;在非严格模式中其为全局对象。
注3 代码实现在满足所有要求的情况下可以允许 promise2 === promise1
。每个实现都要文档说明其是否允许以及在何种条件下允许 promise2 === promise1
。
注4 总体来说,如果 x
符合当前实现,我们才认为它是真正的 promise 。这一规则允许那些特例实现接受符合已知要求的 Promises 状态。
注5 这步我们先是存储了一个指向 x.then
的引用,然后测试并调用该引用,以避免多次访问 x.then
属性。这种预防措施确保了该属性的一致性,因为其值可能在检索调用时被改变。
注6 实现不应该对 thenable 链的深度设限,并假定超出本限制的递归就是无限循环。只有真正的循环递归才应能导致 TypeError
异常;如果一条无限长的链上 thenable 均不相同,那么递归下去永远是正确的行为。
译文来源:http://malcolmyu.github.io/malnote/2015/06/12/Promises-A-Plus/
原文链接:https://blog.csdn.net/caoshangpa/article/details/129696818