《使用 promise 替代回调函数》

知识点

  1. 理解 Promise 概念，为什么需要 promise
  2. 学习 q 的 API，利用 q 来替代回调函数(https://github.com/kriskowal/q )

课程内容

第五课(https://github.com/alsotang/node-lessons/tree/master/lesson5 )讲述了如何使用 async 来控制并发。async 的本质是一个流程控制。其实在异步编程中，还有一个更为经典的模型，叫做 Promise/Deferred 模型。

本节我们就来学习这个模型的代表实现：q

首先，我们思考一个典型的异步编程模型，考虑这样一个题目：读取一个文件，在控制台输出这个文件内容。

  1. var fs = require('fs');
  2. fs.readFile('sample.txt', 'utf8', function (err, data) {
  3.     console.log(data);
  4. });

看起来很简单，再进一步: 读取两个文件，在控制台输出这两个文件内容。

  1. var fs = require('fs');
  2. fs.readFile('sample01.txt', 'utf8', function (err, data) {
  3.     console.log(data);
  4.     fs.readFile('sample02.txt', 'utf8', function (err,data) {
  5.         console.log(data);
  6.     });
  7. });

要是读取更多的文件呢?

  1. var fs = require('fs');
  2. fs.readFile('sample01.txt', 'utf8', function (err, data) {
  3.     fs.readFile('sample02.txt', 'utf8', function (err,data) {
  4.         fs.readFile('sample03.txt', 'utf8', function (err, data) {
  5.             fs.readFile('sample04.txt', 'utf8', function (err, data) {
  7.             });
  8.         });
  9.     });
  10. });

这段代码就是臭名昭著的邪恶金字塔(Pyramid of Doom)。可以使用async来改善这段代码，但是在本课中我们要用promise/defer来改善它。

promise基本概念

先学习promise的基本概念。

  • promise只有三种状态，未完成，完成(fulfilled)和失败(rejected)。
  • promise的状态可以由未完成转换成完成，或者未完成转换成失败。
  • promise的状态转换只发生一次

promise有一个then方法，then方法可以接受3个函数作为参数。前两个函数对应promise的两种状态fulfilled, rejected的回调函数。第三个函数用于处理进度信息。

  1. promiseSomething().then(function(fulfilled){
  2.         //当promise状态变成fulfilled时，调用此函数
  3.     },function(rejected){
  4.         //当promise状态变成rejected时，调用此函数
  5.     },function(progress){
  6.         //当返回进度信息时，调用此函数
  7.     });

学习一个简单的例子：

  1. var Q = require('q');
  2. var defer = Q.defer();
  3. /**
  4.  * 获取初始promise
  5.  * @private
  6.  */
  7. function getInitialPromise() {
  8.   return defer.promise;
  9. }
  10. /**
  11.  * 为promise设置三种状态的回调函数
  12.  */
  13. getInitialPromise().then(function(success){
  14.     console.log(success);
  15. },function(error){
  16.     console.log(error);
  17. },function(progress){
  18.     console.log(progress);
  19. });
  20. defer.notify('in progress');//控制台打印in progress
  21. defer.resolve('resolve');   //控制台打印resolve
  22. defer.reject('reject');        //没有输出。promise的状态只能改变一次

promise的传递

then方法会返回一个promise，在下面这个例子中，我们用outputPromise指向then返回的promise。

  1. var outputPromise = getInputPromise().then(function (fulfilled) {
  2.     }, function (rejected) {
  3.     });

现在outputPromise就变成了受 function(fulfilled) 或者 function(rejected)控制状态的promise了。怎么理解这句话呢？

  • 当function(fulfilled)或者function(rejected)返回一个值，比如一个字符串，数组，对象等等，那么outputPromise的状态就会变成fulfilled。

在下面这个例子中，我们可以看到，当我们把inputPromise的状态通过defer.resovle()变成fulfilled时，控制台输出fulfilled.

当我们把inputPromise的状态通过defer.reject()变成rejected，控制台输出rejected

  1. var Q = require('q');
  2. var defer = Q.defer();
  3. /**
  4.  * 通过defer获得promise
  5.  * @private
  6.  */
  7. function getInputPromise() {
  8.     return defer.promise;
  9. }
  11. /**
  12.  * 当inputPromise状态由未完成变成fulfil时，调用function(fulfilled)
  13.  * 当inputPromise状态由未完成变成rejected时，调用function(rejected)
  14.  * 将then返回的promise赋给outputPromise
  15.  * function(fulfilled) 和 function(rejected) 通过返回字符串将outputPromise的状态由
  16.  * 未完成改变为fulfilled
  17.  * @private
  18.  */
  19. var outputPromise = getInputPromise().then(function(fulfilled){
  20.     return 'fulfilled';
  21. },function(rejected){
  22.     return 'rejected';
  23. });
  25. /**
  26.  * 当outputPromise状态由未完成变成fulfil时，调用function(fulfilled)，控制台打印'fulfilled: fulfilled'。
  27.  * 当outputPromise状态由未完成变成rejected, 调用function(rejected), 控制台打印'rejected: rejected'。
  28.  */
  29. outputPromise.then(function(fulfilled){
  30.     console.log('fulfilled: ' + fulfilled);
  31. },function(rejected){
  32.     console.log('rejected: ' + rejected);
  33. });
  35. /**
  36.  * 将inputPromise的状态由未完成变成rejected
  37.  */
  38. defer.reject(); //输出 fulfilled: rejected
  40. /**
  41.  * 将inputPromise的状态由未完成变成fulfilled
  42.  */
  43. //defer.resolve(); //输出 fulfilled: fulfilled
  • 当function(fulfilled)或者function(rejected)抛出异常时，那么outputPromise的状态就会变成rejected
  1. var Q = require('q');
  2. var fs = require('fs');
  3. var defer = Q.defer();
  5. /**
  6.  * 通过defer获得promise
  7.  * @private
  8.  */
  9. function getInputPromise() {
  10.     return defer.promise;
  11. }
  13. /**
  14.  * 当inputPromise状态由未完成变成fulfil时，调用function(fulfilled)
  15.  * 当inputPromise状态由未完成变成rejected时，调用function(rejected)
  16.  * 将then返回的promise赋给outputPromise
  17.  * function(fulfilled) 和 function(rejected) 通过抛出异常将outputPromise的状态由
  18.  * 未完成改变为reject
  19.  * @private
  20.  */
  21. var outputPromise = getInputPromise().then(function(fulfilled){
  22.     throw new Error('fulfilled');
  23. },function(rejected){
  24.     throw new Error('rejected');
  25. });
  27. /**
  28.  * 当outputPromise状态由未完成变成fulfil时，调用function(fulfilled)。
  29.  * 当outputPromise状态由未完成变成rejected, 调用function(rejected)。
  30.  */
  31. outputPromise.then(function(fulfilled){
  32.     console.log('fulfilled: ' + fulfilled);
  33. },function(rejected){
  34.     console.log('rejected: ' + rejected);
  35. });
  37. /**
  38.  * 将inputPromise的状态由未完成变成rejected
  39.  */
  40. defer.reject();     //控制台打印 rejected [Error:rejected]
  42. /**
  43.  * 将inputPromise的状态由未完成变成fulfilled
  44.  */
  45. //defer.resolve(); //控制台打印 rejected [Error:fulfilled]
  • 当function(fulfilled)或者function(rejected)返回一个promise时，outputPromise就会成为这个新的promise.

这样做有什么意义呢? 主要在于聚合结果(Q.all)，管理延时，异常恢复等等

比如说我们想要读取一个文件的内容，然后把这些内容打印出来。可能会写出这样的代码：

  1. //错误的写法
  2. var outputPromise = getInputPromise().then(function(fulfilled){
  3.     fs.readFile('test.txt','utf8',function(err,data){
  4.         return data;
  5.     });
  6. });

然而这样写是错误的，因为function(fulfilled)并没有返回任何值。需要下面的方式:

  1. var Q = require('q');
  2. var fs = require('fs');
  3. var defer = Q.defer();
  5. /**
  6.  * 通过defer获得promise
  7.  * @private
  8.  */
  9. function getInputPromise() {
  10.     return defer.promise;
  11. }
  13. /**
  14.  * 当inputPromise状态由未完成变成fulfil时，调用function(fulfilled)
  15.  * 当inputPromise状态由未完成变成rejected时，调用function(rejected)
  16.  * 将then返回的promise赋给outputPromise
  17.  * function(fulfilled)将新的promise赋给outputPromise
  18.  * 未完成改变为reject
  19.  * @private
  20.  */
  21. var outputPromise = getInputPromise().then(function(fulfilled){
  22.     var myDefer = Q.defer();
  23.     fs.readFile('test.txt','utf8',function(err,data){
  24.         if(!err && data) {
  25.             myDefer.resolve(data);
  26.         }
  27.     });
  28.     return myDefer.promise;
  29. },function(rejected){
  30.     throw new Error('rejected');
  31. });
  33. /**
  34.  * 当outputPromise状态由未完成变成fulfil时，调用function(fulfilled)，控制台打印test.txt文件内容。
  35.  *
  36.  */
  37. outputPromise.then(function(fulfilled){
  38.     console.log(fulfilled);
  39. },function(rejected){
  40.     console.log(rejected);
  41. });
  43. /**
  44.  * 将inputPromise的状态由未完成变成rejected
  45.  */
  46. //defer.reject();
  48. /**
  49.  * 将inputPromise的状态由未完成变成fulfilled
  50.  */
  51. defer.resolve(); //控制台打印出 test.txt 的内容

方法传递

方法传递有些类似于Java中的try和catch。当一个异常没有响应的捕获时，这个异常会接着往下传递。

方法传递的含义是当一个状态没有响应的回调函数，就会沿着then往下找。

  • 没有提供function(rejected)
  1. var outputPromise = getInputPromise().then(function(fulfilled){})

如果inputPromise的状态由未完成变成rejected, 此时对rejected的处理会由outputPromise来完成。

  1. var Q = require('q');
  2. var fs = require('fs');
  3. var defer = Q.defer();
  5. /**
  6.  * 通过defer获得promise
  7.  * @private
  8.  */
  9. function getInputPromise() {
  10.     return defer.promise;
  11. }
  13. /**
  14.  * 当inputPromise状态由未完成变成fulfil时，调用function(fulfilled)
  15.  * 当inputPromise状态由未完成变成rejected时，这个rejected会传向outputPromise
  16.  */
  17. var outputPromise = getInputPromise().then(function(fulfilled){
  18.     return 'fulfilled'
  19. });
  20. outputPromise.then(function(fulfilled){
  21.     console.log('fulfilled: ' + fulfilled);
  22. },function(rejected){
  23.     console.log('rejected: ' + rejected);
  24. });
  26. /**
  27.  * 将inputPromise的状态由未完成变成rejected
  28.  */
  29. defer.reject('inputpromise rejected'); //控制台打印rejected: inputpromise rejected
  31. /**
  32.  * 将inputPromise的状态由未完成变成fulfilled
  33.  */
  34. //defer.resolve();
  • 没有提供function(fulfilled)
  1. var outputPromise = getInputPromise().then(null,function(rejected){})

如果inputPromise的状态由未完成变成fulfilled, 此时对fulfil的处理会由outputPromise来完成。

  1. var Q = require('q');
  2. var fs = require('fs');
  3. var defer = Q.defer();
  5. /**
  6.  * 通过defer获得promise
  7.  * @private
  8.  */
  9. function getInputPromise() {
  10.     return defer.promise;
  11. }
  13. /**
  14.  * 当inputPromise状态由未完成变成fulfil时，传递给outputPromise
  15.  * 当inputPromise状态由未完成变成rejected时，调用function(rejected)
  16.  * function(fulfilled)将新的promise赋给outputPromise
  17.  * 未完成改变为reject
  18.  * @private
  19.  */
  20. var outputPromise = getInputPromise().then(null,function(rejected){
  21.     return 'rejected';
  22. });
  24. outputPromise.then(function(fulfilled){
  25.     console.log('fulfilled: ' + fulfilled);
  26. },function(rejected){
  27.     console.log('rejected: ' + rejected);
  28. });
  30. /**
  31.  * 将inputPromise的状态由未完成变成rejected
  32.  */
  33. //defer.reject('inputpromise rejected');
  35. /**
  36.  * 将inputPromise的状态由未完成变成fulfilled
  37.  */
  38. defer.resolve('inputpromise fulfilled'); //控制台打印fulfilled: inputpromise fulfilled
  • 可以使用fail(function(error))来专门针对错误处理，而不是使用then(null,function(error))
  1.  var outputPromise = getInputPromise().fail(function(error){})

看这个例子

  1. var Q = require('q');
  2. var fs = require('fs');
  3. var defer = Q.defer();
  5. /**
  6.  * 通过defer获得promise
  7.  * @private
  8.  */
  9. function getInputPromise() {
  10.     return defer.promise;
  11. }
  13. /**
  14.  * 当inputPromise状态由未完成变成fulfil时，调用then(function(fulfilled))
  15.  * 当inputPromise状态由未完成变成rejected时，调用fail(function(error))
  16.  * function(fulfilled)将新的promise赋给outputPromise
  17.  * 未完成改变为reject
  18.  * @private
  19.  */
  20. var outputPromise = getInputPromise().then(function(fulfilled){
  21.     return fulfilled;
  22. }).fail(function(error){
  23.     console.log('fail: ' + error);
  24. });
  25. /**
  26.  * 将inputPromise的状态由未完成变成rejected
  27.  */
  28. defer.reject('inputpromise rejected');//控制台打印fail: inputpromise rejected
  30. /**
  31.  * 将inputPromise的状态由未完成变成fulfilled
  32.  */
  33. //defer.resolve('inputpromise fulfilled');
  • 可以使用progress(function(progress))来专门针对进度信息进行处理，而不是使用 then(function(success){},function(error){},function(progress){})
  1. var Q = require('q');
  2. var defer = Q.defer();
  3. /**
  4.  * 获取初始promise
  5.  * @private
  6.  */
  7. function getInitialPromise() {
  8.   return defer.promise;
  9. }
  10. /**
  11.  * 为promise设置progress信息处理函数
  12.  */
  13. var outputPromise = getInitialPromise().then(function(success){
  15. }).progress(function(progress){
  16.     console.log(progress);
  17. });
  19. defer.notify(1);
  20. defer.notify(2); //控制台打印1，2

promise链

promise链提供了一种让函数顺序执行的方法。

函数顺序执行是很重要的一个功能。比如知道用户名，需要根据用户名从数据库中找到相应的用户，然后将用户信息传给下一个函数进行处理。

  1. var Q = require('q');
  2. var defer = Q.defer();
  4. //一个模拟数据库
  5. var users = [{'name':'andrew','passwd':'password'}];
  7. function getUsername() {
  8. return defer.promise;
  9. }
  11. function getUser(username){
  12.     var user;
  13.     users.forEach(function(element){
  14.         if(element.name === username) {
  15.             user = element;
  16.         }
  17.     });
  18.     return user;
  19. }
  21. //promise链
  22. getUsername().then(function(username){
  23.  return getUser(username);
  24. }).then(function(user){
  25.  console.log(user);
  26. });
  28. defer.resolve('andrew');

我们通过两个then达到让函数顺序执行的目的。

then的数量其实是没有限制的。当然，then的数量过多，要手动把他们链接起来是很麻烦的。比如

  1. foo(initialVal).then(bar).then(baz).then(qux)

这时我们需要用代码来动态制造promise链

  1. var funcs = [foo,bar,baz,qux]
  2. var result = Q(initialVal)
  3. funcs.forEach(function(func){
  4.     result = result.then(func)
  5. })
  6. return result

当然，我们可以再简洁一点

  1. var funcs = [foo,bar,baz,qux]
  2. funcs.reduce(function(pre,current),Q(initialVal){
  3.     return pre.then(current)
  4. })

看一个具体的例子

  1. function foo(result) {
  2.     console.log(result);
  3.     return result+result;
  4. }
  5. //手动链接
  6. Q('hello').then(foo).then(foo).then(foo);                                     //控制台输出： hello
  7.                                                                             //               hellohello
  8.                                                                             //               hellohellohello
  10. //动态链接
  11. var funcs = [foo,foo,foo];
  12. var result = Q('hello');
  13. funcs.forEach(function(func){
  14.     result = result.then(func);
  15. });
  16. //精简后的动态链接
  17. funcs.reduce(function(prev,current){
  18.     return prev.then(current);
  19. },Q('hello'));

对于promise链，最重要的是需要理解为什么这个链能够顺序执行。如果能够理解这点，那么以后自己写promise链可以说是轻车熟路啊。

promise组合

回到我们一开始读取文件内容的例子。如果现在让我们把它改写成promise链，是不是很简单呢？

  1. var Q = require('q'),
  2.     fs = require('fs');
  3. function printFileContent(fileName) {
  4.     return function(){
  5.         var defer = Q.defer();
  6.         fs.readFile(fileName,'utf8',function(err,data){
  7.           if(!err && data) {
  8.             console.log(data);
  9.             defer.resolve();
  10.           }
  11.         })
  12.         return defer.promise;
  13.     }
  14. }
  15. //手动链接
  16. printFileContent('sample01.txt')()
  17.     .then(printFileContent('sample02.txt'))
  18.     .then(printFileContent('sample03.txt'))
  19.     .then(printFileContent('sample04.txt'));   //控制台顺序打印sample01到sample04的内容

很有成就感是不是。然而如果仔细分析，我们会发现为什么要他们顺序执行呢，如果他们能够并行执行不是更好吗? 我们只需要在他们都执行完成之后，得到他们的执行结果就可以了。

我们可以通过Q.all([promise1,promise2…])将多个promise组合成一个promise返回。
注意：

  1. 当all里面所有的promise都fulfil时，Q.all返回的promise状态变成fulfil
  2. 当任意一个promise被reject时，Q.all返回的promise状态立即变成reject

我们来把上面读取文件内容的例子改成并行执行吧

  1. var Q = require('q');
  2. var fs = require('fs');
  3. /**
  4.  *读取文件内容
  5.  *@private
  6.  */
  7. function printFileContent(fileName) {
  8.         //Todo: 这段代码不够简洁。可以使用Q.denodeify来简化
  9.         var defer = Q.defer();
  10.         fs.readFile(fileName,'utf8',function(err,data){
  11.           if(!err && data) {
  12.             console.log(data);
  13.             defer.resolve(fileName + ' success ');
  14.           }else {
  15.             defer.reject(fileName + ' fail ');
  16.           }
  17.         })
  18.         return defer.promise;
  19. }
  21. Q.all([printFileContent('sample01.txt'),printFileContent('sample02.txt'),printFileContent('sample03.txt'),printFileContent('sample04.txt')])
  22.     .then(function(success){
  23.         console.log(success);
  24.     }); //控制台打印各个文件内容 顺序不一定

现在知道Q.all会在任意一个promise进入reject状态后立即进入reject状态。如果我们需要等到所有的promise都发生状态后(有的fulfil, 有的reject)，再转换Q.all的状态, 这时我们可以使用Q.allSettled

  1. var Q = require('q'),
  2.     fs = require('fs');
  3. /**
  4.  *读取文件内容
  5.  *@private
  6.  */
  7. function printFileContent(fileName) {
  8.     //Todo: 这段代码不够简洁。可以使用Q.denodeify来简化
  9.     var defer = Q.defer();
  10.     fs.readFile(fileName,'utf8',function(err,data){
  11.       if(!err && data) {
  12.         console.log(data);
  13.         defer.resolve(fileName + ' success ');
  14.       }else {
  15.         defer.reject(fileName + ' fail ');
  16.       }
  17.     })
  18.     return defer.promise;
  19. }
  21. Q.allSettled([printFileContent('nosuchfile.txt'),printFileContent('sample02.txt'),printFileContent('sample03.txt'),printFileContent('sample04.txt')])
  22.     .then(function(results){
  23.         results.forEach(
  24.             function(result) {
  25.                 console.log(result.state);
  26.             }
  27.         );
  28.     });

结束promise链

通常，对于一个promise链，有两种结束的方式。第一种方式是返回最后一个promise

如 return foo().then(bar);

第二种方式就是通过done来结束promise链

如 foo().then(bar).done()

为什么需要通过done来结束一个promise链呢? 如果在我们的链中有错误没有被处理，那么在一个正确结束的promise链中，这个没被处理的错误会通过异常抛出。

  1. var Q = require('q');
  2. /**
  3.  *@private
  4.  */
  5. function getPromise(msg,timeout,opt) {
  6.     var defer = Q.defer();
  7.     setTimeout(function(){
  8.     console.log(msg);
  9.         if(opt)
  10.             defer.reject(msg);
  11.         else
  12.             defer.resolve(msg);
  13.     },timeout);
  14.     return defer.promise;
  15. }
  16. /**
  17.  *没有用done()结束的promise链
  18.  *由于getPromse('2',2000,'opt')返回rejected, getPromise('3',1000)就没有执行
  19.  *然后这个异常并没有任何提醒，是一个潜在的bug
  20.  */
  21. getPromise('1',3000)
  22.     .then(function(){return getPromise('2',2000,'opt')})
  23.     .then(function(){return getPromise('3',1000)});
  24. /**
  25.  *用done()结束的promise链
  26.  *有异常抛出
  27.  */
  28. getPromise('1',3000)
  29.     .then(function(){return getPromise('2',2000,'opt')})
  30.     .then(function(){return getPromise('3',1000)})
  31.     .done();

结束语

当你理解完上面所有的知识点时，你就会正确高效的使用promise了。本节只是讲了promise的原理和几个基本的API，不过你掌握了这些之后，再去看q的文档，应该很容易就能理解各个api的意图。