koa 源码解读

源码结构

|- application.js
|- context.js
|- request.js
|- response.js

context.js
context 是使用delegates将节点request和response对象封装到单个对象中,为编写 Web 应用程序和 API 提供了许多有用的方法。

delegate(proto, 'response')
  .method('attachment')
  .method('redirect')
  .method('remove')
  .method('vary')
  .method('has')
  .method('set')
  .method('append')
  .method('flushHeaders')
  .access('status')
  .access('message')
  .access('body')
  .access('length')
  .access('type')
  .access('lastModified')
  .access('etag')
  .getter('headerSent')
  .getter('writable');
// context 对象
koa-context, {
  inspect: [Function: inspect],
  toJSON: [Function: toJSON],
  assert: [Function: assert] {
    equal: [Function (anonymous)],
    notEqual: [Function (anonymous)],
    ok: [Function (anonymous)],
    strictEqual: [Function (anonymous)],
    notStrictEqual: [Function (anonymous)],
    deepEqual: [Function (anonymous)],
    notDeepEqual: [Function (anonymous)]
  },
  throw: [Function: throw],
  onerror: [Function: onerror],
  cookies: [Getter/Setter],
  attachment: [Function (anonymous)],
  redirect: [Function (anonymous)],
  remove: [Function (anonymous)],
  vary: [Function (anonymous)],
  has: [Function (anonymous)],
  set: [Function (anonymous)],
  append: [Function (anonymous)],
  flushHeaders: [Function (anonymous)],
  status: [Getter/Setter],
  message: [Getter/Setter],
  body: [Getter/Setter],
  length: [Getter/Setter],
  type: [Getter/Setter],
  lastModified: [Getter/Setter],
  etag: [Getter/Setter],
  headerSent: [Getter],
  writable: [Getter],
  ......
}

application.js
其中主要实现了uselisten方法。

  • 在 craeteServer 结束后,会触发 callback。
  • 在 cakllback 中调用 compose 将 middleware 传入进去。
  • 当监听到请求的时候,就会按照顺序执行 middleware。
class Application extends Emitter {
constructor(options){
   ...
  }
  listen(...args) {
    debug('listen');
    const server = http.createServer(this.callback());
    return server.listen(...args);
  }
/**
   * Return a request handler callback
   * for node's native http server.
   *
   * @return {Function}
   * @api public
   */

  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;
  }
}

编写自己的中间件并解析koa-static-server的实现原理

中间件是一个方法,且第一个参数是context,第二个参数是next
koa-static-server进行了参数处理和路径解析,然后调用koa-send的send方法。
koa-send根据路径使用fs.createReadStream(path)读出文件内容,并且setHeaders

// koa-static-server/index.js
const send = require("koa-send");
module.exports = function serve(opts) {
  // 解析路径
  let options = opts || {};
  const rootPath = normalize(options.rootPath ? options.rootPath + "/" : "/");
  options.root = resolve(options.rootDir || process.cwd());
  return async (ctx, next) => {
    let path = ctx.path;
    /* Serve folders as specified
        eg. for options:
        rootDir = 'web/static'
        rootPath = '/static'
    'web/static/file.txt' will be served as 'http://server/static/file.txt'
    */

    path = normalize(path.replace(rootPath, "/"));
    /* In case of error from koa-send try to serve the default static file
        eg. 404 error page or image that illustrates error
    */
    try {
      sent = await send(ctx, path, options);
    } catch (error) {
      if (!options.notFoundFile) {
        if (options.last) ctx.throw(404);
      } else {
        sent = await send(ctx, options.notFoundFile, options);
      }
    }

    if (sent && options.last) {
      return;
    } else {
      return next();
    }
  };
};

// koa-send/index.js
module.exports = async function send(ctx, path, opts = {}) {
  const setHeaders = opts.setHeaders;
  if (setHeaders && typeof setHeaders !== "function") {
    throw new TypeError("option setHeaders must be function");
  }
  const root = opts.root ? normalize(resolve(opts.root)) : "";
  path = resolvePath(root, path);
  // 检测文件是否存在,node官网不推荐使用该方式,推荐直接read/write,如果文件不存在就处理错误。
  // 检查文件是否存在而不操作它之后,推荐fs.access()。
  stats = await stat(path);
  if (setHeaders) setHeaders(ctx.res, path, stats);
  // 将文件内容返回
  ctx.set('Content-Length', stats.size)
  ctx.body = fs.createReadStream(path);
  return path;
};

koa-compose

执行步骤:

  • 执行第一个中间件,传入contextnext(通过 dispatch.bind(null, i + 1)获得,在中间件中执行next()函数,即执行了第二个中间件)
  • 执行第二个中间件时,如果方法体中没有执行next()方法,所以不会继续调用dispatch.bind(null, i + 1)方法
  • 执行第二个中间件时,如果方法体中执行next()方法,由于middlewareArray中只有两个中间件,所以执行fn = next,由于koa源码中执行的是fn(ctx).then(handleResponse).catch(onerror);,没有传入next,所以直接执行return Promise.resolve();
// koa 源码
const fn = compose(this.middleware);
fn(ctx).then(handleResponse).catch(onerror);
// koa-compose 源码
var middlewareArray = [
  function(context, next) {
    console.log(1);
    next();
    console.log(3);
  },
  function(context, next) {
    console.log(2);
  }
];
function compose(middleware) {
  // 此处的next 是执行完所有中间件之后执行的回调函数
  return function(context, next) {
    let index = -1;
    return dispatch(0);
    function dispatch(i) {
      // 如果在一个 middleware 中调用了 2 次 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);
      }
    }
  };
}

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

推荐阅读更多精彩内容