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(一)--- Node.js简介及安装开发环境
May 20 NodeJs
nodejs 实现模拟form表单上传文件
Jul 14 NodeJs
nodejs教程之入门
Nov 21 NodeJs
Nodejs实现多人同时在线移动鼠标的小游戏分享
Dec 06 NodeJs
NodeJS遍历文件生产文件列表功能示例
Jan 22 NodeJs
使用nodejs下载风景壁纸
Feb 05 NodeJs
NodeJS测试框架mocha入门教程
Mar 28 NodeJs
详解HTTPS 的原理和 NodeJS 的实现
Jul 04 NodeJs
Nodejs之http的表单提交
Jul 07 NodeJs
nodejs结合Socket.IO实现的即时通讯功能详解
Jan 12 NodeJs
nodeJS模块简单用法示例
Apr 21 NodeJs
搭建一个nodejs脚手架的方法步骤
Jun 28 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中使用Oracle数据库(6)
2006/10/09 PHP
Laravel 5框架学习之环境与配置
2015/04/08 PHP
Joomla数据库操作之JFactory::getDBO用法
2016/05/05 PHP
javascript div 弹出可拖动窗口
2009/02/26 Javascript
JQuery困惑—包装集 DOM节点
2009/10/16 Javascript
jQuery提交多个表单的小例子
2013/06/30 Javascript
用RadioButten或CheckBox实现div的显示与隐藏
2013/09/21 Javascript
js与jquery获取父元素,删除子元素的两种不同方法
2014/01/09 Javascript
红米手机抢购的js代码
2014/03/10 Javascript
javascript类型系统 Window对象学习笔记
2016/01/07 Javascript
JavaScript ES6的新特性使用新方法定义Class
2016/06/28 Javascript
HTML页面定时跳转方法解析(2种任选)
2016/12/22 Javascript
js中let和var定义变量的区别
2018/02/08 Javascript
原生JS实现的碰撞检测功能示例
2018/05/18 Javascript
vue实现文件上传读取及下载功能
2020/11/17 Javascript
python类的方法属性与方法属性的动态绑定代码详解
2017/12/27 Python
python3+PyQt5实现支持多线程的页面索引器应用程序
2018/04/20 Python
基于随机梯度下降的矩阵分解推荐算法(python)
2018/08/31 Python
python去重,一个由dict组成的list的去重示例
2019/01/21 Python
python hough变换检测直线的实现方法
2019/07/12 Python
pytorch实现CNN卷积神经网络
2020/02/19 Python
pyspark 随机森林的实现
2020/04/24 Python
基于Python的接口自动化读写excel文件的方法
2021/01/15 Python
为中国消费者甄选天下优品:网易严选
2016/08/11 全球购物
20世纪40年代连衣裙和复古服装:The Seamstress Of Bloomsbury
2018/07/24 全球购物
初任培训自我鉴定
2013/10/07 职场文书
奶茶店创业计划书范文
2014/01/17 职场文书
军训感想500字
2014/02/20 职场文书
学校食品安全实施方案
2014/06/14 职场文书
培训通知书模板
2015/04/17 职场文书
运动会观后感
2015/06/09 职场文书
三十年同学聚会感言
2015/07/30 职场文书
《我是什么》教学反思
2016/02/16 职场文书
pytorch 权重weight 与 梯度grad 可视化操作
2021/06/05 Python
关于@OnetoMany关系映射的排序问题,使用注解@OrderBy
2021/12/06 Java/Android
python获取字符串中的email
2022/03/31 Python