Loading...
墨滴

NuoHui

2021/04/13  阅读:38  主题:默认主题

每天一个npm包:koa-compose

koa-compose这个包相信koa2开发者不会陌生,我们简单说说它的用途,它用于负责调度Koa2中中间件的执行顺序,接收多个中间件函数,然后包装为一个大的中间件函数,依次调用这个大中间件函数,你就可以依次执行你添加的中间件函数,执行相应逻辑任务。

对Koa2中代码感兴趣的可以看koa-compose使用。

use(fn) {
    if (typeof fn !== 'function'throw new TypeError('middleware must be a function!');
    if (isGeneratorFunction(fn)) {
      deprecate('Support for generators will be removed in v3. ' +
                'See the documentation for examples of how to convert old middleware ' +
                'https://github.com/koajs/koa/blob/master/docs/migration.md');
      fn = convert(fn);
    }
    debug('use %s', fn._name || fn.name || '-');
    this.middleware.push(fn);
    return this;
  }

callback() {
    const fn = compose(this.middleware);

    if (!this.listenerCount('error')) this.on('error'this.onerror);

    const handleRequest = (req, res) => {
      const ctx = this.createContext(req, res);
      return this.handleRequest(ctx, fn);
    };

    return handleRequest;
  }

  /**
   * Handle request in callback.
   *
   * @api private
   */


  handleRequest(ctx, fnMiddleware) {
    const res = ctx.res;
    res.statusCode = 404;
    const onerror = err => ctx.onerror(err);
    const handleResponse = () => respond(ctx);
    onFinished(res, onerror);
    return fnMiddleware(ctx).then(handleResponse).catch(onerror);
  }

listen(...args) {
    debug('listen');
    const server = http.createServer(this.callback());
    return server.listen(...args);
  }

简单解释下,我们启动Koa2 server时候,就会执行callback回调,这个里面就利用了koa-compose包装返回一个大的中间件函数,来自请求端的请求都会经过handleRequest方法。

fnMiddleware(ctx).then(handleResponse).catch(onerror);

开启请求处理流程。

源码

那么下面我们看下其源码简洁的实现。

'use strict'

/**
 * Expose compositor.
 */


module.exports = compose

/**
 * Compose `middleware` returning
 * a fully valid middleware comprised
 * of all those which are passed.
 *
 * @param {Array} middleware
 * @return {Function}
 * @api public
 */


function compose (middleware{
  // 写lib一定要记得对入参类型、边界等进行校验
  if (!Array.isArray(middleware)) throw new TypeError('Middleware stack must be an array!')
  for (const fn of middleware) {
    if (typeof fn !== 'function'throw new TypeError('Middleware must be composed of functions!')
  }

  /**
   * @param {Object} context
   * @return {Promise}
   * @api public
   */


  // 返回的包装函数中间件
  // context =》 ctx
  // next => 包装的promise中间件函数,第一次调用时候 next为undefined
  return function (context, next{
    // last called middleware #
    // 通过闭包用于记录中间件执行索引位置
    let index = -1
    // 从0开始
    return dispatch(0)
    function dispatch (i{
      // 锁
      if (i <= index) return Promise.reject(new Error('next() called multiple times'))
      index = i
      // fn 就是我们app.use()注册的中间件函数
      let fn = middleware[i]
      // 如果所有中间件执行完了 fn=next即为undefined
      if (i === middleware.length) fn = next
      // 注意所有的返回都是通过promise包装处理的
      // 所以我们如何要保证中间件处理顺序记得 await next()

      // 当fn为undefined时候,返回一个空的Promise,用于then回调
      if (!fn) return Promise.resolve()
      try {
        // dispatch.bind(null, i + 1)) 就是我们中间件中的next函数
        // 一旦你await next()调用就会进入下一个中间件控制权 实现了洋葱模型
        return Promise.resolve(fn(context, dispatch.bind(null, i + 1)));
      } catch (err) {
        // 异常处理
        return Promise.reject(err)
      }
    }
  }
}

代码短小精悍,设计的很精妙。

好了,今天就到这结束了,下期见。

ps:如果你对node也有兴趣,欢迎关注我公众号:xyz编程日记。

NuoHui

2021/04/13  阅读:38  主题:默认主题

作者介绍

NuoHui