koa源码

zp1996

写在前面

本文将会大家来看下koa的源码,当然本文需要大家了解koa的中间件机制,如果大家之前没有了解过其实现原理,可以关注下这篇文章
koa的源码非常的精简,与express不同,koa只是为开发者搭起了一个架子,没有任何的功能,包括路由,全部由中间件实现;下面就来看下koa的实现:

koa

创建应用时,一般都会利用app.listen指定一个端口号,这个方法的本质就是http.createServer

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

最为关键的就是这个callback的实现:

clipboard.png

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

    if (!this.listeners('error').length) this.on('error', this.onerror);

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

    return handleRequest;
}

需要注意下面几点:

  • onFinished(res, onerror),应对的是返回的bodyStream的情况,为其添加一个finished事件。

  • respond()根据ctxstatus,body,method来决定如何响应这次请求:

    • status204,304,不需要有响应体,res.end()就好

    • methodHEADHEAD的意义是不请求资源内容但是需要了解资源情况,所以只需要请求头,指定了资源lengthres.end()就好

    • 加入body为空,则bodystatuses包中status对应的文字描述,如404 => Not Found

context对象

koarequest对象response封装成了一个对象,提供了一些别名,具体可以参见context对象,例如:当访问ctx.url实则是访问的ctx.request.url。具体的实现利用了tj写的delegates这个npm包来对context对象添加属性,koa中利用了其中三个api:

  • method:添加方法引用

  • getter:利用__defineGetter__,添加getter属性

  • access:添加gettersetter

对于context创建的代码:

  createContext(req, res) {
    const context = Object.create(this.context);
    const request = context.request = Object.create(this.request);
    const response = context.response = Object.create(this.response);
    context.app = request.app = response.app = this;
    context.req = request.req = response.req = req;
    context.res = request.res = response.res = res;
    request.ctx = response.ctx = context;
    request.response = response;
    response.request = request;
    context.originalUrl = request.originalUrl = req.url;
    context.cookies = new Cookies(req, res, {
      keys: this.keys,
      secure: request.secure
    });
    request.ip = request.ips[0] || req.socket.remoteAddress || '';
    context.accept = request.accept = accepts(req);
    context.state = {};
    return context;
  }

函数的参数req, res为node本身的对象,requestresponse分别是对于reqres的封装,读取ctx.url的过程如下:

clipboard.png

context就是一个顶层对象,koa中,所有的属性和操作基本会基于这个对象,这个对象的组成如下图:

clipboard.png

写在最后

个人感觉koa就像是一个架子,提供了基础的方法和属性,如ctx.redirect等,具体的功能主要利用中间件来实现,与express相比,koa去除内置路由,views等,变得更加的轻量;当然我认为更加重要的是避免了层层回调的出现。以上内容如有出错,欢迎大家指出。

阅读 2.6k

zp的笔记
一些个人笔记

coder

3.2k 声望
48 粉丝
0 条评论

coder

3.2k 声望
48 粉丝
宣传栏