共计 6316 个字符,预计需要花费 16 分钟才能阅读完成。
置信用过 Koa、Redux 或 Express 的小伙伴对中间件都不会生疏,特地是在学习 Koa 的过程中,还会接触到 “洋葱模型”。
本文阿宝哥将跟大家一起来学习 Koa 的中间件,不过这里阿宝哥不打算一开始就亮出广为人知的 “洋葱模型图”,而是先来介绍一下 Koa 中的中间件是什么?
学习更多常识,能够拜访 ???? 阿宝哥 Github 个人主页
一、Koa 中间件
在 @types/koa-compose
包下的 index.d.ts
头文件中咱们找到了中间件类型的定义:
// @types/koa-compose/index.d.ts
declare namespace compose {type Middleware<T> = (context: T, next: Koa.Next) => any;
type ComposedMiddleware<T> = (context: T, next?: Koa.Next) => Promise<void>;
}
// @types/koa/index.d.ts => Koa.Next
type Next = () => Promise<any>;
通过观察 Middleware
类型的定义,咱们能够晓得在 Koa 中,中间件就是一般的函数,该函数接管两个参数:context
和 next
。其中 context
示意上下文对象,而 next
示意一个调用后返回 Promise 对象的函数对象。
理解完 Koa 的中间件是什么之后,咱们来介绍 Koa 中间件的外围,即 compose
函数:
function wait(ms) {return new Promise((resolve) => setTimeout(resolve, ms || 1));
}
const arr = [];
const stack = [];
// type Middleware<T> = (context: T, next: Koa.Next) => any;
stack.push(async (context, next) => {arr.push(1);
await wait(1);
await next();
await wait(1);
arr.push(6);
});
stack.push(async (context, next) => {arr.push(2);
await wait(1);
await next();
await wait(1);
arr.push(5);
});
stack.push(async (context, next) => {arr.push(3);
await wait(1);
await next();
await wait(1);
arr.push(4);
});
await compose(stack)({});
以上代码起源:https://github.com/koajs/comp…
对于以上的代码,咱们心愿执行完 compose(stack)({})
语句之后,数组 arr
的值为 [1, 2, 3, 4, 5, 6]
。这里咱们先不关怀 compose
函数是如何实现的。咱们来剖析一下,如果要求数组 arr
输入冀望的后果,上述 3 个中间件的执行流程:
1. 开始执行第 1 个中间件,往 arr 数组压入 1,此时 arr 数组的值为 [1]
,接下去期待 1 毫秒。为了保障 arr 数组的第 1 项为 2
,咱们须要在调用 next
函数之后,开始执行第 2 个中间件。
2. 开始执行第 2 个中间件,往 arr 数组压入 2,此时 arr 数组的值为 [1, 2]
,持续期待 1 毫秒。为了保障 arr 数组的第 2 项为 3
,咱们也须要在调用 next
函数之后,开始执行第 3 个中间件。
3. 开始执行第 3 个中间件,往 arr 数组压入 3,此时 arr 数组的值为 [1, 2, 3]
,持续期待 1 毫秒。为了保障 arr 数组的第 3 项为 4
,咱们要求在调用第 3 个两头的 next
函数之后,要可能持续往下执行。
4. 当第 3 个中间件执行实现后,此时 arr 数组的值为 [1, 2, 3, 4]
。因而为了保障 arr 数组的第 4 项为 5,咱们就须要在第 3 个中间件执行实现后,返回第 2 个中间件 next
函数之后语句开始执行。
5. 当第 2 个中间件执行实现后,此时 arr 数组的值为 [1, 2, 3, 4, 5]
。同样,为了保障 arr 数组的第 5 项为 6,咱们就须要在第 2 个中间件执行实现后,返回第 1 个中间件 next
函数之后语句开始执行。
6. 当第 1 个中间件执行实现后,此时 arr 数组的值为 [1, 2, 3, 4, 5, 6]
。
为了更直观地了解上述的执行流程,咱们能够把每个中间件当做 1 个大工作,而后在以 next
函数为分界点,在把每个大工作拆解为 3 个 beforeNext
、next
和 afterNext
3 个小工作。
在上图中,咱们从中间件一的 beforeNext
工作开始执行,而后依照紫色箭头的执行步骤实现中间件的任务调度。在 77.9K 的 Axios 我的项目有哪些值得借鉴的中央 这篇文章中,阿宝哥从 工作注册、工作编排和任务调度 3 个方面去剖析 Axios 拦截器的实现。同样,阿宝哥将从上述 3 个方面来剖析 Koa 中间件机制。
1.1 工作注册
在 Koa 中,咱们创立 Koa 应用程序对象之后,就能够通过调用该对象的 use
办法来注册中间件:
const Koa = require('koa');
const app = new Koa();
app.use(async (ctx, next) => {const start = Date.now();
await next();
const ms = Date.now() - start;
console.log(`${ctx.method} ${ctx.url} - ${ms}ms`);
});
其实 use
办法的实现很简略,在 lib/application.js 文件中,咱们找到了它的定义:
// lib/application.js
module.exports = class Application extends Emitter {constructor(options) {super();
// 省略局部代码
this.middleware = [];}
use(fn) {if (typeof fn !== 'function') throw new TypeError('middleware must be a function!');
// 省略局部代码
this.middleware.push(fn);
return this;
}
}
由以上代码可知,在 use
办法外部会对 fn
参数进行类型校验,当校验通过时,会把 fn
指向的中间件保留到 middleware
数组中,同时还会返回 this
对象,从而反对链式调用。
1.2 工作编排
在 77.9K 的 Axios 我的项目有哪些值得借鉴的中央 这篇文章中,阿宝哥参考 Axios 拦截器的设计模型,抽出以下通用的工作解决模型:
在该通用模型中,阿宝哥是通过把前置处理器和后置处理器别离放到 CoreWork 外围工作的前起初实现工作编排。而对于 Koa 的中间件机制来说,它是通过把前置处理器和后置处理器别离放到 await next()
语句的前起初实现工作编排。
// 统计申请解决时长的中间件
app.use(async (ctx, next) => {const start = Date.now();
await next();
const ms = Date.now() - start;
console.log(`${ctx.method} ${ctx.url} - ${ms}ms`);
});
1.3 任务调度
通过后面的剖析,咱们曾经晓得了,应用 app.use
办法注册的中间件会被保留到外部的 middleware
数组中。要实现任务调度,咱们就须要一直地从 middleware
数组中取出中间件来执行。中间件的调度算法被封装到 koa-compose 包下的 compose
函数中,该函数的具体实现如下:
/**
* Compose `middleware` returning
* a fully valid middleware comprised
* of all those which are passed.
*
* @param {Array} middleware
* @return {Function}
* @api public
*/
function compose(middleware) {
// 省略局部代码
return function (context, next) {
// last called middleware #
let index = -1;
return dispatch(0);
function dispatch(i) {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);
}
}
};
}
compose
函数接管一个参数,该参数的类型是数组,调用该函数之后会返回一个新的函数。接下来咱们将以后面的例子为例,来剖析一下 await compose(stack)({});
语句的执行过程。
1.3.1 dispatch(0)
由上图可知,当在第一个中间件外部调用 next
函数,其实就是持续调用 dispatch
函数,此时参数 i
的值为 1
。
1.3.2 dispatch(1)
由上图可知,当在第二个中间件外部调用 next
函数,依然是调用 dispatch
函数,此时参数 i
的值为 2
。
1.3.3 dispatch(2)
由上图可知,当在第三个中间件外部调用 next
函数,依然是调用 dispatch
函数,此时参数 i
的值为 3
。
1.3.4 dispatch(3)
由上图可知,当 middleware
数组中的中间件都开始执行之后,如果调度时未显式地设置 next
参数的值,则会开始返回 next
函数之后的语句持续往下执行。当第三个中间件执行实现后,就会返回第二中间件 next
函数之后的语句持续往下执行,直到所有中间件中定义的语句都执行实现。
剖析完 compose
函数的实现代码,咱们来看一下 Koa 外部如何利用 compose
函数来解决已注册的中间件。
const Koa = require('koa');
const app = new Koa();
// 响应
app.use(ctx => {ctx.body = '大家好,我是阿宝哥';});
app.listen(3000);
利用以上的代码,我就能够疾速启动一个服务器。其中 use
办法咱们后面曾经剖析过了,所以接下来咱们来剖析 listen
办法,该办法的实现如下所示:
// lib/application.js
module.exports = class Application extends Emitter {listen(...args) {debug('listen');
const server = http.createServer(this.callback());
return server.listen(...args);
}
}
很显著在 listen
办法外部,会先通过调用 Node.js 内置 HTTP 模块的 createServer
办法来创立服务器,而后开始监听指定的端口,即开始期待客户端的连贯。另外,在调用 http.createServer
办法创立 HTTP 服务器时,咱们传入的参数是 this.callback()
,该办法的具体实现如下所示:
// lib/application.js
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;
}
}
在 callback
办法外部,咱们终于见到了久违的 compose
办法。当调用 callback
办法之后,会返回 handleRequest
函数对象用来解决 HTTP 申请。每当 Koa 服务器接管到一个客户端申请时,都会调用 handleRequest
办法,在该办法会先创立新的 Context 对象,而后在执行已注册的中间件来解决已接管的 HTTP 申请:
module.exports = class Application extends Emitter {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);
}
}
好的,Koa 中间件的内容曾经根本介绍完了,对 Koa 内核感兴趣的小伙伴,能够自行钻研一下。接下来咱们来介绍洋葱模型及其利用。
二、洋葱模型
2.1 洋葱模型简介
(图片起源:https://eggjs.org/en/intro/eg…)
在上图中,洋葱内的每一层都示意一个独立的中间件,用于实现不同的性能,比方异样解决、缓存解决等。每次申请都会从左侧开始一层层地通过每层的中间件,当进入到最里层的中间件之后,就会从最里层的中间件开始逐层返回。因而对于每层的中间件来说,在一个 申请和响应 周期中,都有两个机会点来增加不同的解决逻辑。
2.2 洋葱模型利用
除了在 Koa 中利用了洋葱模型之外,该模型还被宽泛地利用在 Github 上一些不错的我的项目中,比方 koa-router 和阿里巴巴的 midway、umi-request 等我的项目中。
介绍完 Koa 的中间件和洋葱模型,阿宝哥依据本人的了解,抽出以下通用的工作解决模型:
上图中所述的中间件,个别是与业务无关的通用性能代码,比方用于设置响应工夫的中间件:
// x-response-time
async function responseTime(ctx, next) {const start = new Date();
await next();
const ms = new Date() - start;
ctx.set("X-Response-Time", ms + "ms");
}
对于每个中间件来说,前置处理器和后置处理器都是可选的。比方以下中间件用于设置对立的响应内容:
// response
async function respond(ctx, next) {await next();
if ("/" != ctx.url) return;
ctx.body = "Hello World";
}
只管以上介绍的两个中间件都比较简单,但你也能够依据本人的需要来实现简单的逻辑。Koa 的内核很轻量,麻雀虽小五脏俱全。它通过提供了优雅的中间件机制,让开发者能够灵便地扩大 Web 服务器的性能,这种设计思维值得咱们学习与借鉴。
好的,这次就先介绍到这里,前面有机会的话,阿宝哥在独自介绍一下 Redux 或 Express 的中间件机制。
三、参考资源
- Koa 官网文档
- Egg 官网文档