NodeJS中利用Promise来封装异步函数


Posted in NodeJs onFebruary 25, 2015

 在写Node.js的过程中,连续的IO操作可能会导致“金字塔噩梦”,回调函数的多重嵌套让代码变的难以维护,利用CommonJs的Promise来封装异步函数,使用统一的链式API来摆脱多重回调的噩梦。

Node.js提供的非阻塞IO模型允许我们利用回调函数的方式处理IO操作,但是当需要连续的IO操作时,你的回调函数会多重嵌套,代码很不美观,而且不易维护,而且可能会有许多错误处理的重复代码,也就是所谓的“Pyramid of Doom”。

step1(function (value1) {

    step2(value1, function(value2) {

        step3(value2, function(value3) {

            step4(value3, function(value4) {

                // Do something with value4

            });

        });

    });

});

这其实就是Node.js的Control flow的问题,对于这个问题,解决方案都许多,比如利用async,或者eventProxy等,不过本文的主题是利用CommonJs规范中对Promise来解决这个问题。

什么是Promise?

CommonJs的Promise规范有许多种,我们一般讨论的是Promise/A+规范,它定义了Promise的基本行为。

Promise是一个对象,它通常代表一个在未来可能完成的异步操作。这个操作可能成功也可能失败,所以一个Promise对象一般有3个状态:Pending,Fulfilled,Rejected。分别代表未完成、成功完成和操作失败。一旦Promise对象的状态从Pending变成Fulfilled或者Rejected任意一个,它的状态都没有办法再被改变。

一个Promise对象通常会有一个then方法,这个方法让我们可以去操作未来可能成功后返回的值或者是失败的原因。这个then方法是这样子的:

promise.then(onFulfilled, onRejected)

显而易见的是,then方法接受两个参数,它们通常是两个函数,一个是用来处理操作成功后的结果的,另一个是用来处理操作失败后的原因的,这两个函数的第一个参数分别是成功后的结果和失败的原因。如果传给then方法的不是一个函数,那么这个参数会被忽略。

then方法的返回值是一个Promise对象,这一个特点允许我们链式调用then来达到控制流程的效果。这里有许多细节上的问题,比如值的传递或者错误处理等。Promise的规范是这样定义的:

onFulfilled或者onRejected函数的返回值不是Promise对象,则该值将会作为下一个then方法中onFulfilled的第一个参数,如果返回值是一个Promise对象,怎么then方法的返回值就是该Promise对象
onFulfilled或者onRejected函数中如果有异常抛出,则该then方法的返回的Promise对象状态转为Rejected,如果该Promise对象调用then,则Error对象会作为onRejected函数的第一个参数
如果Promise状态变为Fulfilled而在then方法中没有提供onFulfilled函数,则then方法返回的Promise对象状态变为Fulfilled且成功的结果为上一个Promise的结果,Rejected同理。

补充一句,onFulfilled和onRejected都是异步执行的。

规范的实现:q

上面讲的是Promise的规范,而我们需要的是它的实现,q是一个对Promise/A+有着较好实现规范的库。

首先我们需要创建一个Promise对象,关于Promise对象创建的规范在Promise/B中,这里不做详细的解释,直接上代码。

    function(flag){

        var defer = q.defer();

        fs.readFile("a.txt", function(err, data){

        if(err) defer.reject(err);

            else defer.resolve(data);

            });

            return defer.promise;

    }

多数Promise的实现在Promise的创建上大同小异,通过创建一个具有promise属性的defer对象,如果成功获取到值则调用defer.resolve(value),如果失败,则调用defer.reject(reason),最后返回defer的promise属性即可。这个过程可以理解为调用defer.resolve将Promise的状态变成Fulfilled,调用defer.reject将Promise的状态变成Rejected。

在面对一系列连续的异步方法时,怎么利用Promise写出漂亮的代码呢?看下下面的例子。

    promise0.then(function(result){

        // dosomething

        return result;

    }).then(function(result) {

        // dosomething

        return promise1;    

    }).then(function(result) {

        // dosomething

    }).catch(function(ex) {

        console.log(ex);

    }).finally(function(){

        console.log("final");

    });

在上面的代码中,then方法只接受OnFulfilled,而catch方法实际上就是then(null, OnRejected),这样的话只要一系列异步方法只要始终是成功返回值的,那么代码就会瀑布式的向下运行,如果其中任意一个异步方法失败或者发生异常,那么根据CommonJs的Promise规范,将执行catch中的function。q还提供了finally方法,从字面上也很好理解,就是不论resolve还是reject,最终都会执行finally中的function。

看上去似乎不错,代码更以维护且美观了,那么如果希望并发呢?

     q.all([promise0, promise1, promise2]).spread(function(val0, val1, val2){

                    console.log(arguments);

                }).then(function(){

                    console.log("done");

                }).catch(function(err){

                    console.log(err);

                });

q也为并发提供了api,调用all方法并传递一个Promise数组即可继续使用then的链式风格。还有像q.nfbind等可以将Node.js的原生API转化成Promise来统一代码格式也是挺好的。更多api在这里就不一一详述了。

结论

本文主要介绍通过使用Promise来解决Node.js控制流问题,但Promise也可同样应用于前端,EMCAScript6已经提供了原生的API支持。需要指出的是Promise并不是唯一的解决方案,async也是一个很好的选择,并且提供更友好的并发控制API,不过我觉得Promise在封装具有异步方法的函数时更具优势。

好了,本文就先到这里了,希望对大家能够有所帮助。

NodeJs 相关文章推荐
nodejs中exports与module.exports的区别详细介绍
Jan 14 NodeJs
NodeJS与Mysql的交互示例代码
Aug 18 NodeJs
Nodejs使用mysql模块之获得更新和删除影响的行数的方法
Mar 18 NodeJs
基于NodeJS的前后端分离的思考与实践(一)全栈式开发
Sep 26 NodeJs
NodeJS Web应用监听sock文件实例
Feb 18 NodeJs
Nodejs学习笔记之测试驱动
Apr 16 NodeJs
nodejs爬虫抓取数据乱码问题总结
Jul 03 NodeJs
NodeJS实现阿里大鱼短信通知发送
Jan 17 NodeJs
NodeJS与HTML5相结合实现拖拽多个文件上传到服务器的实现方法
Jul 26 NodeJs
NodeJS收发GET和POST请求的示例代码
Aug 25 NodeJs
nodejs语言实现验证码生成功能的示例代码
Oct 13 NodeJs
NodeJS Web应用监听sock文件实例
Feb 18 #NodeJs
NodeJS使用jQuery选择器操作DOM
Feb 13 #NodeJs
NodeJs基本语法和类型
Feb 13 #NodeJs
nodejs事件的监听与触发的理解分析
Feb 12 #NodeJs
nodejs 整合kindEditor实现图片上传
Feb 03 #NodeJs
NodeJS学习笔记之Connect中间件应用实例
Jan 27 #NodeJs
NodeJS学习笔记之Connect中间件模块(二)
Jan 27 #NodeJs
You might like
PHP创建/删除/复制文件夹、文件
2016/05/03 PHP
让js弹出窗口居前显示的实现方法
2013/07/10 Javascript
查找iframe里元素的方法可传参
2013/09/11 Javascript
js实现div的切换特效上一个下一个
2014/02/11 Javascript
老生常谈js动态添加事件--- 事件委托
2016/07/19 Javascript
基于jPlayer三分屏的制作方法
2016/12/21 Javascript
jQuery is not defined 错误原因与解决方法小结
2017/03/19 Javascript
Angular2+如何去除url中的#号详解
2017/12/20 Javascript
vue代理和跨域问题的解决
2018/07/18 Javascript
详解如何使用router-link对象方式传递参数?
2019/05/02 Javascript
JS去除字符串最后的逗号实例分析【四种方法】
2019/06/20 Javascript
jquery-ui 进度条功能示例【测试可用】
2019/07/25 jQuery
Bootstrap实现模态框效果
2019/09/30 Javascript
js实现数字从零慢慢增加到指定数字示例
2019/11/07 Javascript
Vue.js 中制作自定义选择组件的代码附演示demo
2020/02/28 Javascript
Python中多线程及程序锁浅析
2015/01/21 Python
Python基于有道实现英汉字典功能
2015/07/25 Python
简单理解Python中的装饰器
2015/07/31 Python
关于Python元祖,列表,字典,集合的比较
2017/01/06 Python
Python类的继承和多态代码详解
2017/12/27 Python
Python判断是否json是否包含一个key的方法
2018/12/31 Python
Python中的asyncio代码详解
2019/06/10 Python
python django中8000端口被占用的解决
2019/12/17 Python
Python实现一个简单的递归下降分析器
2020/08/01 Python
python判断元素是否存在的实例方法
2020/09/24 Python
分享一个python的aes加密代码
2020/12/22 Python
Kneipp克奈圃美国官网:德国百年精油配方的传承
2018/02/07 全球购物
英国在线自行车店:Merlin Cycles
2018/08/20 全球购物
演讲稿怎么写才完美
2014/01/02 职场文书
汽车专业学生自我评价
2014/01/19 职场文书
中学生学习保证书
2015/02/26 职场文书
运动会入场词
2015/07/18 职场文书
大学班长竞选稿
2015/11/20 职场文书
幼儿园心得体会范文
2016/01/21 职场文书
Python打包exe时各种异常处理方案总结
2021/05/18 Python
Redis配置外网可访问(redis远程连接不上)的方法
2022/12/24 Redis