「JavaScript学习笔记」 实现一个Promise

之前曾翻译过Promises/A+文档,但当时仅对文档文本内容有所了解,而实际的Promise实现仍一知半解。最近看到工业聚老师的《100 行代码实现 Promises/A+ 规范》 - 知乎,对Promise的规范有了新的理解。以下是参照前文的一个实现,主要是记录自己对Promise的理解。参考注释:

const PENDING = 'pending'
const FULFILLED = 'fulfilled'
const REJECTED = 'rejected'

// 公共方法
const isObject = (obj) => !!(obj && typeof obj === 'object')
const isFunction = (fn) => typeof fn === 'function'
const isPromise = (promise) => promise instanceof Promise
const isThenable = (obj) => (isFunction(obj) || isObject(obj)) && 'then' in obj
// 1.1 一个thenable是一个函数或者对象,同时有then方法
const isIterable = (obj) => {
  if (obj == null) {
    return false
  }
  return typeof obj[Symbol.iterator] === 'function'
}


class Promise {
  constructor(f) {
    this.state = PENDING
    this.result = null
    this.callbacks = []

    const onFulfilled = (value) => transition(this, FULFILLED, value)
    const onRejected = (reason) => transition(this, REJECTED, reason)

    // 是否状态已变化 flag
    let ignore = false

    const resolve = (value) => {
      if (ignore) return
      ignore = true
      resolvePromise(this, value, onFulfilled, onRejected)
    }

    const reject = (reason) => {
      if (ignore) return
      ignore = true
      onRejected(reason)
    }
    
    // 如果执行new Promise时出错,则将错误传给reject
    try {
      f(resolve, reject)
    } catch (error) {
      reject(error)
    }
  }

  then(onFulfilled, onRejected) {
    // 2.2.7 必须返回一个Promise
    return new Promise((resolve, reject) => {
      const callback = { onFulfilled, onRejected, resolve, reject }
      // 判断注册时,当前promise的状态
      if (this.state === PENDING) {
        this.callbacks.push(callback)
      } else {
        //  如果不是pending,则异步执行掉它  3.1 
        setTimeout(() => handleCallback(callback, this.state, this.result), 0)
        // handleCallback拿到的resolve,reject都是属于then方法返回的promise,我们将它记为promise2
      }
    })
  }

  // 规范内没有的, ES6的部分实现
  catch(onRejected) {
    return this.then(null, onRejected)
  }
  static resolve(value) {
    return new Promise((resolve) => resolve(value))
  }
  static reject(reason) {
    return new Promise((_, reject) => reject(reason))
  }
  
  static all(promises) {
    if (!isIterable(promises)) {
      throw new TypeError('params is not iterable')
    }
    const results = []
    let count = 0
    let done = false

    return new Promise((resolve, reject) => {
      for (const p of promises) {
        const i = count++ // 同步遍历所有迭代器内容
        Promise.resolve(p).then(
          (result) => {
            if (done) return
            results[i] = result
            count-- // resolve 就减少一个count
            if (count === 0 ) {
              resolve(results)
            }
          },
          (error) => {
            if (done) return
            done = true
            reject(error)
          }
        )
      }
      // 如果传入的迭代器成员为空,则直接返回迭代器本身
      if (count === 0) { resolve(promises) }
    })
  }

  static race(promises) {
    if (!isIterable(promises)) {
      throw new TypeError('params is not iterable')
    }

    let done = false

    return new Promise((resolve, reject) => {
      for (const p of promises) {
        count++
        Promise.resolve(p).then((result) => {
          if (done) return
          done = true
          resolve(result)
        }, (error) => {
          if (done) return
          done = true
          reject(error)
        })
      }
    })
  }
}

// promise状态迁移公共方法
const transition = (promise, state, result) => {
  if (promise.state !== PENDING) return
  promise.state = state
  promise.result = result
  // 异步将所有callbacks执行掉
  setTimeout(() => {
    // resolve时,处理掉所有注册的任务
    while (callbacks.length) handleCallback(callbacks.shift(), state, result)
  }), 0)
}

// 执行then方法注册onFulfilled或处理错误
const handleCallback = (callback, state, result) => {
  const { onFulfilled, onRejected, resolve, reject } = callback // resolve, reject 是 then返回的Promise注册的方法
  try {
    // isFunction: 2.2.1 不是函数则忽略
    if (state === FULFILLED) {
      // 2.2.7
      isFunction(onFulfilled) ? resolve(onFulfilled(result)) : resolve(result)
    } else if (state === REJECTED) {
      isFunction(onRejected) ? resolve(onRejected(result)) : reject(result)
    }
  } catch (error) {
    reject(error)
  }
}

// 2.3 Promise Resolution Procedure 提供互通性
// onFulfilled的返回值 x 如果也是一个符合规范的 promise对象(thenable),
const resolvePromise = (promise, x, resolve, reject) => {
  // 2.3.1
  if (x === promise) {
    const reason = new TypeError('Can not fufill promise with itself')
    return reject(reason)
  }

  // 2.3.2 
  // 当resolve一个x时,需要等待x的状态结束,再resolve promise自身
  // 即,检查resolve的value 是否是promise,如果是,则通过then方法注册,将 promise的状态迁移注册给 x 的then方法,等待x的fulfilled
  if (isPromise(x)) {
    return x.then(resolve, reject)
  }
  // 检查x是否为thenable对象,如果是,则表示它可以尝试让当前实现的Promise处理
  // 通过这种方式接受其他符合A+规范的的Promise实现(实现了then方法的Promise)
  if (isThenable(x)) {
    try {
      const then = x.then
      if (isFunction(then)) {
        // 当x有then方法,表示它是一个兼容的Promise实现
        // 这里创建一个新的Promise,将x的then传入,并且then原来的resolve
        // 执行另一个异步流程,也就是说等待x的状态最终为fufilled/rejected执行原来的resolve/reject
        // 实现了对其他Promise实现的兼容
        return new Promise(then.bind(x)).then(resolve, reject)
      }
    } catch (error) {
      return reject(error)
    }
  }
  
  // 如果都不是,则resolve掉这个值
  resolve(x)
}

除了基本实现,工业聚老师的文章还提到一些关于callback style async的内容,十分受用,这里就不展开来说,原文非常精彩,建议去看一下。

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

推荐阅读更多精彩内容