Aitter's Blog

深入理解 Promise (上)

自从ES6流行起来,Promise 的使用变得更频繁更广泛了,比如异步请求一般返回一个 Promise 对象,Generator 中 yield 后面一般跟 Promise 对象,ES7中 Async 函数中 await 后面一般也是 Promise 对象,还有更多的 NodeAPI 也会返回 Promise 对象,可以说现在的编程中 Promise 的使用无处不在,那么我们是否真的弄懂了 Promise 呢?是否有误用或错误使用 Promise 呢?是否知道 Promise 的实现原理和 Promise 的花样玩法呢?下面让我们一起来探讨一下吧。

在回顾知识的时候,总是能发现更多相关知识,从原理到源码再到实践,是一个深入浅出的过程,一边总结,一边实践,发现有太多太多的东西需要说明,本以为三言两语就能说清楚的东西,一下子就变成了长篇大论,为了便于阅读理解,我分成上中下三篇,文中不免有错漏之处,烦请各位大神们指出。

上 - 理论知识

  • Promise 规范
  • ES6 Promise API
  • Polyfill和扩展类库
  • Promise 在应用中的错误用法和误区
    • 当作回调使用
    • 没有返回值
    • 没有catch
    • catch()与then(null, onRejected)
    • 断链
    • 穿透
    • 长度未知的串行与并行
    • Promise.resolve的使用
  • 最佳实践

中 - 手动封装

  • 实现一个简单的 Promise工具类
    • Promise类的结构
    • 构造器的初始化
    • then方法
    • catch方法
  • 添加扩展功能函数
    • all
    • race
    • resolve
    • reject
    • wait
    • stop
    • always
    • done
    • defer
    • timeout
    • sequence
  • 测试
  • 源码

下 - 实践应用

  • 结合应用场景使用Promise
    • 使用Promise编写Web Notifications提示
    • 使用Deferred封装异步请求
    • 异步请求的超时处理
    • 基于Promise的fs方法链

Promise 规范

这里只列举规范中的大致内容,详细内容请查看 Promises/A+ 中文 ,这是ES6 Promises的前身,是一个社区规范,它和 ES6 Promises 有很多共通的内容。

  1. 状态 Promise 的初始状态是 Pending ,状态只能被转换为(Resolved)FulfilledRejected,状态的转换不可逆。
  2. then 必须有 then 方法,接收两个可选函数参数onFulfilledonRejectedthen 方法必须返回一个新的 Promise 对象,为了保证 then 中回调的执行顺序,回调必须使用异步执行。
  3. 兼容 不同的 Promise 的实现必须可以互相调用

具体标准的实现将在 中篇 - 手动封装 中详细说明

ES6 Promise API

如果你对 Promise的使用 还不是很了解,可参考阅读以下资料:

这里只对ES6 Promise API做简要说明

实例方法

  • .then(resolvedFn, rejectFn)
    为Promise实例添加状态改变时的回调,返回值是一个 新的Promise实例
  • .catch()
    .then(null, rejectFn) 的语法糖,返回值也是一个 新的Promise对象
    Promise对象的错误具有冒泡性质,错误会不断的向后传递,直到 .catch() 捕获
    正因为 thencatch 返回的都是 Promise 对象,所以才可以不断的链式调用

静态方法

  • Promise.resolve()
  1. 将现有对象转换为Promise对象
  2. 如果参数是promise实例,则直接返回这个实例
  3. 如果参数是thenabled对象(有then方法的对象),则先将其转换为promise对象,然后立即执行这个对象的then方法
  4. 如果参数是个原始值,则返回一个promise对象,状态为resolved,这个原始值会传递给回调
  5. 没有参数,直接返回一个resolved的Promise对象
  • Promise.reject()
    同上,不同的是返回的promise对象的状态为rejected

  • Promise.all()

  1. 接收一个Promise实例的数组或具有Iterator接口的对象,
  2. 如果元素不是Promise对象,则使用Promise.resolve转成Promise对象
  3. 如果全部成功,状态变为resolved,返回值将组成一个数组传给回调
  4. 只要有一个失败,状态就变为rejected,返回值将直接传递给回调
  5. all() 的返回值也是新的Promise对象
  • Promise.race()
  1. 同上,区别是,只要有一个Promise实例率先发生变化(无论是状态变成resolved还是rejected)都触发then中的回调,返回值将传递给回调
  2. race()的返回值也是新的Promise对象

Polyfill和扩展类库

Polyfill

只需要在浏览器中加载Polyfill类库,就能使用IE10等或者还没有提供对Promise支持的浏览器中使用Promise里规定的方法。

calvinmetcalf/lie 非常简洁的 promise 库,中篇中的手动封装实现就是参考了这个库
jakearchibald/es6-promise 兼容 Promises/A+ 的类库, 它只是 RSVP.js 的一个子集,只实现了Promises 规定的 API。
yahoo/ypromise 这是一个独立版本的 YUI 的 Promise Polyfill,具有和 ES6 Promises 的兼容性。

Promise扩展类库

Promise扩展类库除了实现了Promise中定义的规范之外,还增加了自己独自定义的功能。

kriskowal/q 类库 Q 实现了 Promises 和 Deferreds 等规范。 它自2009年开始开发,还提供了面向Node.js的文件IO API Q-IO 等, 是一个在很多场景下都能用得到的类库。
petkaantonov/bluebird这个类库除了兼容 Promise 规范之外,还扩展了取消promise对象的运行,取得promise的运行进度,以及错误处理的扩展检测等非常丰富的功能,此外它在实现上还在性能问题下了很大的功夫。

注意
在项目中,有可能两个不同的模块使用的是两个不同的Promise类库,那么在大部分的Promise的实现中,都是遵循 Promise/A+ 标准和兼容ES6 Promise接口的,也是不同的Promise的实现是可以互相调用的,如何调用,将在下面说明。

错误用法及误区

当作回调来用 Callback Hell

loadAsync1().then(function(data1) {
loadAsync2(data1).then(function(data2) {
loadAsync3(data2).then(okFn, failFn)
});
});

Promise是用来解决异步嵌套回调的,这种写法虽然可行,但违背了Promise的设计初衷
改成下面的写法,会让结构更加清晰

loadAsync1()
.then(function(data1) {
return loadAsync2(data1)
})
.then(function(data2){
return loadAsync3(data2)
})
.then(okFn, failFn)

没有返回值

loadAsync1()
.then(function(data1) {
loadAsync2(data1)
})
.then(function(data2){
loadAsync3(data2)
})
.then(res=>console.log(res))

promise 的神奇之处在于让我们能够在回调函数里面使用 return 和 throw, 所以在then中可以return出一个promise对象或普通的值,也可以throw出一个错误对象,但如果没有任何返回,将默认返回 undefined,那么后面的then中的回调参数接收到的将是undefined,而不是上一个then中内部函数 loadAsync2 执行的结果,后面都将是undefined。

没有Catch

loadAsync1()
.then(function(data1) {
return loadAsync2(data1)
})
.then(function(data2){
return loadAsync3(data2)
})
.then(okFn, failFn)

这里的调用,并没有添加catch方法,那么如果中间某个环节发生错误,将不会被捕获,控制台将看不到任何错误,不利于调试查错,所以最好在最后添加catch方法用于捕获错误。

添加catch

loadAsync1()
.then(function(data1) {
return loadAsync2(data1)
})
.then(function(data2){
return loadAsync3(data2)
})
.then(okFn, failFn)
.catch(err=>console.log(err))

catch()与then(null, fn)

在有些情况下catch与then(null, fn)并不等同,如下

ajaxLoad1()
.then(res=>{ return ajaxLoad2() })
.catch(err=> console.log(err))

此时,catch捕获的并不是ajaxLoad1的错误,而是ajaxLoad2的错误,所以有时候,两者还是要结合起来使用:

ajaxLoad1()
.then(res=>{ return ajaxLoad2() }, err=>console.log(err))
.catch(err=> console.log(err))

断链 The Broken Chain

function loadAsyncFnX(){ return Promise.resolve(1); }
function doSth(){ return 2; }
function asyncFn(){
var promise = loadAsyncFnX()
promise.then(function(){
return doSth();
})
return promise;
}
asyncFn().then(res=>console.log(res)).catch(err=>console.log(err))
// 1

上面这种用法,从执行结果来看,then中回调的参数其实并不是doSth()返回的结果,而是loadAsyncFnX()返回的结果,catch 到的错误也是 loadAsyncFnX()中的错误,所以 doSth() 的结果和错误将不会被后而的then中的回调捕获到,形成了断链,因为 then 方法将返回一个新的Promise对象,而不是原来的Promise对象。

改写如下

function loadAsyncFnX(){ return Promise.resolve(1); }
function doSth(){ return 2; }
function asyncFn(){
var promise = loadAsyncFnX()
return promise.then(function(){
return doSth();
})
}
asyncFn().then(res=>console.log(res)).catch(err=>console.log(err))
// 2

穿透 Fall Through

new Promise(resolve=>resolve(8))
.then(1)
.catch(null)
.then(Promise.resolve(9))
.then(res=> console.log(res))
// 8

这里,如果then或catch接收的不是函数,那么就会发生穿透行为,所以在应用过程中,应该保证then接收到的参数始终是一个函数。

长度未知的串行与并行

并行执行

getAsyncArr()
.then(promiseArr=>{
var resArr = [];
promiseArr.forEach(v=>{
v().then(res=> resArr.push(res))
})
return resArr;
})
.then(res=>console.log(res))

使用forEach遍历执行promise,在上面的实现中,第二个then有可能拿到的是空的结果或者不完整的结果,因为,第二个then的回调无法预知 promiseArr 中每一个promise是否都执行完成,那么这里可以使用 Promise.all 结合 map 方法去改善

getAsyncArr()
.then(promiseArr=>{
return Promise.all(promiseArr);
})
.then(res=>console.log(res))

如果需要串行执行,那和我们可以利用数据的reduce来处理串行执行

var pA = [
function(){return new Promise(resolve=>resolve(1))},
function(data){return new Promise(resolve=>resolve(1+data))},
function(data){return new Promise(resolve=>resolve(1+data))}
]
pA.reduce((prev, next)=>prev.then(next).then(res=>res),Promise.resolve())
.then(res=>console.log(res))
// 3

Promise.resolve的用法

Promise.reoslve 有一个作用就是可以将 thenable 对象转换为 promise 对象。

thenable 对象,指的是一个具有 .then 方法的对象。
要求是 thenable 对象所拥有的 then 方法应该和 Promise 所拥有的 then 方法具有同样的功能和处理过程。
一个标准的 thenable 对象应该是这样的

var thenable = {
then: function(resolve, reject) {
resolve(42);
}
};

使用 Promise.resolve转换

Promise.resolve(thenable).then(function(value) {
console.log(value); // 42
});

同样具有标准的thenable特性的是 不同的实现Promise标准的类库,所以 ES6 Promise 与 Q 与buldbird 的对象都是可以互相转换的。

jQueyr的defer对象转换为ES6 Promise对象

Promise.resolve($.ajax('api/data.json')).then(res=>console.log(res)))

但也不是所有thenable对象都能被成功转换,主要看各种类库实现是否遵循 Promise/A+标准,不过此类使用场景并不多,不做深入讨论。

最佳实践

  1. then方法中 永远 returnthrow
  2. 如果 promise 链中可能出现错误,一定添加 catch
  3. 永远传递函数给 then 方法
  4. 不要把 promise 写成嵌套

经过本篇的对Promise相关知识的理解和学习,基本上对Promise的概念和使用有了比较详细的了解,下一篇就让我们一起进入 Promise 的源码世界看一看吧。

阅读参考
谈谈使用 promise 时候的一些反模式