学习Promise

自己经常使用Promise,但是对其实现和标准一知半解。本文从标准和实现出发,探究下它到底干了什么。

定义

Promise是一种异步编程的解决方案,可以让我们脱离异步回调的噩梦。我们可以把它看做一个容器,里面存放着未来才会结束的事件(如 异步回调)的结果。

基本用法

下面是一个使用Promise进行ajax请求的例子:

var getJSON = function(url) {
  var promise = new Promise(function(resolve, reject){
    var client = new XMLHttpRequest();
    client.open("GET", url);
    client.onreadystatechange = handler;
    client.responseType = "json";
    client.setRequestHeader("Accept", "application/json");
    client.send();

    function handler() {
      if (this.readyState !== 4) {
        return;
      }
      if (this.status === 200) {
        resolve(this.response);
      } else {
        reject(new Error(this.statusText));
      }
    };
  });

  return promise;
};

getJSON("/posts.json").then(function(json) {
  console.log('Contents: ' + json);
}, function(error) {
  console.error('出错了', error);
});

getJson 方法返回一个Promise对象,通过then完成对请求结果的处理。

标准

Promise的标准可以参见:Promise标准,总结起来有以下几条:

  1. Promise有三种状态:pendingfulfilledrejectedpending是初始状态,Promise可以由pending 转成 fulfilled 或者 rejected 。当Promise不是pending 状态时,其状态不能进行改变,也就是说不可能由fulfilledrejected状态转成其它状态。
  2. Promise必须提供一个then方法。then有两个可选参数:resolvereject。只有当Promise进入fulfilled状态时才会执行resolve方法;同理进入rejected状态时才会执行reject方法。 then返回的是一个新的Promise对象,而不是this(原因:Promise进入非pending状态后,不能再改变状态!)。
  3. 不同Promise的实现可以相互调用。相互调用的准则见标准页面的2.3这一条。

实现

Promise的实现有很多:Es6、kriskowal/q等。我们尝试实现一个基本的Promise。

构造函数

定义一个Promise函数,参数为executor。定义初始状态为pending,同时提供两个函数resolvereject作为参数供executor函数调用:

function Promise(executor) {
  var self = this;

  // 初始状态
  self.status = 'pending';

  // Promise resolve时的回调函数集,在Promise结束之前有可能有多个回调添加到它上面
  self.onResolvedCallback = [];
  // Promise reject时的回调函数集,因为在Promise结束之前有可能有多个回调添加到它上面
  self.onRejectedCallback = [];

  // resolve
  function resolve(value) {
    // todo
  }

  // reject
  function reject(reason) {
    // todo 
  }

  // 考虑到执行executor的过程中有可能出错,所以用try/catch块给包起来,并且在出错后以catch到的值reject掉这个Promise
  try {
    executor(resolve, reject);
  } catch (reason) {
    reject(reason);
  }
}
resolve和reject函数

resolve函数执行时,会把Promise状态由pending 转成 fulfilledreject函数执行时,会把Promise状态由pending 转成 rejected。两个函数执行时,需要把加到Promise上的方法执行:

function Promise(executor) {
  // ...
  
  function resolve(value) {
    if (value instanceof Promise) {
        return value.then(resolve, reject)
    }
    setTimeout(function() { // 异步执行所有的回调函数
        if (self.status === 'pending') {
            self.status = 'resolved'
            self.data = value
            for (var i = 0; i < self.onResolvedCallback.length; i++) {
                self.onResolvedCallback[i](value)
            }
        }
    })
}

function reject(reason) {
    setTimeout(function() { // 异步执行所有的回调函数
        if (self.status === 'pending') {
            self.status = 'rejected'
            self.data = reason
            for (var i = 0; i < self.onRejectedCallback.length; i++) {
                self.onRejectedCallback[i](reason)
            }
        }
    })
}

  // ...
}
then函数

then 函数返回一个Promise对象,有两个参数:onResolvedonRejected。它根据当前Promise的状态分开进行处理:

  • 当前为resolved,直接调用onResolved
  • 当前为reject,直接调用onRejected
  • 当前为pending,并不能确定调用onResolved还是onRejected,只能等到Promise的状态确定后,才能确实如何处理。
// then函数
Promise.prototype.then = function(onResolved, onRejected) {
  var self = this;
  var promise2;

  // resolve函数 如果不定义采用空函数
  onResolved = typeof onResolved === 'function' ? onResolved : function(v) {
    return v
  }
  // reject函数 如果不定义采用空函数
  onRejected = typeof onRejected === 'function' ? onRejected : function(r) {
    throw r
  }

  // 分三个状态进行处理
  if (self.status === 'resolved') {
    // 如果promise1(此处即为this/self)的状态已经确定并且是resolved,我们调用onResolved
    // 因为考虑到有可能throw,所以我们将其包在try/catch块里
    return promise2 = new Promise(function(resolve, reject) {
      try {
        var x = onResolved(self.data)
        if (x instanceof Promise) { // 如果onResolved的返回值是一个Promise对象,直接取它的结果做为promise2的结果
          x.then(resolve, reject)
        }
        resolve(x) // 否则,以它的返回值做为promise2的结果
      } catch (e) {
        reject(e) // 如果出错,以捕获到的错误做为promise2的结果
      }
    })
  }

  // 此处与前一个if块的逻辑几乎相同,区别在于所调用的是onRejected函数,就不再做过多解释
  if (self.status === 'rejected') {
    return promise2 = new Promise(function(resolve, reject) {
      try {
        var x = onRejected(self.data)
        if (x instanceof Promise) {
          x.then(resolve, reject)
        }
      } catch (e) {
        reject(e)
      }
    })
  }

  if (self.status === 'pending') {
  // 如果当前的Promise还处于pending状态,我们并不能确定调用onResolved还是onRejected,
  // 只能等到Promise的状态确定后,才能确实如何处理。
  // 所以我们需要把我们的**两种情况**的处理逻辑做为callback放入promise1(此处即this/self)的回调数组里
  // 逻辑本身跟第一个if块内的几乎一致,此处不做过多解释
    return promise2 = new Promise(function(resolve, reject) {
      self.onResolvedCallback.push(function(value) {
        try {
          var x = onResolved(self.data)
          if (x instanceof Promise) {
            x.then(resolve, reject)
          }
        } catch (e) {
          reject(e)
        }
      })

      self.onRejectedCallback.push(function(reason) {
        try {
          var x = onRejected(self.data)
          if (x instanceof Promise) {
            x.then(resolve, reject)
          }
        } catch (e) {
          reject(e)
        }
      })
    })
  }
}
不同Promise的调用

这个部分参考协议,具体实现如下:

function resolvePromise(promise2, x, resolve, reject) {
  var then
  var thenCalledOrThrow = false

  if (promise2 === x) {
    return reject(new TypeError('Chaining cycle detected for promise!'))
  }

  if (x instanceof Promise) {
    if (x.status === 'pending') { //because x could resolved by a Promise Object
      x.then(function(v) {
        resolvePromise(promise2, v, resolve, reject)
      }, reject)
    } else { //but if it is resolved, it will never resolved by a Promise Object but a static value;
      x.then(resolve, reject)
    }
    return
  }

  if ((x !== null) && ((typeof x === 'object') || (typeof x === 'function'))) {
    try {
      then = x.then //because x.then could be a getter
      if (typeof then === 'function') {
        then.call(x, function rs(y) {
          if (thenCalledOrThrow) return
          thenCalledOrThrow = true
          return resolvePromise(promise2, y, resolve, reject)
        }, function rj(r) {
          if (thenCalledOrThrow) return
          thenCalledOrThrow = true
          return reject(r)
        })
      } else {
        resolve(x)
      }
    } catch (e) {
      if (thenCalledOrThrow) return
      thenCalledOrThrow = true
      return reject(e)
    }
  } else {
    resolve(x)
  }
}

扩展

现行的Promise都进行了扩展,如引入了catchcancelstop等方法。它们的实现也比较简单,基于这个进行展开:

Promise.prototype.catch = function(onRejected) {
  return this.then(null, onRejected)
}
Promise.cancel = Promise.stop = function() {
    return new Promise(function() {}) 
}

总结

在参考文章2里作者举出了三个问题,具体可以查阅问题,在此罗列下:

  1. 性能问题:由于setTimeout的执行时间间隔(4ms),如果Promise过长,会影响执行快慢
  2. 停止一个Promise链:可以返回一个空的Promise,维持在pending状态;但这样会造成垃圾不会回收。
  new Promise(function(resolve, reject) { 
  resolve(42) 
}).then(function(value) { 
  // "Big ERROR!!!" 
  return new Promise(function(){}) 
})
  1. Promise链上最后一个then出错:现行的框架采用引入done函数,也可以通过onRejectedCallback数组的长度判断是不是最后一个Promise。
Promise.prototype.done = function(){
return this.catch(function(e) { // 此处一定要确保这个函数不能再出错
  console.error(e)
})
}
function reject(reason) {
setTimeout(function() {
  if (self.status === 'pending') {
    self.status = 'rejected'
    self.data = reason
    if (self.onRejectedCallback.length === 0) {
      console.error(reason)
    }
    for (var i = 0; i < self.rejectedFn.length; i++) {
      self.rejectedFn[i](reason)
    }
  }
})
}
参考

Promise标准
剖析Promise内部结构,一步一步实现一个完整的、能通过所有Test case的Promise类
Speed up your Websites with a Faster setTimeout using soon()

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,911评论 5 460
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 82,014评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 142,129评论 0 320
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,283评论 1 264
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,159评论 4 357
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,161评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,565评论 3 382
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,251评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,531评论 1 292
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,619评论 2 310
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,383评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,255评论 3 313
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,624评论 3 299
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,916评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,199评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,553评论 2 342
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,756评论 2 335

推荐阅读更多精彩内容

  • 本文适用的读者 本文写给有一定Promise使用经验的人,如果你还没有使用过Promise,这篇文章可能不适合你,...
    HZ充电大喵阅读 7,285评论 6 19
  • //本文内容起初摘抄于 阮一峰 作者的译文,用于记录和学习,建议观者移步于原文 概念: 所谓的Promise,...
    曾经过往阅读 1,220评论 0 7
  • Promiese 简单说就是一个容器,里面保存着某个未来才会结束的事件(通常是一个异步操作)的结果,语法上说,Pr...
    雨飞飞雨阅读 3,347评论 0 19
  • 00、前言Promise 是异步编程的一种解决方案,比传统的解决方案——回调函数和事件——更合理和更强大。它由社区...
    夜幕小草阅读 2,120评论 0 12
  • 母亲节这个特殊的日子,总能打开记忆的闸门。母亲在世时,生活中的点点滴滴清晰浮现。母亲一生善良也有点多愁善感。特殊...
    林恬芸阅读 783评论 9 5