浅谈NodeJS之Promise

 

啥是Promise？

Promise是一个构造函数，方法有all、reject、resolve这几个，原型上有then、catch等方法。那么new Promise 出来的对象肯定就有then、catch方法。跟着我一步一步学习吧。本文能让你对Promise有一个颠覆的认识。

 

让我们new一个吧：

var promise = new Promise(function(resolve, reject){

    //异步操作

    setTimeout(function(){

        console.log('执行完毕！');

        resolve('xxx');

    }, 2000);

});

执行异步操作，2秒后输出“执行完毕！”，并调用resolve方法。

 

Promise的构造函数接收一个参数，是函数，并且传入两个参数：resolve，reject，分别表示异步操作执行成功后的回调函数和异步操作执行失败后的回调函数。其实按照标准来讲，resolve是将Promise的状态置为fullfiled，reject是将Promise的状态置为rejected。

  

以上我们new了一个对象，并没有调用它，传进去的函数就已经执行了，所以我们用Promise的时候一般是包在一个函数中，在需要的时候去运行这个函数，如：

function runAsync(){

    var promise = new Promise(function(resolve, reject){

        setTimeout(function(){

            console.log('执行完毕);

            resolve('xxx');

        }, 2000);

    });

    return promise;            

}

runAsync();

包装函数的作用和resolve的作用

 

执行这个函数我们能得到了一个Promise对象，即包装好的函数最后，会return出Promise对象，。还记得Promise对象上有then、catch方法吧？这就是强大之处了，看下面的代码：

runAsync().then(function(data){

    console.log(data);

    //这里用传过来的数据做其他操作

});

在runAsync()的返回上直接调用then方法，then接收一个参数，是函数，并且会拿到我们在runAsync中调用resolve时传的的参数。运行这段代码，2秒后输出“执行完毕”，紧接着输出“xxx”。

 

then里面的函数就跟我们平时的回调函数一个意思，能够在runAsync这个异步任务执行完成之后被执行，这就是Promise的作用，通俗讲，就是把原来的回调写法分离出来，在异步操作执行完后，用链式调用的方式执行回调函数。

 

如果只有一次调用，也可以这么写，效果一样：

function runAsync(callback){

    setTimeout(function(){

        console.log('执行完毕');

        callback('xxx');

    }, 2000);

}

 

runAsync(function(data){

    console.log(data);

});

那么有多层回调该怎么办？

Promise的优势在于，可以在then方法中继续写Promise对象并返回，然后继续调用then来进行回调操作。

 

链式操作的用法

所以，从表面上看，Promise只是能够简化层层回调的写法，而实质上，Promise的精髓是“状态”，用维护状态、传递状态的方式来使得回调函数能够及时调用，它比传递callback函数要简单、灵活的多。所以使用Promise的正确场景是这样的：

function runAsync1(){

    var promise = new Promise(function(resolve, reject){

        setTimeout(function(){

            console.log('异步1完成');

            resolve('xxx1');

        }, 1000);

    });

    return promise ;            

}

function runAsync2(){

    var promise = new Promise(function(resolve, reject){

        setTimeout(function(){

            console.log('异步2完成');

            resolve('xxx2');

        }, 2000);

    });

    return promise ;            

}

function runAsync3(){

    var promise  = new Promise(function(resolve, reject){

        setTimeout(function(){

            console.log('异步3完成');

            resolve('xxx3');

        }, 2000);

    });

    return promise ;            

}

runAsync1()

.then(function(data){

    console.log(data);

    return runAsync2();

})

.then(function(data){

    console.log(data);

    return runAsync3();

})

.then(function(data){

    console.log(data);

});

这样能够按顺序，每隔两秒输出每个异步回调中的内容，在runAsync2中传给resolve的数据，能在接下来的then方法中拿到。运行结果如下：

异步1完成

xxx1

异步2完成

xxx2

异步3完成

xxx3

 

在then方法中，你也可以直接return数据而不是Promise对象，在后面的then中就可以接收到数据了，比如我们把上面的代码修改成这样：

runAsync1()

.then(function(data){

    console.log(data);

    return runAsync2();

})

.then(function(data){

    console.log(data);

    return '直接返回数据';  //这里直接返回数据

})

.then(function(data){

    console.log(data);

});

 

那么输出就变成了这样：

异步1完成

xxx1

异步2完成

xxx2

直接返回数据

 

reject的用法

我们对Promise有了最基本的了解。那么ES6的Promise还有哪些功能。我们只用了resolve，还没用reject。我们前面的例子只有“执行成功”的回调，还没有“失败”的情况，reject的作用就是把Promise的状态置为rejected，这样我们在then中就能捕捉到，然后执行“失败”情况的回调。不多说看代码。

function getNumber(){

    var promise = new Promise(function(resolve, reject){

        //异步操作

        setTimeout(function(){

            var num = Math.ceil(Math.random()*10); //生成1-10的随机数

            if(num<=5){

                resolve(num);

            }

            else{

                reject('数字大了');

            }

        }, 2000);

    });

    return promise;            

}

 

getNumber()

.then(

    function(data){

        console.log('resolved');

        console.log(data);

    },

    function(reason, data){

        console.log('rejected');

        console.log(reason);

    }

);

getNumber函数用来异步获取一个数字，2秒后执行完成，如果数字小于等于5，我们认为是“成功”了，调用resolve修改Promise的状态。否则认为是“失败”了，调用reject并传递一个参数，作为失败的原因。

 

运行getNumber并且在then中传了两个参数，then方法可以接受两个参数，第一个对应resolve的回调，第二个对应reject的回调。所以我们能够分别拿到他们传过来的数据。多次运行这段代码，你会随机得到下面两种结果：

resolved

1

 或者

rejected

数字大了

 

catch的用法

Promise对象除了then方法，还有一个catch方法，它和then的第二个参数一样，用来指定reject的回调，用法是这样：

getNumber()

.then(function(data){

    console.log('resolved');

    console.log(data);

})

.catch(function(reason){

    console.log('rejected');

    console.log(reason);

});

效果和写在then的第二个参数里面一样。不过它还有另外一个作用：在执行resolve的回调（也就是上面then中的第一个参数）时，如果抛出异常了（代码出错了），那么并不会报错卡死js，而是会进到这个catch方法中。请看下面的代码：

getNumber()

.then(function(data){

    console.log('resolved');

    console.log(data);

    console.log(somedata); //此处的somedata未定义

})

.catch(function(reason){

    console.log('rejected');

    console.log(reason);

});

在resolve的回调中，我们console.log(somedata);而somedata这个变量是没有被定义的。如果我们不用Promise，代码运行到这里就直接在控制台报错了，不往下运行了。但是在这里，会得到这样的结果：

resolved

4

rejected

ReferenceError: somedata is not defined(...)

 

 

也就是说进到catch方法里面去了，而且把错误原因传到了reason参数中。即便是有错误的代码也不会报错了，这与我们的try/catch语句有相同的功能。

 

all的用法

Promise的all方法提供了并行执行异步操作的能力，并且在所有异步操作执行完后才执行回调。我们仍旧使用上面定义好的runAsync1、runAsync2、runAsync3这三个函数，看下面的例子：

Promise

.all([runAsync1(), runAsync2(), runAsync3()])

.then(function(results){

    console.log(results);

});

用Promise.all来执行，all接收一个数组参数，里面的值最终都算返回Promise对象。这样，三个异步操作的并行执行的，等到它们都执行完后才会进到then里面。那么，三个异步操作返回的数据哪里去了呢？都在then里面呢，all会把所有异步操作的结果放进一个数组中传给then，就是上面的results。所以上面代码的输出结果就是：

异步1完成

异步2完成

异步3完成

[“xxx1”,”xxx2”,”xxx3”]

 

 

有了all，你就可以并行执行多个异步操作，并且在一个回调中处理所有的返回数据。打开网页时，预先加载需要用到的各种资源如图片、flash以及各种静态文件。所有的都加载完后，我们再进行页面的初始化。

 

race的用法

all方法的效果实际上是“谁跑的慢，以谁为准执行回调”，那么相对的就有另一个方法“谁跑的快，以谁为准执行回调”，这就是race方法，这个词本来就是赛跑的意思。race的用法与all一样，我们把上面runAsync1的延时改为1秒来看一下：

Promise

.race([runAsync1(), runAsync2(), runAsync3()])

.then(function(results){

    console.log(results);

});

这三个异步操作同样是并行执行的。结果你应该可以猜到，1秒后runAsync1已经执行完了，此时then里面的就执行了。结果是这样的：

异步1完成

xxx1

异步2完成

异步3完成

 

在then里面的回调开始执行时，runAsync2()和runAsync3()并没有停止，仍旧再执行。于是再过1秒后，输出了他们结束的标志。

 

我们可以用race给某个异步请求设置超时时间，并且在超时后执行相应的操作，代码如下：

//请求某个图片资源

function requestImg(){

    var promise = new Promise(function(resolve, reject){

        var img = new Image();

        img.onload = function(){

            resolve(img);

        }

        img.src = 'xxx';

    });

    return promise;

}

 

//延时函数，用于给请求计时

function timeout(){

    var promise = new Promise(function(resolve, reject){

        setTimeout(function(){

            reject('图片请求超时');

        }, 5000);

    });

    return promise;

}

 

Promise

.race([requestImg(), timeout()])

.then(function(results){

    console.log(results);

})

.catch(function(reason){

    console.log(reason);

});

requestImg函数会异步请求一张图片，我把地址写为"xxx"，所以肯定是无法成功请求到的。timeout函数是一个延时5秒的异步操作。我们把这两个返回Promise对象的函数放进race，于是他俩就会赛跑，如果5秒之内图片请求成功了，那么便进入then方法，执行正常的流程。如果5秒钟图片还未成功返回，那么timeout就跑赢了，则进入catch，报出“图片请求超时”的信息。运行结果如下：

GET file:///D:/nodeJS/xxx net::ERR_FILE_NOT_FOUND

图片请求超时