说到中间件,很多开发者都会想到 Koa.js,其中间件设计无疑是前端中间件思想的典型代表之一。
最近重新温习这部分内容,按奈不住想要和各位看官聊聊其中绝妙!
-----
Koa 用起来非常方便——比之 express,它“完美中间件”的设计让功能之间看起来非常简洁!笔者在项目中就曾这样使用过:
const Koa=require('koa')
const app=new Koa()
const Router=require('koa-router')
const router=new Router()
const cors=require('koa2-cors')
const koaBody=require('koa-body')
const ENV='test-mpin2'
app.use(cors({
origin:['http://localhost:9528'], // 也可以写为:['*']
credentials:true
}))
app.use(koaBody({
multipart:true
}))
app.use(async(ctx,next)=>{
console.log('访问全局中间件')
ctx.state.env=ENV // 全局缓存
await next()
})
const playlist=require('./controller/playlist.js')
router.use('/playlist',playlist.routes())
const blog=require('./controller/blog.js')
router.use('/blog',blog.routes())
app.use(router.routes()).use(router.allowedMethods())
app.listen(3000,()=>{
console.log('服务已开启')
})
复制代码
它将路由 router 抽离出去作为单独的中间件使用,则 app 只负责全局处理。还比如:
// 最外层中间件,可以用于兜底 Koa 全局错误
app.use(async (ctx, next) => {
try {
// 执行下一个中间件
await next();
} catch (error) {
console.log(`[koa error]: ${error.message}`)
}
});
// 第二层中间件,可以用于日志记录
app.use(async (ctx, next) => {
const { req } = ctx;
console.log(`req is ${JSON.stringify(req)}`);
await next();
console.log(`res is ${JSON.stringify(ctx.res)}`);
});
复制代码
简单实现一个 Koa 吧!
如上代码,我们看 Koa 实例,通过 use 方法注册和串联中间件,其源码的简单实现可以表述为:
use(fn) {
this.middleware.push(fn);
return this;
}
复制代码
我们将中间件存储到this.middleware
数组中,那么中间件是如何被执行的呢?参考下面源码:
// 通过 createServer 方法启动一个 Node.js 服务
listen(...args) {
const server = http.createServer(this.callback());
server.listen(...args);
}
复制代码
Koa 框架通过 http 模块的 createServer
方法创建一个 Node.js 服务,并传入 this.callback()
方法, callback 源码简单实现如下:
callback(){
const fn=compose(this.middlewareList)
return (req,res)=>{
const ctx=createContext(req,res)
return this.handleRequest(ctx,fn)
}
}
handleRequest(ctx, fn) {
const onerror = err => ctx.onerror(err);
// 将 ctx 对象传递给中间件函数 fn
return fn(ctx).catch(onerror);
}
复制代码
如上代码,我们将 Koa 一个中间件组合和执行流程梳理为以下步骤:
1. 通过一个方法(我们称为 compose)组合各种中间件,返回一个中间件组合函数fn
2. 请求过来时,会先调用handleRequest
方法,该方法完成:
- 调用createContext
方法,对该次请求封装出一个 ctx 对象;
- 接着调用this.handleRequest(ctx, fn)
处理该次请求。
其中,核心过程就是使用 compose 方法组合各种中间件 —— 这是一个单独的方法,它应该不受 Koa 其余方法的约束。其源码简单实现为:
// 组合中间件
// 和express中的next函数意义一样
function compose(middlewareList){
// return function意思是返回一个函数
return function(ctx,next){
let index=-1;
// 各种中间件调用的逻辑
function dispatch(i){
if(i<=index) return Promise.reject(new Error('next() called multiple times'))
index=i
const fn=middlewareList[i] || next
if(fn){
try{
// koa中都是async,其返回的是一个promise(对象)
return Promise.resolve(fn(ctx,function next(){
return dispatch(i+1)
}))
}catch(err){
return Promise.reject(err)
}
}else{
return Promise.resolve()
}
}
return dispatch(0)
}
}
复制代码
其功能可以表示为这样(非源码):
async function middleware1() {
//...
await (async function middleware2() {
//...
await (async function middleware3() {
//...
});
//...
});
//...
}
复制代码
到这里我们其实可以“初窥”其原理,有两点:
所谓洋葱模型,就是指每一个 Koa 中间件都是一层洋葱圈,它即可以掌管请求进入,也可以掌管响应返回。换句话说:外层的中间件可以影响内层的请求和响应阶段,内层的中间件只能影响外层的响应阶段。
Koa1 的中间件实现利用了 Generator 函数 + co 库(一种基于 Promise 的 Generator 函数流程管理工具),来实现协程运行。本质上,Koa v1 中间件和 Koa v2 中间件思想是类似的,只不过 Koa v2 改用了 Async/Await 来替换 Generator 函数 + co 库,整体实现更加巧妙,代码更加优雅。—— from《狼书》
经过上述部分源码的描述,我们就可以采用 es6 的方式将其组合起来:
// myKoa.js文件
const http=require('http')
function compose(){} //见上
class LikeKoa2{
constructor() {
this.middlewareList=[]
}
use(){} //见上
// 把所有的req,res属性、事件都交给ctx(这里只是简写)
createContext(req,res){
const ctx={
req,
res
}
// 比如
ctx.query=req,query
return ctx
}
handleRequest(){} //见上
callback(){} //见上
listen(){} //见上
}
// koa和express的不同之一:
// express在调用时直接调用函数:const app=express();所以暴露出去new过的对象——具体见下面链接中代码
// 但是koa调用时以类的方式:const app=new Koa();所以直接暴露出去
module.exports=LikeKoa2
复制代码
那 use 方法和其余方法并不相通,它是如何被执行的呢?执行了 createServer 后是不是相当于建立了一个通道、挂载了一个监听函数呢?
这一点恐怕就要到 Node 的源码中一探究竟了...
-----
对比 Koa,聊聊 Express 原理
说起 Node.js 框架,我们一定忘不了 Express —— 不同于 Koa,它继承了路由、静态服务器和模板引擎等功能,虽然比之 Koa 显得“臃肿”了许多,但看上去比 Koa 更像是一个框架。通过学习 Express 源码,笔者简单的总结了它的工作机制:
1. 通过 app.use 方法注册中间件。
2. 一个中间件可以理解为一个 Layer 对象,其中包含了当前路由匹配的正则信息以及 handle 方法。
3. 所有中间件(Layer 对象)使用 stack 数组存储起来。
4. 当一个请求过来时,会从 req 中获取请求 path,根据 path 从 stack 中找到匹配的 Layer,具体匹配过程由router.handle
函数实现。
5. router.handle
函数通过next()
方法遍历每一个 layer 进行比对:
- next()
方法通过闭包维持了对于 Stack Index 游标的引用,当调用next()
方法时,就会从下一个中间件开始查找;
- 如果比对结果为 true,则调用layer.handle_request
方法,layer.handle_request
方法中会调用 next()方法 ,实现中间件的执行。
通过上述内容,我们可以看到,Express 其实是通过 next()
方法维护了遍历中间件列表的 Index 游标,中间件每次调用next()
方法时,会通过增加 Index 游标的方式找到下一个中间件并执行。它的功能就像这样:
((req, res) => {
console.log('第一个中间件');
((req, res) => {
console.log('第二个中间件');
(async(req, res) => {
console.log('第三个中间件');
await sleep(2000)
res.status(200).send('hello')
})(req, res)
console.log('第二个中间件调用结束');
})(req, res)
console.log('第一个中间件调用结束')
})(req, res)
复制代码
如上代码,Express 中间件设计并不是一个洋葱模型,它是基于回调实现的线形模型,不利于组合,不利于互操,在设计上并不像 Koa 一样简单。而且业务代码有一定程度的侵扰,甚至会造成不同中间件间的耦合。
express 的简单实现笔者已上传至腾讯微云,需要者可自行查看 &下载:express的简单实现
评论