koa-源码学习及最简实现

一:简介

koa是基于nodejs平台的下一代web框架(官网描述)
官网地址:https://koa.bootcss.com/
git地址:https://github.com/koajs/koa.git
koa提供基于http服务的最简的框架模型,包括洋葱式的中间件处理逻辑、对请求和响应的封装等。

二:使用

const Koa = require('koa');

let koa = new Koa();

koa.use((ctx, next) => {
    console.log(ctx.request.url);
    ctx.body = { code: 200, success: true };
});

koa.listen(5000);
console.log('server listen 5000');

三:源码

源码的lib下共四个文件:application.js,context.js,request.js,response.js

3.1 application.js

application.js是暴露给外部的入口,关键代码:

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

use方法接收中间件(即函数),并将其放入middleware数组中;
return this,用于支持use的链式调用;

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

koa提供的服务,本质上是nodejs的http模块提供的。koa定义了自己的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;
  }

compose函数是koa-compose提供的,其作用是将多个中间件整理成一个中间件,在此中间件内部,原来的多个中间件的执行过程是洋葱式的;
createContext的作用是封装req,res为一个context对象,该对象经handleRequest函数传入每一个中间件;

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

当所有中间件执行完毕,调用handleResponse函数,来返回结果

3.2 context.js

包含createContext的返回对象相关的一些方法

3.3 request.js

基于http.createServer中callback内的参数 req,封装了一些方法

3.4 response.js

基于http.createServer中callback内的参数 res,封装了一些方法

四:最简实现

假设不考虑参数验错,req和res封装等,最简的类koa模型应该具备以下特征

  • 支持增加中间件
  • 中间件的执行流程为洋葱式
  • context传入每个中间件,以实现中间件间的数据共享
  • 具备处理各种事件的能力,如error事件
'use strict';

const Emitter = require('events');
const http = require('http');
const compose = require('koa-compose');

class SimpleKoa extends Emitter{
    constructor() {
        super();
        this.middleware = [];
    }

    use(fn) {
        this.middleware.push(fn);
        return this;
    }

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

    callback() {
        if (!this.listenrCount('error')) this.on('error', (error) => console.error(error));
        let fn = compose(this.middleware);
        const handleRequest = (req, res) => {
            let ctx = {
                req,
                res
            };
            return this.handleRequest(ctx, fn);
        }
        return handleRequest;
    }

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

推荐阅读更多精彩内容