Promise源码渐进式解读(一)

关注前端小讴,阅读更多原创技术文章
市面上有很多 Promise 库,本文选取一个轻量级的Promise polyfill,逐步实现解析
如果对Promise还不熟悉,请先移步
完整代码+注释,可对照阅读
Promise 构造函数 - 源码
/** Promise构造函数 * 参数fn:执行器函数(resolve,reject)=>{resolve(),reject()} *执行器函数又接收2个参数:resolve和reject回调函数 */ function Promise(fn) { if (!(this instanceof Promise)) throw new TypeError('Promises must be constructed via new') // 如果实例对象不是Promise的实例,抛出错误 if (typeof fn !== 'function') throw new TypeError('not a function') // 如果传入的“执行器函数”不是function类型,抛出错误/** 内部状态码 * 0: pending,当前Promise正在执行中,默认值 * 1: fulfilled, 执行了resolve函数,且参数_value不是期约,即_value instanceof Promise === false * 2: rejected,执行了reject函数 * 3: fulfilled,执行了resolve函数,且参数_value是期约,即_value instanceof Promise === true */ this._state = 0 // 默认值为0/* 是否被处理过 */ this._handled = false // 默认未被处理过/* 解决值/拒绝理由(resolve或reject的参数) */ this._value = https://www.it610.com/article/undefined // 默认为undefined/** 存放Handle实例对象的数组,缓存then方法传入的回调 * 包含3个参数:当前promise的onFulfilled和onRejected回调方法、当前promise的完成后要执行的promise * 当前Promise的resolve()或reject()触发调用后,循环_deferreds数组中的每个Handle实例,处理对应的onFulfilled和onRejected方法 */ this._deferreds = []/** 调用doResolve()方法 * 参数fn:执行器函数 * 参数this:(期约)实例 */ doResolve(fn, this) }

  • 调用new Promise生成Promise实例,参数(执行器函数)必须是function类型
  • 内部设置状态码、是否被处理、解决值/拒绝理由及缓存then()方法传入的回调
  • 立即调用doResolve()方法
doResolve() - 源码
/** doResolve()方法 * 参数fn:执行器函数(resolve,reject)=>{resolve(),reject()} * 参数self:(期约)实例 */ function doResolve(fn, self) { // console.log(self)var done = false // 初始化done,确保resolve或reject只执行一次/* 立即执行(此时并非异步)传入的执行器函数fn */ try { fn( // fn的resolve回调 function (value) { if (done) return done = true /** * resolve()方法 * 参数self:(期约)实例 * 参数value:解决值 */ resolve(self, value) }, // fn的reject回调 function (reason) { if (done) return done = true /** * resolve()方法 * 参数self:(期约)实例 * 参数value:拒绝理由 */ reject(self, reason) } ) } catch (err) { if (done) return done = true reject(self, err) } }

  • 初始化donefalse,一旦执行resolvereject回调将其赋为true,确保回调只执行一次
  • 立即执行执行器函数,证实了执行new Promise时的代码是同步的
  • 立即调用resolve()(resolve 回调时)或reject()(resolve 回调或抛出错误时)方法
    • 如果抛出错误,则调用reject()方法
resolve() - 源码
/** resolve()方法 * 参数self:(期约)实例 * 参数newValue:解决值 */ function resolve(self, newValue) { // console.log(self, newValue) try { if (newValue =https://www.it610.com/article/== self) throw new TypeError('A promise cannot be resolved with itself.') // 解决值不能为期约实例本身(否则将导致无限循环) if ( newValue && (typeof newValue =https://www.it610.com/article/=='object' || typeof newValue =https://www.it610.com/article/=='function') // 如果解决值为对象或函数对象 ) { var then = newValue.then if (newValue instanceof Promise) { // 解决值为promise类型,_state = 3 self._state = 3 self._value = https://www.it610.com/article/newValue finale(self) /* 此时的self Promise { _state: 3, _handled: false, _value: Promise {...}, _deferreds: [] } */ return } else if (typeof then ==='function') { // 解决值为thenable对象(拥有then方法的对象或函数),对其then方法继续执行doResolve // console.log(newValue) // console.log(newValue.then) // console.log(self)// doResolve(function () { //// 整个function作为新的执行器方法,传给doResolve()并立即调用,then()作为当前的resolve(),执行这个resolve()即执行then() //return then.apply(newValue, arguments) // 将解决值的then方法体内的this指向解决值本身,并执行then() // }, self) doResolve(bind(then, newValue), self) // 源码中用apply重写上述的bind方法 // doResolve(then, self) // 不指定then方法体内的this,调用后this指向全局对象windowreturn } } self._state = 1 // 解决值为其他正常值,_state = 1 self._value = https://www.it610.com/article/newValue // 把解决值赋给期约实例的_value属性 // console.log(self) /** * finale()方法 * 参数self:(期约)实例 */ finale(self) } catch (e) { reject(self, e) } }

  • resolve回调的解决值不能为期约实例本身,否则将导致无限循环
  • 如果是Promise对象,则将期约的_state_value分别赋值,然后执行finale()方法
  • 如果是thenable对象(非Promise),则对其then方法继续执行doResolve(用bind方法重写了该过程,可参考注释,先从未重写的入手)
    • 整个function作为执行器方法传给doResolve(),立即调用执行器方法返回then.apply(newValue, arguments)
    • 将解决值的then方法体内的this指向解决值本身,并执行then()
  • 如果不是上述 2 种,也将期约的_state_value分别赋值,也执行finale()方法
  • 如果抛出错误,则调用reject()方法
bind() - 源码
/** Polyfill for Function.prototype.bind * 用apply写bind方法 */ function bind(fn, thisArg) { return function () { fn.apply(thisArg, arguments) } }

reject() - 源码
/** reject()方法 * 参数self:(期约)实例 * 参数newValue:拒绝理由 */ function reject(self, newValue) { self._state = 2 // reject的时候,_state = 2 self._value = https://www.it610.com/article/newValue // 把拒绝理由赋给期约实例的_value属性 finale(self) }

  • 过程与resolve()大致相同,将期约的_state_value分别赋值,而后执行finale()方法
finale() - 测试代码
  • 手写一个测试的finale()方法,方便做阶段测试
/** 测试用的finale()方法 * 参数self:(期约)实例 */ function finale(self) { console.log(self) if (self._state === 1) { console.log('resolve:' + self._value) } else if (self._state === 2) { console.log('reject:' + self._value) } else if (self._state === 3) { console.log('resolve value is Promise') } }

new Promise - 阶段测试
  • 创建Promise实例,根据执行器函数的回调类型(解决/拒绝)及解决值或拒绝理由的类型,打印不同的结果
/** 测试:new Promise(()=>{}) * 实际执行首个resolve或reject后,后续的resolve或reject不会再执行,这里仅把测试结果合并 */ new Promise((resolve, reject) => { resolve(3) // 'resolve:3',解决值为基本类型, /* self为Promise { _state: 1, _handled: false, _value: 3, _deferreds: [] } */ reject(3) // 'reject:3',拒绝值为基本类型 /* self为Promise { _state: 2, _handled: false, _value: 3, _deferreds: [] } */ resolve({ val: 3 }) // 'resolve:[object Object]',解决值为普通对象 /* self为Promise { _state: 1, _handled: false, _value: { val: 3 }, _deferreds: [] } */ resolve(new Promise(() => {})) // 'resolve value is Promise',解决值为期约实例 /* self为Promise { _state: 3, _handled: false, _value: Promise { _state: 0, _handled: false, _value: undefined, _deferreds: [] }, _deferreds: [] } */ resolve({ // 解决值为thenable对象,self为{ value: 3, then: [Function: then] } value: 3, then: function () { /* 在resolve()方法里,指定then方法体内的this。如不指定,则调用后this指向全局对象window,this.value指向undefined */ console.log(this) // { value: 3, then: [Function: then] },this指向解决值本身 console.log(this.value) // 3 }, }) console.log('next coding...') // 'next coding...',只要不抛出错误,均不影响后续代码执行 throw Error('error!') // 抛出错误 })

实现结果总结
  • new Promise代码内部,执行器函数为同步(立即)执行
  • 执行器函数一旦解决或拒绝后,后续resolvereject不会再执行(抛出的错误也不会被捕捉),但不影响其他代码
  • 解决值若是thenable对象,则将其then方法内的this绑定给该对象,并执行其then方法
【Promise源码渐进式解读(一)】截至本节的代码 →

    推荐阅读