Node.js Koa源码解析co@4.6版本源码解析

Posted 2021-04-25 StuQ

源码解析

co@4.6版本不到240行代码，整体来说，还算比较简单。但并不容易阅读

// 核心代码

function co(gen) {  // 缓存this  var ctx = this;  var args = slice.call(arguments, 1)  // we wrap everything in a promise to avoid promise chaining,  // which leads to memory leak errors.  // see https://github.com/tj/co/issues/180  // 重点，co的返回值是Promise对象。为什么可以then和catch的根源  return new Promise(function(resolve, reject) {    // 如果你懂Promise规范，就知道这是解决状态回调，这是首次调用    onFulfilled();    /**     * @param {Mixed} res     * @return {Promise}     * @api private     */    function onFulfilled(res) {      var ret;      try {        ret = gen.next(res);      } catch (e) {        return reject(e);      }      next(ret);    }    /**     * @param {Error} err     * @return {Promise}     * @api private     */    // 如果你懂Promise规范，就知道这是拒绝状态回调    function onRejected(err) {      var ret;      try {        ret = gen.throw(err);      } catch (e) {        return reject(e);      }      next(ret);    }    // generator执行器    // 如果ret.done，返回ret.value    // 否则，    function next(ret) {      // 如果执行完成，直接调用resolve把promise置为成功状态      if (ret.done) return resolve(ret.value);      // 把yield的值转换成promise      // 支持 promise，generator，generatorFunction，array，object      // toPromise的实现可以先不管，只要知道是转换成promise就行了      var value = toPromise.call(ctx, ret.value);      // 成功转换就可以直接给新的promise添加onFulfilled, onRejected。当新的promise状态变成结束态（成功或失败）。就会调用对应的回调。整个next链路就执行下去了。      // 为什么generator可以无限的next下去呢？      // return value.then(onFulfilled, onRejected);意味着，又要执行onFulfilled了      // onFulfilled里调用next(ret);      if (value && isPromise(value)) return value.then(onFulfilled, onRejected);            // 如果以上情况都没发生，报错      return onRejected(new TypeError('You may only yield a function, promise, generator, array, or object, '        + 'but the following object was passed: "' + String(ret.value) + '"'));    }  });
}

读此源码要点

• 必须深刻理解Promise实现，知道构造函数里的onFulfilled和onRejected是什么意思

• 必须了解generator的执行机制，理解迭代器里的next以及next的返回对象{value:’’,done: true}

核心代码入口是onFulfilled，无论如何第一次的next(ret)是一定要执行的，因为generator必须要next()一下的。

所以next(ret)一定是重点，而且我们看onFulfilled和onRejected里都调用它，也就是所有的逻辑都会丢在这个next(ret)方法里。它实际上是一个状态机的简单实现。

// generator执行器// 如果ret.done，返回ret.value
// 否则，继续递归
function next(ret) {  // 如果执行完成，直接调用resolve把promise置为成功状态  if (ret.done) return resolve(ret.value);  // 把yield的值转换成promise  // 支持 promise，generator，generatorFunction，array，object  // toPromise的实现可以先不管，只要知道是转换成promise就行了  var value = toPromise.call(ctx, ret.value);    // 成功转换就可以直接给新的promise添加onFulfilled, onRejected。当新的promise状态变成结束态（成功或失败）。就会调用对应的回调。整个next链路就执行下去了。  // 为什么generator可以无限的next下去呢？  // return value.then(onFulfilled, onRejected);意味着，又要执行onFulfilled了  // onFulfilled里调用next(ret);  if (value && isPromise(value)) return value.then(onFulfilled, onRejected);    // 如果以上情况都没发生，报错  return onRejected(new TypeError('You may only yield a function, promise, generator, array, or object, '    + 'but the following object was passed: "' + String(ret.value) + '"'));
}

情景1: 状态完成

  // 如果执行完成，直接调用resolve把promise置为成功状态  if (ret.done) return resolve(ret.value);

情景2： next，跳回onFulfilled，递归

  // 成功转换就可以直接给新的promise添加onFulfilled, onRejected。当新的promise状态变成结束态（成功或失败）。就会调用对应的回调。整个next链路就执行下去了。  // 为什么generator可以无限的next下去呢？  // return value.then(onFulfilled, onRejected);意味着，又要执行onFulfilled了  // onFulfilled里调用next(ret);  if (value && isPromise(value)) return value.then(onFulfilled, onRejected);  

情景3: 捕获异常

  // 如果以上情况都没发生，报错  return onRejected(new TypeError('You may only yield a function, promise, generator, array, or object, '    + 'but the following object was passed: "' + String(ret.value) + '"'));

以上是核心代码说明。之前我们讲了co实际有2种api，有参数和无参数的，很明显以上是无参数的generator执行器，那么有参数的wrap呢？

// 为有参数的generator调用，提供简单包装
co.wrap = function (fn) {  createPromise.__generatorFunction__ = fn;  return createPromise;  function createPromise() {    // 重点，把arguments给fn当参数。    // call和apply是常规js api    return co.call(this, fn.apply(this, arguments));  }
};

通过call和apply组合使用，知识点比较简单，但这样用还是挺巧妙的。

其他的就基本是工具类了，其实也挺有意思的，自己看吧

StuQ的推出《Nodejs微信开发》翻转课堂，课程深入浅出，通过Node.js和express框架，微信三大功能分享，授权，支付，以及h5+weui实践，给你一个不一样的实用技能。

想了解微信开发的课程详情可以扫描以下二维码

感兴趣的同学可点击“ 阅读原文”购买课程！