koa

1
open
sqshada
sqshada
Posted 3 months ago

koa #25

主体流程

listen

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

使用 http.createServer 创建了服务,koa 内部自行实现 this.callback(),将回调放入 createServer

callback

  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
  }

callback 实现 handleRequest 方法,将 req,res 拼接成 ctx,交给 this.handleRequest 处理

createContext

将 req,res 拼接成 ctx

中间件机制

中间件注册

  use (fn) {
      // 限制传入的必须是函数,否则报错
      if (typeof fn !== 'function') throw new TypeError('middleware must be a function!')
      debug('use %s', fn._name || fn.name || '-')

      // 将函数push进middleware数组
      this.middleware.push(fn)

      // 返回自己,方便链式调用
      return this
    }

Application 实例维护一个 middleware 的数组,提供 use 方法注册中间件,也就是 push 到 middleware 数组中,依赖于数组进行实现。

洋葱模型

image

通过 use 会注册中间件,并且中间件也有顺序

const Koa = require('koa');

// 应用程序
const app = new Koa();

// 中间件1
app.use(async (ctx, next) => {
    console.log(1); // 第1步
    await next(); // 第2步
    console.log(2); // 第6步
});

// 中间件2
app.use(async (ctx, next) => {
    console.log(3); // 第3步
    await next(); // 第4步
    console.log(4); // 第5步
});

app.listen(8000, () => {
    console.log(`Server is starting`);
});


// 1 3 4 2

callback 方法中,通过 koa-compose,将中间价数组转化为一个 fn 的执行函数

const compose = require('koa-compose')
...

module.exports = class Application extends Emitter {
  ...
  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
  }
  
  handleRequest (ctx, fnMiddleware) {
    ...
    const onerror = err => ctx.onerror(err)
    const handleResponse = () => respond(ctx)
    ...
    return fnMiddleware(ctx).then(handleResponse).catch(onerror)
  }
}

然后通过 fnMiddleware(ctx).then(handleResponse).catch(onerror) 执行 里面的逻辑封装在 koa-compose 中,这也是最精华的部分

koa-compose


module.exports = compose

function compose (middleware) {
  // 校验必须是数组
  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!')
  }

  // 返回首个函数
  return function (context, next) {
    let index = -1
    return dispatch(0) // 执行第一个中间件,第一个执行完递归执行下一个
    function dispatch (i) {
      // 防止中间件中,多次调用next()
      if (i <= index) return Promise.reject(new Error('next() called multiple times'))
      index = i
      let fn = middleware[i]
      if (i === middleware.length) fn = next
      if (!fn) return Promise.resolve()
      try {
        return Promise.resolve(fn(context, dispatch.bind(null, i + 1)));
      } catch (err) {
        return Promise.reject(err)
      }
    }
  }
}

去掉类型判断和异常判断代码


module.exports = function compose (middleware) {
  return function (context, next) {
    let index = -1
    return dispatch(0) 
  
    function dispatch (i) {
      index = i
      let fn = middleware[i]
      if (i === middleware.length) fn = next
      if (!fn) return Promise.resolve()
      
      return Promise.resolve(fn(context, dispatch.bind(null, i + 1)));
    }
  }
}

最主要的思想在于 next 的时候去触发 dispatch

为什么一定要 Promise.resolve 包裹?为了适配 async/await

sqshada
sqshada
Created 3 months ago

模拟实现中间件

class Koa {
  constructor() {
    this.middleware = [];
  }
  use(fn) {
    this.middleware.push(fn);
    return this;
  }
  compose(middleware) {
    return (ctx, next) => {
      let index = -1;
      return dispatch(0);
      function dispatch(i) {
        //这里的i 是标识 我即将要去执行哪一个中间件  而 index 是标识 我上一次执行的是哪一个中间件
        //当 i <= index 时意味着我即将要去执行我已经执行过的中间件,这是违背洋葱模型的本质的,这时将会报错为 next 函数被调用执行多次
        if (i <= index)
          return Promise.reject(new Error("next() called multiple times"));
        index = i; // 更换辨识
        let fn = middleware[i];
        if (i === middleware.length) next = null;
        if (!fn) return Promise.resolve();
        return Promise.resolve(fn(ctx, dispatch.bind(null, i + 1)));
      }
    };
  }
  test() {
    const fn = this.compose(this.middleware);
    fn(1);
  }
}

const app = new Koa();
app.use(async (ctx, next) => {
  console.log(1);
  await next();
  console.log(2);
});

// 中间件2
app.use(async (ctx, next) => {
  console.log(3);
  await next();
  console.log(4);
});

app.test();