TAT.dmyang JavaScript Promise 启示录
In JavaScript,Node.js,Web开发 on 2014年05月04日 by view: 45,834
24

本篇,主要普及 promise 的用法。

一直以来,JavaScript 处理异步都是以 callback 的方式,在前端开发领域 callback 机制几乎深入人心。在设计 API 的时候,不管是浏览器厂商还是 SDK 开发商亦或是各种类库的作者,基本上都已经遵循着 callback 的套路。

近几年随着 JavaScript 开发模式的逐渐成熟,CommonJS 规范顺势而生,其中就包括提出了 Promise 规范,Promise 完全改变了 js 异步编程的写法,让异步编程变得十分的易于理解。

在 callback 的模型里边,我们假设需要执行一个异步队列,代码看起来可能像这样:

这也就是我们常说的回调金字塔,当异步的任务很多的时候,维护大量的 callback 将是一场灾难。当今 Node.js 大热,好像很多团队都要用它来做点东西以沾沾 “洋气”,曾经跟一个运维的同学聊天,他们也是打算使用 Node.js 做一些事情,可是一想到 js 的层层回调就望而却步。

好,扯淡完毕,下面进入正题。

Promise 可能大家都不陌生,因为 Promise 规范已经出来好一段时间了,同时 Promise 也已经纳入了 ES6,而且高版本的 chrome、firefox 浏览器都已经原生实现了 Promise,只不过和现如今流行的类 Promise 类库相比少些 API。

所谓 Promise,字面上可以理解为 “承诺”,就是说 A 调用 B,B 返回一个 “承诺” 给 A,然后 A 就可以在写计划的时候这么写:当 B 返回结果给我的时候,A 执行方案 S1,反之如果 B 因为什么原因没有给到 A 想要的结果,那么 A 执行应急方案 S2,这样一来,所有的潜在风险都在 A 的可控范围之内了。

上面这句话,翻译成代码类似:

只看上面这行代码,好像看不出什么特别之处。但现实情况可能比这个复杂许多,A 要完成一件事,可能要依赖不止 B 一个人的响应,可能需要同时向多个人询问,当收到所有的应答之后再执行下一步的方案。最终翻译成代码可能像这样:

在这里,当每一个被询问者做出不符合预期的应答时都用了不同的处理机制。事实上,Promise 规范没有要求这样做,你甚至可以不做任何的处理(即不传入 then 的第二个参数)或者统一处理。

好了,下面我们来认识下 Promise/A+规范

  • 一个 promise 可能有三种状态:等待(pending)、已完成(fulfilled)、已拒绝(rejected)
  • 一个 promise 的状态只可能从 “等待” 转到 “完成” 态或者 “拒绝” 态,不能逆向转换,同时 “完成” 态和 “拒绝” 态不能相互转换
  • promise 必须实现 then 方法(可以说,then 就是 promise 的核心),而且 then 必须返回一个 promise,同一个 promise 的 then 可以调用多次,并且回调的执行顺序跟它们被定义时的顺序一致
  • then 方法接受两个参数,第一个参数是成功时的回调,在 promise 由 “等待” 态转换到 “完成” 态时调用,另一个是失败时的回调,在 promise 由 “等待” 态转换到 “拒绝” 态时调用。同时,then 可以接受另一个 promise 传入,也接受一个 “类 then” 的对象或方法,即 thenable 对象。

可以看到,Promise 规范的内容并不算多,大家可以试着自己实现以下 Promise。

以下是笔者自己在参考许多类 Promise 库之后简单实现的一个 Promise,代码请移步 promiseA

简单分析下思路:

构造函数 Promise 接受一个函数 resolver,可以理解为传入一个异步任务,resolver 接受两个参数,一个是成功时的回调,一个是失败时的回调,这两参数和通过 then 传入的参数是对等的。

其次是 then 的实现,由于 Promise 要求 then 必须返回一个 promise,所以在 then 调用的时候会新生成一个 promise,挂在当前 promise 的_next 上,同一个 promise 多次调用都只会返回之前生成的_next

由于 then 方法接受的两个参数都是可选的,而且类型也没限制,可以是函数,也可以是一个具体的值,还可以是另一个 promise。下面是 then 的具体实现:

 

这里,then 做了简化,其他 promise 类库的实现比这个要复杂得多,同时功能也更多,比如还有第三个参数——notify,表示 promise 当前的进度,这在设计文件上传等时很有用。对 then 的各种参数的处理是最复杂的部分,有兴趣的同学可以参看其他类 Promise 库的实现。

在 then 的基础上,应该还需要至少两个方法,分别是完成 promise 的状态从 pending 到 resolved 或 rejected 的转换,同时执行相应的回调队列,即 resolve()reject()方法。

到此,一个简单的 promise 就设计完成了,下面简单实现下两个 promise 化的函数:

由于 Promise 构造函数接受一个异步任务作为参数,所以 getImg 还可以这样调用:

接下来(见证奇迹的时刻),假设有一个 BT 的需求要这么实现:异步获取一个 json 配置,解析 json 数据拿到里边的图片,然后按顺序队列加载图片,没张图片加载时给个 loading 效果

这里的 sleep 只是为了看效果加的,可猛击查看 demo!当然,Node.js 的例子可查看这里

在这里,Promise.resolve(v)静态方法只是简单返回一个以 v 为肯定结果的 promise,v 可不传入,也可以是一个函数或者是一个包含 then 方法的对象或函数(即 thenable)。

类似的静态方法还有 Promise.cast(promise),生成一个以 promise 为肯定结果的 promise;

Promise.reject(reason),生成一个以 reason 为否定结果的 promise。

我们实际的使用场景可能很复杂,往往需要多个异步的任务穿插执行,并行或者串行同在。这时候,可以对 Promise 进行各种扩展,比如实现 Promise.all(),接受 promises 队列并等待他们完成再继续,再比如 Promise.any(),promises 队列中有任何一个处于完成态时即触发下一步操作。

标准的 Promise

可参考 html5rocks 的这篇文章 JavaScript Promises,目前高级浏览器如 chrome、firefox 都已经内置了 Promise 对象,提供更多的操作接口,比如 Promise.all(),支持传入一个 promises 数组,当所有 promises 都完成时执行 then,还有就是更加友好强大的异常捕获,应对日常的异步编程,应该足够了。

第三方库的 Promise

现今流行的各大 js 库,几乎都不同程度的实现了 Promise,如 dojo,jQuery、Zepto、when.js、Q 等,只是暴露出来的大都是 Deferred 对象,以 jQuery(Zepto 类似)为例,实现上面的 getImg()

当然,jQuery 中,很多的操作都返回的是 Deferred 或 promise,如 animateajax

jQuery 还实现了 done()fail()方法,其实都是 then 方法的 shortcut。

处理 promises 队列,jQuery 实现的是 $.when()方法,用法和 Promise.all()类似。

其他类库,这里值得一提的是 when.js,本身代码不多,完整实现 Promise,同时支持 browser 和 Node.js,而且提供更加丰富的 API,是个不错的选择。这里限于篇幅,不再展开。

尾声

我们看到,不管 Promise 实现怎么复杂,但是它的用法却很简单,组织的代码很清晰,从此不用再受 callback 的折磨了。

最后,Promise 是如此的优雅!但 Promise 也只是解决了回调的深层嵌套的问题,真正简化 JavaScript 异步编程的还是 Generator,在 Node.js 端,建议考虑 Generator。

下一篇,研究下 Generator。

github 原文: https://github.com/chemdemo/chemdemo.github.io/issues/6

参考文献

原创文章转载请注明:

转载自AlloyTeam:http://www.alloyteam.com/2014/05/javascript-promise-mode/

  1. ES6之Promise – 项目经验积累与分享 2016 年 12 月 19 日

    […] –alloyteam […]

  2. 如何优雅地写 js 异步代码 | 神刀安全网 2016 年 4 月 22 日

    […] JavaScript Promise 启示录 […]

  3. mang 2016 年 3 月 31 日

    貌似不支持链式调用

    • mang 2016 年 3 月 31 日

      不知道是不是使用错误

  4. zilong 2015 年 9 月 2 日

    then 必须返回一个 promise 这里我并没有在规范里看到,另外 chrome 里的实现,then 每次返回的也不一样

  5. Barret Lee 2014 年 9 月 29 日

    我也写了篇,http://www.cnblogs.com/hustskyking/p/promise.html
    你这思路还听清晰的,赞一个!

  6. cb 2014 年 9 月 20 日

    很不错,最近看到一个叫 EventProxy(https://github.com/JacksonTian/eventproxy)工具库的代码时,看到了和 promiseA 很相似的设计,这个方法确实好用。赞!

  7. yorick 2014 年 7 月 30 日

    好文章,看了这篇文章才知道异步的这种设计方法,看来要多看书啊

  8. DeepinEleven 2014 年 7 月 5 日

    请问你们用的是自己搭的服务器还是 TX 的服务器啊~和你们的比我的 iamdeepin 感觉速度太慢了,我用的是免费服务器,,,

  9. liyadong 2014 年 6 月 20 日

    function sleep(ms) {
    return function(v) {
    var p = Promise();

    setTimeout(function() {
    p.resolve(v);
    });

    return p;
    };
    };
    ms 这个参数没有使用

  10. www.iwapzone.com 2014 年 6 月 16 日

    活到老学到老,不错不错!

  11. seven 2014 年 6 月 13 日

    webqq 的 404 什么时候能够解决啊 都这么久了 我都发现一个多星期来了,怎么你们团队一点行动都没的啊,404 搞的网站打开那么慢,点错提示了 还打不开网站了

  12. 程序猿小卡 2014 年 6 月 12 日

    顶 dm 君!

  13. WONDER 2014 年 6 月 8 日

    Generator 确实不错~

  14. www.hao60.net 2014 年 6 月 7 日

    JS 开发者现在很多都转向了 HTML5 了,我也正在考虑转行

    • tommyfok 2014 年 8 月 14 日

      JS 和 HTML5 本来就分不开,还谈什么转行?

  15. hale 2014 年 5 月 27 日

    上次一个 plmm 给的面试题,我是用观察者模式做的,有些相近,这才是正解

  16. wangzheng 2014 年 5 月 19 日

    BLOG 可以 RSS 么?

发表评论到 www.iwapzone.com