20行代码简单实现koa洋葱圈模型示例详解
作者:秋染蒹葭
引言
koa想必很多人直接或间接的都用过,其源码不知道阅读本文的你有没有看过,相当精炼,本文想具体说说koa的中间件模型,一起看看koa-compose的源码,这也是koa系列的第一篇文章,后续会更新一下koa相关的其他知识点
koa中间件的使用
先让我们启动一个koa服务
// app.js const koa = require('koa'); const app = new koa(); app.use(async (ctx, next) => { console.log('进入第一个中间件') next(); console.log('退出第一个中间件') }) app.use(async (ctx, next) => { console.log('进入第2个中间件') next(); console.log('退出第2个中间件') }) app.use((ctx, next) => { console.log('进入第3个中间件') next(); console.log('退出第3个中间件') }) app.use(ctx => { ctx.body = 'hello koa' }) app.listen(8080, () => { console.log('服务启动,监听8080端口') })
上述的服务在访问的时候会得到如下结果:
服务启动,监听8080端口
进入第1个中间件
进入第2个中间件
进入第3个中间件
退出第3个中间件
退出第2个中间件
退出第1个中间件
上面的返回结果有点像一个递归的过程,从现象上看当中间件调用next()的时候,函数会暂停并进入到下一个中间件,当执行了最后一个中间件后,执行代码会回溯上游中间件,并执行next()之后的代码,这就是koa的核心能力,洋葱圈模型
洋葱圈模型
先看一张经典的洋葱圈模型的示意图:
在开发过程中,可以将next()之前的代码理解为捕获阶段, 而next()之后的代码可以理解为释放阶段,开发者结合这两个状态可以实现一些有趣的操作,比如记录一次请求的时间:
async function responseTime(ctx, next) { const start = Date.now(); await next(); const ms = Date.now() - start; ctx.set('X-Response-Time', `${ms}ms`); } app.use(responseTime);
使用洋葱圈模型可以直接将响应时间记录的操作解耦出来,这样就不需要再去对称的写在业务逻辑中了,这是怎么实现的呢?
洋葱圈模型的实现,koa-compose
我们通过app.use()
添加了很多函数,这些函数最终传递给了compose函数,先贴上koa-compose的源码,这里笔者删除掉了校验入参的一些非主干逻辑,我们可以看到代码也就十几行,非常简单,接下来让我们一行一行的去看一下代码
function compose (middleware) { // 返回一个匿名函数,next为可选参数 return function (context, next) { // 记录当前执行位置的游标 let index = -1 // 从第一个中间件开始,串起所有中间件 return dispatch(0) function dispatch (i) { // 为了不破坏洋葱圈模型,不允许在单个中间件中执行多次next函数 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 { // 核心处理逻辑,进入fn的执行上下文的时候,dispatch就是通过绑定下一个index,变成了next,进入到下一个中间件 return Promise.resolve(fn(context, dispatch.bind(null, i + 1))) } catch (err) { return Promise.reject(err) } } } }
compose接收一个的函数数组[fn1, fn2, fn3, ...]
,compose调用后,返回了一个匿名函数,匿名函数接收两个参数
- 第一个参数是上下文,对于koa的上下文不在本文的探究范围,我们只要记得这个是在各个中间件中的共享的就可以了
- 第二个参数标记为next,可选参数,在中间件执行的最后检查执行,这个和自定义的中间件中的next不完全一样,一般是初始化返回了匿名函数后,调用方自己指定,用于处理一下默认逻辑
通过源码可以看出,compose是提供了一个洋葱模型完全执行的回调,通过把函数存储起来,用next作为钥匙,串起了我们所有的中间件,其核心代码就是:
Promise.resolve(fn(context, dispatch.bind(null, i + 1)))
进入fn的执行上下文的时候,dispatch就是通过绑定下一个index,变成了next,进入到下一个中间件。另外fn(中间件函数)可以是个异步函数,Promise.resolve
会等到内部异步函数resolve之后触发
单次调用限制
假如在单个中间件中执行多次next函数的话,会造成下游的中间件多次执行,这样就破坏了洋葱圈模型,因此限制了在单个中间件中只能执行一次next函数,实现方式时在函数记录了一个游标index,初始值是-1;这个游标会记录当前执行到哪个中间件,用来禁止在中间件中多次调用next函数
在一个中间件内多次调用next的时候,你就会收到下面这个报错
UnhandledPromiseRejectionWarning: Error: next() called multiple times
koa-compose与流程引擎
koa-compose
不仅仅只是koa的一个依赖包,在有些场景下完全可以作为一个独立的工具来使用的,这里模拟一个代码检测工具的应用,完全可以作为一个流程引擎来使用
const koaCompose = require('koa-compose'); function download = (ctx, next) { console.log('download code'); next(); } function check = (ctx, next) { console.log('check style'); next(); } function post = (ctx, next) { next(); console.log('post result', ctx.result); } function clean = (ctx, next) { next(); console.log('clean temp, remove code'); } const flowEngine = koaCompose([download, check, post, clean]); flowEngine(ctx as Context);
上述可以看作一个基于koa-compose实现的流程引擎,在node中,我们会经常处理一些多阶段的任务,完全可以通过这样的方式来实现
总结
koa的洋葱圈模型在面试中经常会被问到,建议可以写一下、理解一下koa-compose
的源码;另外koa-compose
作为一个流程引擎也是一个很有用的工具,在有些场景下会有意想不到的效果。
以上就是20行代码简单实现koa洋葱圈模型示例详解的详细内容,更多关于koa洋葱圈模型的资料请关注脚本之家其它相关文章!