Promise實(shí)現(xiàn)

Promise代表一個異步操作的結(jié)果,使用Promise我們可以:

  1. 擺脫回調(diào)地獄;
  2. 更易讀的代碼约巷,函數(shù)參數(shù)左冬、返回值一目了然。比較下面兩個函數(shù):
// 額外的callback參數(shù)讓人對函數(shù)的輸入和輸出類型感到困惑
function asyncFn(argu: number, callback): void {
  let value: string = '';
   ...
   callback(err, value)
}

function asyncFn(argu: number): Promise<string> {
  return new Promise((resolve, reject) => {
    let value: string = '';
    ...
    if (err) {
      reject(err)
    }

    resolve(value)
  })
}
  1. 更容易地處理異步錯誤;

通過嘗試實(shí)現(xiàn)Promise沪饺,可以對Promise的行為有更深的理解者甲。
實(shí)現(xiàn)Promise先從閱讀規(guī)范開始怜姿。

規(guī)范解讀

Promise規(guī)范由3個部分組成:

  • Promise狀態(tài)
  • then方法
  • Promise Resolution Procedure
    下面依次對這3部分進(jìn)行解讀慎冤,其中忽略了異常處理部分和一些細(xì)節(jié)。

Promise狀態(tài)

  • promise的狀態(tài)必為pending沧卢、fulfilledrejected這三個狀態(tài)中的一個蚁堤。
  • 當(dāng)promisepending狀態(tài)時(shí),可能會轉(zhuǎn)變?yōu)?code>fulfilled狀態(tài)或rejected狀態(tài)但狭。
  • 當(dāng)promisefulfilled狀態(tài)時(shí)披诗,必須擁有一個value,并且不會再變化立磁。
  • 當(dāng)promiserejected狀態(tài)時(shí)呈队,必須擁有一個reason,并且不會再變化唱歧。
Promise 狀態(tài)

then方法

  • promise必須提供一個then方法宪摧,通過then方法可獲取最終的valuereason
  • then方法接收兩個參數(shù)颅崩,并返回一個promise
promise2 = promise1.then(onFulfilled?, onRejected?)
  • onFulfilledonRejected是可選參數(shù)几于。
  • 如果onFulfilled是一個函數(shù),它將僅在promise1變?yōu)?code>fulfilled狀態(tài)時(shí)被調(diào)用一次沿后,value是它的第一個參數(shù)沿彭。
  • 如果onRejected是一個函數(shù),它將僅在promise1變?yōu)?code>rejected狀態(tài)時(shí)被調(diào)用一次尖滚,reason是它的第一個參數(shù)喉刘。
  • 當(dāng)onFulfilled不是函數(shù),并且promise1fulfilled狀態(tài)時(shí)熔掺,promise2的狀態(tài)必須也是fulfilled饱搏,并且擁有和promise1一樣的value非剃。引用MDN的話說置逻,即,當(dāng)onFulfilled不是函數(shù)時(shí)备绽,會用identity function(返回它接收的參數(shù))替代券坞。
  • 當(dāng)onRejected不是函數(shù),并且promise1rejected狀態(tài)時(shí)肺素,promise2的狀態(tài)必須也是rejected恨锚,并且擁有和promise1一樣的reason。引用MDN的話說倍靡,即猴伶,當(dāng)onRejected不是函數(shù)時(shí),會用thrower function(拋出它接收的參數(shù))替代。
  • onFulfilledonRejected必須被異步調(diào)用他挎。以避免unleash Zalgo筝尾。也就是要保證onFulfilledonRejected始終是異步調(diào)用的,避免出現(xiàn)有時(shí)異步有時(shí)同步的情況办桨。比如下面這個例子筹淫,console.log始終會被異步執(zhí)行。
new Promise((resolve, reject) => {
  if (Math.random() >= 0.5) {
    setTimeout(() => resolve(0), 5000)
    return;
  }
  
  resolve(1)
}).then(console.log)
  • onFulfilledonRejected必須被當(dāng)作函數(shù)調(diào)用(沒有this)呢撞。
  • then方法可以在同一個promise上多次調(diào)用损姜。相應(yīng)的onFulfilled/onRejected被調(diào)用的順序和原本調(diào)用then方法的順序相同。
  • onFulfilledonRejected任一個拋出錯誤e殊霞,promise2會變成rejected狀態(tài)摧阅,并以錯誤e作為reason
  • onFulfilledonRejected任一個返回x绷蹲,promise2會執(zhí)行Promise Resolution過程:[[Resolve]](promise2, x)逸尖。

Promise Resolution過程

Promise Resolution過程即promise.resolve(x)的過程,規(guī)范中標(biāo)記為[[Resolve]](promise, x)瘸右。
首先這里涉及一個概念:thenable娇跟,如果xobject或者function類型,并且有then方法太颤,那么x就是thenable苞俘,顯然,promise對象是thenable龄章。
如果x不是thenable吃谣,Promise Resolution過程就是將promise變?yōu)?code>fulfilled狀態(tài),并以x作為fulfilled value做裙。
如果xthenable岗憋,promise會嘗試采用x的狀態(tài)。即锚贱,xpending狀態(tài)時(shí)仔戈,promise也是pending狀態(tài);如果x變成fulfilled狀態(tài)拧廊,promise也變成fulfilled狀態(tài)监徘,并用xfulfilled value作為promisefulfilled value;如果x變成rejected狀態(tài)吧碾,promise也變成rejected狀態(tài)凰盔,并用xrejected reason作為promiserejected reason
因此倦春,會存在thenable chain的情況:

thenable chain

thenable chain的長度不會被限制户敬,可以鏈任意多的thenable落剪。
但是,考慮到[[Resolve]](promise1, promise1)會導(dǎo)致無限循環(huán)尿庐,所以這種情況下應(yīng)該拋出TypeError著榴。如:

chaning cycle.png

以下3種場景都會執(zhí)行[[Resolve]](promise, x)過程

// 1.
promise.resolve(x);

// 2.
promise = new Promise(function(resolve, reject) {
  resolve(x);
})

// 3.
promise = promise1.then(function() {
  return x;
})

實(shí)現(xiàn)

為了便于理解,將promise實(shí)現(xiàn)拆分成若干步驟屁倔,逐步實(shí)現(xiàn)脑又。

狀態(tài)機(jī)

由于Promise本身是一個狀態(tài)機(jī),所以從這里開始锐借。Promise初始狀態(tài)是pending问麸,在fulfillreject時(shí),更新狀態(tài)钞翔。

function Promise() {
  var value, reason, state = 'pending';
  
  function beFulfilled(result) {
    state = 'fulfilled';
    value = result;
  }

  function beRejected(error) {
    state = 'rejected';
    reason = error;
  }
}

Promise Resolution過程

Promise Resolution Procedure是一個遞歸的過程严卖,直至所有thenable都完成。

function Promise(fn) {
  var value, reason, state = 'pending';
  
  function beFulfilled(result) {
    state = 'fulfilled';
    value = result;
  }

  function beRejected(error) {
    state = 'rejected';
    reason = error;
  }


  function doResolution(x) {
    var type = typeof x
    if ((type === 'object' || type === 'function') && typeof x.then === 'function') {
      x.then(function(val) {
        doResolution(val);
      }, function(err) {
        beRejected(err)
      })
    }

    beFulfilled(x)
  }

  fn(doResolution, beRejected)
}

then方法onFulfilled/onRejected執(zhí)行

then方法可能在fulfilled/rejected之前或者之后被調(diào)用布轿,也可以被多次調(diào)用哮笆。如果調(diào)用then時(shí),promise還處于pending狀態(tài)汰扭,應(yīng)該先將onFulfilled/onRejected暫存起來稠肘。在promise變?yōu)?code>fulfilled/rejected之后,依次執(zhí)行暫存的onFulfilled/onRejected萝毛。

function Promise(fn) {
  var value,
      reason,
      state = 'pending',
      handlers = [];
  
  function beFulfilled(result) {
    state = 'fulfilled';
    value = result;
    handlers.forEach(handle);
    handlers = [];
  }

  function beRejected(error) {
    state = 'rejected';
    reason = error;
    handlers.forEach(handle);
    handlers = [];
  }

  function doResolution(x) {
    var type = typeof x
    if ((type === 'object' || type === 'function') && typeof x.then === 'function') {
      x.then(function(val) {
        doResolution(val);
      }, function(err) {
        beRejected(err)
      })
    }

    beFulfilled(x)
  }

  function handle(handler) {
    if (state === 'pending') {
      handlers.push(handler);
      return;
    } else if (state === 'fulfilled') {
      handler.onFulfilled.call(null, value)
    } else if (state === 'rejected') {
      handler.onRejected.call(null, reason)
    }
  }

  this.then = function(onFulfilled, onRejected) {
    handle({
       onFulfilled,
       onRejected,
    });
  }

  fn(doResolution, beRejected)
}

then方法返回promise

then方法需要返回一個promise项阴,返回的promise依賴onFulfilled/onRejected執(zhí)行結(jié)果,所以將返回的promiseresolve/rejectthen方法的onFulfilled/onRejected保存在一起笆包,在onFulfilled/onRejected執(zhí)行后調(diào)用resolve/reject环揽。

function Promise(fn) {
  var value,
      reason,
      state = 'pending',
      handlers = [];
  
  function beFulfilled(result) {
    state = 'fulfilled';
    value = result;
    handlers.forEach(handle);
    handlers = [];
  }

  function beRejected(error) {
    state = 'rejected';
    reason = error;
    handlers.forEach(handle);
    handlers = [];
  }

  function doResolution(x) {
    var type = typeof x
    if ((type === 'object' || type === 'function') && typeof x.then === 'function') {
      x.then(function(val) {
        doResolution(val);
      }, function(err) {
        beRejected(err)
      })
    }

    beFulfilled(x)
  }

  function handle(handler) {
    if (state === 'pending') {
      handlers.push(handler);
      return;
    } else if (state === 'fulfilled') {
      try {
        handler.resolve(handler.onFulfilled.call(null, value))
      } catch(e) {
        handler.reject(e)
      }
    } else if (state === 'rejected') {
      try {
         handler.resolve(handler.onRejected.call(null, reason))
      } catch(e) {
         handler.reject(e);
      }
    }
  }

  this.then = function(onFulfilled, onRejected) {
    return new Promise(function(resolve, reject) {
      handle({
         onFulfilled,
         onRejected,
         resolve,
         reject,
      });
    })
  }
  fn(doResolution, beRejected)
}

至此,基本實(shí)現(xiàn)了promise庵佣,最后歉胶,補(bǔ)充完整錯誤處理和其他細(xì)節(jié),代碼如下:

function Promise(fn) {
  var value,
      reason,
      state = 'pending',
      handlers = [],
      /**
       * 當(dāng)resolve/reject被多次調(diào)用時(shí)巴粪,只有第一次調(diào)用有效通今。
       * 如:
       * new Promise((resolve, reject) => {
       *   resolve(new Promise(r => setTimeout(() => r(1), 5000)))
       *   resolve(new Promise(r => setTimeout(() => r(2), 3000)))
       * }).then(console.log)
       **/
      invoked = false,
      self = this; 

  // 考慮typeof null === 'object',所以判斷類型是否為object或function验毡,不能簡單通過typeof判斷
  function typeOf(obj) {
    return Object.prototype.toString.call(obj).match(/^\[object\s+(\w+)\]$/)[1].toLowerCase();
  }

  function once(func) {
    return function() {
      if (invoked) return;
      invoked = true;
      func.apply(null, arguments);
    }
  }
  
  function beFulfilled(result) {
    state = 'fulfilled';
    value = result;
    handlers.forEach(handle);
    handlers = [];
  }

  function beRejected(error) {
    state = 'rejected';
    reason = error;
    handlers.forEach(handle);
    handlers = [];
  }

  function doResolution(x) {
    /**
     * 如果onFulfilled/onRejected被多次調(diào)用衡创,只有第一次調(diào)用有效。
     * 如:
     * new Promise((resolve, reject) => {
     *   resolve({
     *     then(onFulfilled, onRejected) {
     *       onFulfilled(new Promise(r => setTimeout(() => r(1), 5000)));
     *       onFulfilled(new Promise(r => setTimeout(() => r(2), 3000)));
     *     }
     *   })
     * }).then(console.log)
     */
    var called = false;
    if (self === x) {
      beRejected(new TypeError('Chaining cycle detected'));
      return;
    }
    var type = typeOf(x);

    if (type === 'object' || type === 'function') {
      try {
        var then = x.then;
        if (typeOf(then) === 'function') {
          try {
            then.call(x, function(val) {
              if (called) return;
              called = true;
              doResolution(val);
            }, function(err) {
              if (called) return;
              called = true;
              beRejected(err);
            })
          } catch(e) {
            if (called) return;
            called = true;
            beRejected(e);
          }
        } else {
          beFulfilled(x);
        }
      } catch(e) {
        beRejected(e);
      }
    } else {
      beFulfilled(x);
    }
  }

  function handle(handler) {
    if (state === 'pending') {
      handlers.push(handler);
      return;
    } else if (state === 'fulfilled') {
      var x, onFulfilled = typeOf(handler.onFulfilled) === 'function' ? handler.onFulfilled : function(v) {
        return v;
      };
      setTimeout(function() {
        try {
          x = onFulfilled(value);
        } catch(e) {
          handler.reject(e);
          return;
        }

        handler.resolve(x);
      });
    } else if (state === 'rejected') {
       var x, onRejected = typeOf(handler.onRejected) === 'function' ? handler.onRejected : function(r) {
         throw r;
       };
       setTimeout(function() {
         try {
           x = onRejected(reason);
         } catch(e) {
           handler.reject(e);
           return;
         }

         handler.resolve(x);
       });
    }
  }

  this.then = function(onFulfilled, onRejected) {
    return new Promise(function(resolve, reject) {
      handle({
         onFulfilled,
         onRejected,
         resolve,
         reject,
      });
    });
  };

  fn(once(doResolution), once(beRejected));
}

完整代碼已經(jīng)通過Promises/A+ Compliance Test Suite全部測試用例晶通。

// 測試文件,我將上面實(shí)現(xiàn)的Promise取名Qromise
const Qromise = require('../Qromise')

describe("Promises/A+ Tests", function () {
  require("promises-aplus-tests").mocha({
    resolved(value) {
      return new Qromise(resolve => resolve(value));
    },
    rejected(reason) {
      return new Qromise((...[, reject]) => reject(reason));
    },
    deferred() {
      const obj = {}

      obj.promise  = new Qromise((resolve, reject) => {
        obj.resolve = value => resolve(value);
        obj.reject = reason => reject(reason);
      })

      return obj
    },
  });
});
通過全部872個測試用例
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末哟玷,一起剝皮案震驚了整個濱河市狮辽,隨后出現(xiàn)的幾起案子一也,更是在濱河造成了極大的恐慌,老刑警劉巖喉脖,帶你破解...
    沈念sama閱讀 217,542評論 6 504
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件椰苟,死亡現(xiàn)場離奇詭異,居然都是意外死亡树叽,警方通過查閱死者的電腦和手機(jī)舆蝴,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,822評論 3 394
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來题诵,“玉大人洁仗,你說我怎么就攤上這事⌒远В” “怎么了赠潦?”我有些...
    開封第一講書人閱讀 163,912評論 0 354
  • 文/不壞的土叔 我叫張陵,是天一觀的道長草冈。 經(jīng)常有香客問我她奥,道長,這世上最難降的妖魔是什么怎棱? 我笑而不...
    開封第一講書人閱讀 58,449評論 1 293
  • 正文 為了忘掉前任哩俭,我火速辦了婚禮,結(jié)果婚禮上拳恋,老公的妹妹穿的比我還像新娘携茂。我一直安慰自己,他們只是感情好诅岩,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,500評論 6 392
  • 文/花漫 我一把揭開白布讳苦。 她就那樣靜靜地躺著,像睡著了一般吩谦。 火紅的嫁衣襯著肌膚如雪鸳谜。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 51,370評論 1 302
  • 那天式廷,我揣著相機(jī)與錄音咐扭,去河邊找鬼。 笑死滑废,一個胖子當(dāng)著我的面吹牛蝗肪,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播蠕趁,決...
    沈念sama閱讀 40,193評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼薛闪,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了俺陋?” 一聲冷哼從身側(cè)響起豁延,我...
    開封第一講書人閱讀 39,074評論 0 276
  • 序言:老撾萬榮一對情侶失蹤昙篙,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后诱咏,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體苔可,經(jīng)...
    沈念sama閱讀 45,505評論 1 314
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,722評論 3 335
  • 正文 我和宋清朗相戀三年袋狞,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了焚辅。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 39,841評論 1 348
  • 序言:一個原本活蹦亂跳的男人離奇死亡苟鸯,死狀恐怖同蜻,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情倔毙,我是刑警寧澤埃仪,帶...
    沈念sama閱讀 35,569評論 5 345
  • 正文 年R本政府宣布,位于F島的核電站陕赃,受9級特大地震影響卵蛉,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜么库,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,168評論 3 328
  • 文/蒙蒙 一傻丝、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧诉儒,春花似錦葡缰、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,783評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至温算,卻和暖如春怜校,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背注竿。 一陣腳步聲響...
    開封第一講書人閱讀 32,918評論 1 269
  • 我被黑心中介騙來泰國打工茄茁, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人巩割。 一個月前我還...
    沈念sama閱讀 47,962評論 2 370
  • 正文 我出身青樓裙顽,卻偏偏與公主長得像,于是被迫代替她去往敵國和親宣谈。 傳聞我的和親對象是個殘疾皇子愈犹,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,781評論 2 354

推薦閱讀更多精彩內(nèi)容