30分钟,让你彻底明白Promise原理

开发 前端
前一阵子记录了promise的一些常规用法,这篇文章再深入一个层次,来分析分析promise的这种规则机制是如何实现的。ps:本文适合已经对promise的用法有所了解的人阅读,如果对其用法还不是太了解,可以移步我的上一篇博文。

前言

前一阵子记录了promise的一些常规用法,这篇文章再深入一个层次,来分析分析promise的这种规则机制是如何实现的。ps:本文适合已经对promise的用法有所了解的人阅读,如果对其用法还不是太了解,可以移步我的上一篇博文。

本文的promise源码是按照Promise/A+规范来编写的(不想看英文版的移步Promise/A+规范中文翻译)

引子

为了让大家更容易理解,我们从一个场景开始讲解,让大家一步一步跟着思路思考,相信你一定会更容易看懂。

考虑下面一种获取用户id的请求处理

  1. //例1 
  2.  
  3. function getUserId() { 
  4.  
  5.     return new Promise(function(resolve) { 
  6.  
  7.         //异步请求 
  8.  
  9.         http.get(url, function(results) { 
  10.  
  11.             resolve(results.id) 
  12.  
  13.         }) 
  14.  
  15.     }) 
  16.  
  17.  
  18.   
  19.  
  20. getUserId().then(function(id) { 
  21.  
  22.     //一些处理 
  23.  
  24. })  

getUserId方法返回一个promise,可以通过它的then方法注册(注意注册这个词)在promise异步操作成功时执行的回调。这种执行方式,使得异步调用变得十分顺手。

原理剖析

那么类似这种功能的Promise怎么实现呢?其实按照上面一句话,实现一个最基础的雏形还是很easy的。

极简promise雏形

  1. function Promise(fn) { 
  2.  
  3.     var value = null
  4.  
  5.         callbacks = [];  //callbacks为数组,因为可能同时有很多个回调 
  6.  
  7.   
  8.  
  9.     this.then = function (onFulfilled) { 
  10.  
  11.         callbacks.push(onFulfilled); 
  12.  
  13.     }; 
  14.  
  15.   
  16.  
  17.     function resolve(value) { 
  18.  
  19.         callbacks.forEach(function (callback) { 
  20.  
  21.             callback(value); 
  22.  
  23.         }); 
  24.  
  25.     } 
  26.  
  27.   
  28.  
  29.     fn(resolve); 
  30.  
  31.  

上述代码很简单,大致的逻辑是这样的:

  1. 调用then方法,将想要在Promise异步操作成功时执行的回调放入callbacks队列,其实也就是注册回调函数,可以向观察者模式方向思考;
  2. 创建Promise实例时传入的函数会被赋予一个函数类型的参数,即resolve,它接收一个参数value,代表异步操作返回的结果,当一步操作执行成功后,用户会调用resolve方法,这时候其实真正执行的操作是将callbacks队列中的回调一一执行;

可以结合例1中的代码来看,首先new Promise时,传给promise的函数发送异步请求,接着调用promise对象的then属性,注册请求成功的回调函数,然后当异步请求发送成功时,调用resolve(results.id)方法, 该方法执行then方法注册的回调数组。

相信仔细的人应该可以看出来,then方法应该能够链式调用,但是上面的最基础简单的版本显然无法支持链式调用。想让then方法支持链式调用,其实也是很简单的:

  1. this.then = function (onFulfilled) { 
  2.  
  3.     callbacks.push(onFulfilled); 
  4.  
  5.     return this; 
  6.  
  7. };  

see?只要简单一句话就可以实现类似下面的链式调用:

  1. // 例2 
  2.  
  3. getUserId().then(function (id) { 
  4.  
  5.     // 一些处理 
  6.  
  7. }).then(function (id) { 
  8.  
  9.     // 一些处理 
  10.  
  11. });  

加入延时机制

细心的同学应该发现,上述代码可能还存在一个问题:如果在then方法注册回调之前,resolve函数就执行了,怎么办?比如promise内部的函数是同步函数:

  1. // 例3 
  2.  
  3. function getUserId() { 
  4.  
  5.     return new Promise(function (resolve) { 
  6.  
  7.         resolve(9876); 
  8.  
  9.     }); 
  10.  
  11.  
  12. getUserId().then(function (id) { 
  13.  
  14.     // 一些处理 
  15.  
  16. });  

这显然是不允许的,Promises/A+规范明确要求回调需要通过异步方式执行,用以保证一致可靠的执行顺序。因此我们要加入一些处理,保证在resolve执行之前,then方法已经注册完所有的回调。我们可以这样改造下resolve函数:

  1. function resolve(value) { 
  2.  
  3.     setTimeout(function() { 
  4.  
  5.         callbacks.forEach(function (callback) { 
  6.  
  7.             callback(value); 
  8.  
  9.         }); 
  10.  
  11.     }, 0) 
  12.  
  13.  

上述代码的思路也很简单,就是通过setTimeout机制,将resolve中执行回调的逻辑放置到JS任务队列末尾,以保证在resolve执行时,then方法的回调函数已经注册完成.

但是,这样好像还存在一个问题,可以细想一下:如果Promise异步操作已经成功,这时,在异步操作成功之前注册的回调都会执行,但是在Promise异步操作成功这之后调用的then注册的回调就再也不会执行了,这显然不是我们想要的。

加入状态

恩,为了解决上一节抛出的问题,我们必须加入状态机制,也就是大家熟知的pending、fulfilled、rejected。

Promises/A+规范中的2.1Promise States中明确规定了,pending可以转化为fulfilled或rejected并且只能转化一次,也就是说如果pending转化到fulfilled状态,那么就不能再转化到rejected。并且fulfilled和rejected状态只能由pending转化而来,两者之间不能互相转换。一图胜千言:

 

改进后的代码是这样的:

  1. function Promise(fn) { 
  2.  
  3.     var state = 'pending'
  4.  
  5.         value = null
  6.  
  7.         callbacks = []; 
  8.  
  9.   
  10.  
  11.     this.then = function (onFulfilled) { 
  12.  
  13.         if (state === 'pending') { 
  14.  
  15.             callbacks.push(onFulfilled); 
  16.  
  17.             return this; 
  18.  
  19.         } 
  20.  
  21.         onFulfilled(value); 
  22.  
  23.         return this; 
  24.  
  25.     }; 
  26.  
  27.   
  28.  
  29.     function resolve(newValue) { 
  30.  
  31.         value = newValue; 
  32.  
  33.         state = 'fulfilled'
  34.  
  35.         setTimeout(function () { 
  36.  
  37.             callbacks.forEach(function (callback) { 
  38.  
  39.                 callback(value); 
  40.  
  41.             }); 
  42.  
  43.         }, 0); 
  44.  
  45.     } 
  46.  
  47.   
  48.  
  49.     fn(resolve); 
  50.  
  51.  

上述代码的思路是这样的:resolve执行时,会将状态设置为fulfilled,在此之后调用then添加的新回调,都会立即执行。

这里没有任何地方将state设为rejected,为了让大家聚焦在核心代码上,这个问题后面会有一小节专门加入。

链式Promise

那么这里问题又来了,如果用户再then函数里面注册的仍然是一个Promise,该如何解决?比如下面的例4:

  1. // 例4 
  2.  
  3. getUserId() 
  4.  
  5.     .then(getUserJobById) 
  6.  
  7.     .then(function (job) { 
  8.  
  9.         // 对job的处理 
  10.  
  11.     }); 
  12.  
  13.   
  14.  
  15. function getUserJobById(id) { 
  16.  
  17.     return new Promise(function (resolve) { 
  18.  
  19.         http.get(baseUrl + id, function(job) { 
  20.  
  21.             resolve(job); 
  22.  
  23.         }); 
  24.  
  25.     }); 
  26.  
  27.  

这种场景相信用过promise的人都知道会有很多,那么类似这种就是所谓的链式Promise。

链式Promise是指在当前promise达到fulfilled状态后,即开始进行下一个promise(后邻promise)。那么我们如何衔接当前promise和后邻promise呢?(这是这里的难点)。

其实也不是辣么难,只要在then方法里面return一个promise就好啦。Promises/A+规范中的2.2.7就是这么说哒(微笑脸)~

下面来看看这段暗藏玄机的then方法和resolve方法改造代码:

  1. function Promise(fn) { 
  2.  
  3.     var state = 'pending'
  4.  
  5.         value = null
  6.  
  7.         callbacks = []; 
  8.  
  9.   
  10.  
  11.     this.then = function (onFulfilled) { 
  12.  
  13.         return new Promise(function (resolve) { 
  14.  
  15.             handle({ 
  16.  
  17.                 onFulfilled: onFulfilled || null
  18.  
  19.                 resolve: resolve 
  20.  
  21.             }); 
  22.  
  23.         }); 
  24.  
  25.     }; 
  26.  
  27.   
  28.  
  29.     function handle(callback) { 
  30.  
  31.         if (state === 'pending') { 
  32.  
  33.             callbacks.push(callback); 
  34.  
  35.             return
  36.  
  37.         } 
  38.  
  39.         //如果then中没有传递任何东西 
  40.  
  41.         if(!callback.onResolved) { 
  42.  
  43.             callback.resolve(value); 
  44.  
  45.             return
  46.  
  47.         } 
  48.  
  49.   
  50.  
  51.         var ret = callback.onFulfilled(value); 
  52.  
  53.         callback.resolve(ret); 
  54.  
  55.     } 
  56.  
  57.   
  58.  
  59.      
  60.  
  61.     function resolve(newValue) { 
  62.  
  63.         if (newValue && (typeof newValue === 'object' || typeof newValue === 'function')) { 
  64.  
  65.             var then = newValue.then
  66.  
  67.             if (typeof then === 'function') { 
  68.  
  69.                 then.call(newValue, resolve); 
  70.  
  71.                 return
  72.  
  73.             } 
  74.  
  75.         } 
  76.  
  77.         state = 'fulfilled'
  78.  
  79.         value = newValue; 
  80.  
  81.         setTimeout(function () { 
  82.  
  83.             callbacks.forEach(function (callback) { 
  84.  
  85.                 handle(callback); 
  86.  
  87.             }); 
  88.  
  89.         }, 0); 
  90.  
  91.     } 
  92.  
  93.   
  94.  
  95.     fn(resolve); 
  96.  
  97.  

我们结合例4的代码,分析下上面的代码逻辑,为了方便阅读,我把例4的代码贴在这里:

  1. // 例4 
  2.  
  3. getUserId() 
  4.  
  5.     .then(getUserJobById) 
  6.  
  7.     .then(function (job) { 
  8.  
  9.         // 对job的处理 
  10.  
  11.     }); 
  12.  
  13.   
  14.  
  15. function getUserJobById(id) { 
  16.  
  17.     return new Promise(function (resolve) { 
  18.  
  19.         http.get(baseUrl + id, function(job) { 
  20.  
  21.             resolve(job); 
  22.  
  23.         }); 
  24.  
  25.     }); 
  26.  
  27.  
  1. then方法中,创建并返回了新的Promise实例,这是串行Promise的基础,并且支持链式调用。
  2. handle方法是promise内部的方法。then方法传入的形参onFulfilled以及创建新Promise实例时传入的resolve均被push到当前promise的callbacks队列中,这是衔接当前promise和后邻promise的关键所在(这里一定要好好的分析下handle的作用)。
  3. getUserId生成的promise(简称getUserId promise)异步操作成功,执行其内部方法resolve,传入的参数正是异步操作的结果id
  4. 调用handle方法处理callbacks队列中的回调:getUserJobById方法,生成新的promise(getUserJobById promise)
  5. 执行之前由getUserId promise的then方法生成的新promise(称为bridge promise)的resolve方法,传入参数为getUserJobById promise。这种情况下,会将该resolve方法传入getUserJobById promise的then方法中,并直接返回。
  6. 在getUserJobById promise异步操作成功时,执行其callbacks中的回调:getUserId bridge promise中的resolve方法
  7. ***执行getUserId bridge promise的后邻promise的callbacks中的回调。

更直白的可以看下面的图,一图胜千言(都是根据自己的理解画出来的,如有不对欢迎指正):

 

失败处理

在异步操作失败时,标记其状态为rejected,并执行注册的失败回调:

  1. //例5 
  2.  
  3. function getUserId() { 
  4.  
  5.     return new Promise(function(resolve) { 
  6.  
  7.         //异步请求 
  8.  
  9.         http.get(url, function(error, results) { 
  10.  
  11.             if (error) { 
  12.  
  13.                 reject(error); 
  14.  
  15.             } 
  16.  
  17.             resolve(results.id) 
  18.  
  19.         }) 
  20.  
  21.     }) 
  22.  
  23.  
  24.   
  25.  
  26. getUserId().then(function(id) { 
  27.  
  28.     //一些处理 
  29.  
  30. }, function(error) { 
  31.  
  32.     console.log(error) 
  33.  
  34. })  

有了之前处理fulfilled状态的经验,支持错误处理变得很容易,只需要在注册回调、处理状态变更上都要加入新的逻辑:

  1. function Promise(fn) { 
  2.  
  3.     var state = 'pending'
  4.  
  5.         value = null
  6.  
  7.         callbacks = []; 
  8.  
  9.   
  10.  
  11.     this.then = function (onFulfilled, onRejected) { 
  12.  
  13.         return new Promise(function (resolve, reject) { 
  14.  
  15.             handle({ 
  16.  
  17.                 onFulfilled: onFulfilled || null
  18.  
  19.                 onRejected: onRejected || null
  20.  
  21.                 resolve: resolve, 
  22.  
  23.                 reject: reject 
  24.  
  25.             }); 
  26.  
  27.         }); 
  28.  
  29.     }; 
  30.  
  31.   
  32.  
  33.     function handle(callback) { 
  34.  
  35.         if (state === 'pending') { 
  36.  
  37.             callbacks.push(callback); 
  38.  
  39.             return
  40.  
  41.         } 
  42.  
  43.   
  44.  
  45.         var cb = state === 'fulfilled' ? callback.onFulfilled : callback.onRejected, 
  46.  
  47.             ret; 
  48.  
  49.         if (cb === null) { 
  50.  
  51.             cb = state === 'fulfilled' ? callback.resolve : callback.reject; 
  52.  
  53.             cb(value); 
  54.  
  55.             return
  56.  
  57.         } 
  58.  
  59.         ret = cb(value); 
  60.  
  61.         callback.resolve(ret); 
  62.  
  63.     } 
  64.  
  65.   
  66.  
  67.     function resolve(newValue) { 
  68.  
  69.         if (newValue && (typeof newValue === 'object' || typeof newValue === 'function')) { 
  70.  
  71.             var then = newValue.then
  72.  
  73.             if (typeof then === 'function') { 
  74.  
  75.                 then.call(newValue, resolve, reject); 
  76.  
  77.                 return
  78.  
  79.             } 
  80.  
  81.         } 
  82.  
  83.         state = 'fulfilled'
  84.  
  85.         value = newValue; 
  86.  
  87.         execute(); 
  88.  
  89.     } 
  90.  
  91.   
  92.  
  93.     function reject(reason) { 
  94.  
  95.         state = 'rejected'
  96.  
  97.         value = reason; 
  98.  
  99.         execute(); 
  100.  
  101.     } 
  102.  
  103.   
  104.  
  105.     function execute() { 
  106.  
  107.         setTimeout(function () { 
  108.  
  109.             callbacks.forEach(function (callback) { 
  110.  
  111.                 handle(callback); 
  112.  
  113.             }); 
  114.  
  115.         }, 0); 
  116.  
  117.     } 
  118.  
  119.   
  120.  
  121.     fn(resolve, reject); 
  122.  
  123.  

上述代码增加了新的reject方法,供异步操作失败时调用,同时抽出了resolve和reject共用的部分,形成execute方法。

错误冒泡是上述代码已经支持,且非常实用的一个特性。在handle中发现没有指定异步操作失败的回调时,会直接将bridge promise(then函数返回的promise,后同)设为rejected状态,如此达成执行后续失败回调的效果。这有利于简化串行Promise的失败处理成本,因为一组异步操作往往会对应一个实际功能,失败处理方法通常是一致的:

  1. //例6 
  2.  
  3. getUserId() 
  4.  
  5.     .then(getUserJobById) 
  6.  
  7.     .then(function (job) { 
  8.  
  9.         // 处理job 
  10.  
  11.     }, function (error) { 
  12.  
  13.         // getUserId或者getUerJobById时出现的错误 
  14.  
  15.         console.log(error); 
  16.  
  17.     });  

异常处理

细心的同学会想到:如果在执行成功回调、失败回调时代码出错怎么办?对于这类异常,可以使用try-catch捕获错误,并将bridge promise设为rejected状态。handle方法改造如下:

  1. function handle(callback) { 
  2.  
  3.     if (state === 'pending') { 
  4.  
  5.         callbacks.push(callback); 
  6.  
  7.         return
  8.  
  9.     } 
  10.  
  11.   
  12.  
  13.     var cb = state === 'fulfilled' ? callback.onFulfilled : callback.onRejected, 
  14.  
  15.         ret; 
  16.  
  17.     if (cb === null) { 
  18.  
  19.         cb = state === 'fulfilled' ? callback.resolve : callback.reject; 
  20.  
  21.         cb(value); 
  22.  
  23.         return
  24.  
  25.     } 
  26.  
  27.     try { 
  28.  
  29.         ret = cb(value); 
  30.  
  31.         callback.resolve(ret); 
  32.  
  33.     } catch (e) { 
  34.  
  35.         callback.reject(e); 
  36.  
  37.     } 
  38.  
  39.  

如果在异步操作中,多次执行resolve或者reject会重复处理后续回调,可以通过内置一个标志位解决。

总结

刚开始看promise源码的时候总不能很好的理解then和resolve函数的运行机理,但是如果你静下心来,反过来根据执行promise时的逻辑来推演,就不难理解了。这里一定要注意的点是:promise里面的then函数仅仅是注册了后续需要执行的代码,真正的执行是在resolve方法里面执行的,理清了这层,再来分析源码会省力的多。

现在回顾下Promise的实现过程,其主要使用了设计模式中的观察者模式:

  1. 通过Promise.prototype.then和Promise.prototype.catch方法将观察者方法注册到被观察者Promise对象中,同时返回一个新的Promise对象,以便可以链式调用。
  2. 被观察者管理内部pending、fulfilled和rejected的状态转变,同时通过构造函数中传递的resolve和reject方法以主动触发状态转变和通知观察者。

参考文献

  • 深入理解 Promise
  • JavaScript Promises … In Wicked Detail 
责任编辑:庞桂玉 来源: 前端大全
相关推荐

2019-06-05 09:42:53

Kafka App 消息队列

2021-11-07 23:46:32

MySQLSQL索引

2017-07-18 11:10:45

2021-11-11 15:03:35

MySQLSQL索引

2017-11-20 10:25:20

数据库MySQL索引

2020-12-08 08:14:11

SQL注入数据库

2021-08-02 15:40:20

Java日志工具

2017-01-10 09:07:53

tcpdumpGET请求

2009-11-05 10:56:31

WCF通讯

2019-10-12 08:36:48

Java程序员数据结构

2020-05-22 10:20:27

Shiro架构字符串

2013-05-03 10:57:09

泛型泛型教程

2023-07-15 18:26:51

LinuxABI

2021-06-18 07:34:12

Kafka中间件微服务

2021-02-16 09:17:40

VimLinux编辑器

2014-11-10 12:29:52

客服网站

2020-11-06 08:54:43

Vue 3.0函数代码

2015-11-12 10:32:40

GitHub控制系统分布式

2009-10-27 09:17:26

VB.NET生成静态页

2021-03-04 09:26:57

微服务架构数据
点赞
收藏

51CTO技术栈公众号