浅谈Koa的实现和原理

前言

koa被认为是第二代node web framework，它最大的特点就是独特的中间件流程控制，是一个典型的洋葱模型。koa和koa2中间件的思路是一样的，但是实现方式有所区别，koa2在node7.6之后更是可以直接用 async 来替代 generator 使用中间件，本文以最后一种情况举例。

级联

级联就是对象之间的映射关系。映射关系就是一对一、一对多、多对多这类映射关系。

Koa 中间件以更加传统的方式级联，回调的方式进行级联？使用 async 功能，Koa 可以调用“下游”， 然后控制回流“上游”。当碰到 next() 函数的时候，正在执行的函数将停止并控制传递给定义的下一个中间件。当在下游没有更多的中间件时，将会返回到上一个中间件执行剩下的代码。

洋葱模型

在koa是如何体现洋葱模型的，我们可以假设在碰到 next() 函数之前都是为 Request 阶段，而每个中间件都是重复着这一个过程，到最后没有 next() 函数可以执行之后，函数将会返回，无论返回的值是什么。然后，koa 将进入 Response 环节，知道返回第一个中间件，结束此次洋葱模型操作。

use 方法

下面就是使用 use 函数的示例， ctx 表示上下文（context），该对象封装了一个传入的 http 消息，并对该消息进行了相应的响应。next 表示着执行的中间件，如果执行 next 方法将会进入到下一个中间件的阶段。use 只接受中间件一个参数，中间件就是一个函数，这个函数值接受两个参数（ctx（上下文）， next（下游的中间件））

// 引入 koaconst Koa = require('koa');// 生产 koa 实例const app = new Koa();app.use((ctx, next) => {console.log(1);next();console.log(2);})

那么如果有多个 use 的方法我们是如何确保每个中间件是按顺序执行的，这里我们就要讲到 compose方法。

Koa 的上下文挂载了一个 Response 对象，其作为 response 的值。Koa 的 Response 对象提供了用于处理 http 响应的方法，该响应委托给了 ServerResponse 类。

以下是参考文档的一个示例

app.use(async (ctx, next) => {

  await next();

  ctx.response.type = 'xml';

  ctx.response.body = fs.createReadStream('really_large.xml');

});

Koa 的实现

class MyKoa {constructor() {// 我们存放中间件的地方this.middleware = []}// use 方法，主要的作用是把中间件放入 middleware 数组内部。use(fn) {}// compose 方法参数为一个 中间件的数组， 返回一个有关中间件调用的参数。compose(middleware) {}// 监听listen(port) {http.createServer();return server}// 回调callback() {// 我们在这里运行 compose，但是实际上这里还需要将 compose 返回的方法传给 handleRequest 方法，再交给 respond 去处理 ctx 上下文创建 response。这里我们就不过于详细的讲解。this.compose(this.middleware);}}

上文提及到如何实现每个中间件按照顺序执行，这里可以简单的实现一个 Koa。首先我们需要实现自己创建一个 MyKoa 的类，里面需要有相关的属性和方法，我们先搭好框架(写好大概的代码进行一个解释)，在进行代码的编写。

use方法的实现

use方法的相对简单，只需要判断以下传进来的参数是否为方法，然后再决定是否要把参数放入middleware数组中存储。

use(fn) {// 如果 fn 不是方法则发出一个错误if(!(fn instanceof Function)) throw('fn must be a function');// 将 fn 导入中间件中。this.middleware.push(fn);}

compose 方法的实现

compose(middleware) {if(!Array.isArray(middleware)) throw('middleware must be a Array');for(let fn of middleware) {if(!(fn instanceof Function)) throw('fn must be a function');}return function (context, next) {let index = -1;return dispatch(0)function dispatch(i) {let fn = null;if(i <= index) Promise.resolve(new Error('next() called multiple times'));fn = middleware[i];if(i === middleware.length) fn = nextif(!(fn instanceof Function)) return Promise.resolve();try {return Promise.resolve(fn(context, dispatch.bind(null, i + 1)))} catch (error) {return Promise.reject(error)}}}

compose 方法主要就是判断你的中间件集合是不是一个数组、数组内部存储的是否是函数，最后返回一个方法，我们通过调用 compose 返回的方法就可以按照洋葱模型的方式来执行中间件了。

callback 方法的实现

callback 我这里写的就相对简单了，如果向了解更多可以下载koa，然后再下面这个文件内可以看到源码

koa\lib\application.js

// 回调callback() {// 我们在这里运行 compose，但是实际上这里还需要将 compose 返回的方法传给 handleRequest 方法，再交给 respond 去处理 ctx 上下文创建 response。这里我们就不过于详细的讲解。let fnMiddleware = this.compose(this.middleware)fnMiddleware({}, null)}

listen 方法的实现

listen 方法就相对简单点只要调用 callback 函数，然后通过http创建一个服务，返回这个服务即可。

// 监听listen(port) {const server = http.createServer(this.callback())return server.listen(port);}

整体代码

class MyKoa {constructor() {// 我们存放中间件的地方this.middleware = []}// use 方法，主要的作用是把中间件放入 middleware 数组内部。use(fn) {// 如果 fn 不是方法则发出一个错误if(!(fn instanceof Function)) throw('fn must be a function');// 将 fn 导入中间件中。this.middleware.push(fn);}// compose 方法参数为一个 中间件的数组， 返回一个有关中间件调用的参数。compose(middleware) {if(!Array.isArray(middleware)) throw('middleware must be a Array');for(let fn of middleware) {if(!(fn instanceof Function)) throw('fn must be a function');}return function (context, next) {let index = -1;return dispatch(0)// 为何我们不直接调用 next 方法而需要对其再进行一步封装，我个人认为：第一、更加方便理解。第二、方便对代码的修正，或者提高代码的健壮性，里面可以添加大量的判断，但是又不影响代码的美观。如果有读者有思考请再下方留言和我分享分享。function dispatch(i) {let fn = null;if(i <= index) Promise.resolve(new Error('next() called multiple times'));fn = middleware[i];if(i === middleware.length) fn = nextif(!(fn instanceof Function)) return Promise.resolve();try {return Promise.resolve(fn(context, dispatch.bind(null, i + 1)))} catch (error) {return Promise.reject(error)}}}}// 监听listen(port) {const server = http.createServer(this.callback())return server.listen(port);}// 回调callback() {// 我们在这里运行 compose，但是实际上这里还需要将 compose 返回的方法传给 handleRequest 方法，再交给 respond 去处理 ctx 上下文创建 response。这里我们就不过于详细的讲解。let fnMiddleware = this.compose(this.middleware)fnMiddleware({}, null)}}

总结

Koa 还有许多有用的代码，例如 createContext、handleRequest、handleResponse等代码对如何处理request和如何构建response。我个人认为 createContext 创建上下文的代码也很值得一看，那种挂载方式很独特。

最后，每天写一篇文章，每天进一小步。