本文将讲解 koa
的洋葱模型,我们为什么要使用洋葱模型,以及它的原理实现。掌握洋葱模型对于理解 koa
至关重要,希望本文对你有所帮助~
什么是洋葱模型
先来看一个 demo
constKoa=require('koa');constapp=newKoa();//中间件1app.use((ctx,next)=>{console.log(1);next();console.log(2);});//中间件2app.use((ctx,next)=>{console.log(3);next();console.log(4);});app.listen(8000,'0.0.0.0',()=>{console.log(`Serverisstarting`);});
输出的结果是:
1342
在 koa
中,中间件被 next()
方法分成了两部分。next()
方法上面部分会先执行,下面部门会在后续中间件执行全部结束之后再执行。可以通过下图直观看出:
在洋葱模型中,每一层相当于一个中间件,用来处理特定的功能,比如错误处理、Session
处理等等。其处理顺序先是 next()
前请求(Request
,从外层到内层)然后执行 next()
函数,最后是 next()
后响应(Response
,从内层到外层),也就是说每一个中间件都有两次处理时机。
为什么 Koa 使用洋葱模型
假如不是洋葱模型,我们中间件依赖于其他中间件的逻辑的话,我们要怎么处理?
比如,我们需要知道一个请求或者操作 db
的耗时是多少,而且想获取其他中间件的信息。在 koa
中,我们可以使用 async await
的方式结合洋葱模型做到。
app.use(async(ctx,next)=>{conststart=newDate();awaitnext();constdelta=newDate()-start;console.log(`请求耗时:${delta}MS`);console.log('拿到上一次请求的结果:',ctx.state.baiduHTML);})app.use(async(ctx,next)=>{//处理db或者进行HTTP请求ctx.state.baiduHTML=awaitaxios.get('http://baidu.com');})
而假如没有洋葱模型,这是做不到的。
深入 Koa 洋葱模型
我们以文章开始时候的 demo
来分析一下 koa
内部的实现。
constKoa=require('koa');//Applicationsconstapp=newKoa();//中间件1app.use((ctx,next)=>{console.log(1);next();console.log(2);});//中间件2app.use((ctx,next)=>{console.log(3);next();console.log(4);});app.listen(9000,'0.0.0.0',()=>{console.log(`Serverisstarting`);});
use 方法
use
方法就是做了一件事,维护得到 middleware
中间件数组
use(fn){//...//维护中间件数组——middlewarethis.middleware.push(fn);returnthis;}
listen 方法 和 callback 方法
执行 app.listen
方法的时候,其实是 Node.js
原生 http
模块 createServer
方法创建了一个服务,其回调为 callback
方法。callback
方法中就有我们今天的重点 compose
函数,它的返回是一个 Promise
函数。
listen(...args){debug('listen');//nodehttp创建一个服务constserver=http.createServer(this.callback());returnserver.listen(...args);}callback(){//返回值是一个函数constfn=compose(this.middleware);consthandleRequest=(req,res)=>{//创建ctx上下文环境constctx=this.createContext(req,res);returnthis.handleRequest(ctx,fn);};returnhandleRequest;}
handleRequest
中会执行 compose
函数中返回的 Promise
函数并返回结果。
handleRequest(ctx,fnMiddleware){constres=ctx.res;res.statusCode=404;constonerror=err=>ctx.onerror(err);consthandleResponse=()=>respond(ctx);onFinished(res,onerror);//执行compose中返回的函数,将结果返回returnfnMiddleware(ctx).then(handleResponse).catch(onerror);}
koa-compose
compose
函数引用的是 koa-compose
这个库。其实现如下所示:
functioncompose(middleware){//...returnfunction(context,next){//lastcalledmiddleware#letindex=-1//一开始的时候传入为0,后续会递增returndispatch(0)functiondispatch(i){//假如没有递增,则说明执行了多次if(i<=index)returnPromise.reject(newError('next()calledmultipletimes'))index=i//拿到当前的中间件letfn=middleware[i]if(i===middleware.length)fn=next//当fn为空的时候,就会开始执行next()后面部分的代码if(!fn)returnPromise.resolve()try{//执行中间件,留意这两个参数,都是中间件的传参,第一个是上下文,第二个是next函数//也就是说执行next的时候也就是调用dispatch函数的时候returnPromise.resolve(fn(context,dispatch.bind(null,i+1)));}catch(err){returnPromise.reject(err)}}}}
代码很简单,我们来看看具体的执行流程是怎样的:
当我们执行第一次的时候,调用的是 dispatch(0)
,这个时候 i 为 0,fn
为第一个中间件函数。并执行中间件,留意这两个参数,都是中间件的传参,第一个是上下文,第二个是 next
函数。也就是说中间件执行 next 的时候也就是调用 dispatch 函数的时候,这就是为什么执行 next
逻辑的时候就会执行下一个中间件的原因:
returnPromise.resolve(fn(context,dispatch.bind(null,i+1)));
当第二、第三次执行 dispatch
的时候,跟第一次一样,分别开始执行第二、第三个中间件,执行 next()
的时候开始执行下一个中间件。
当执行到第三个中间件的时候,执行到 next()
的时候,dispatch
函数传入的参数是 3,fn
为 undefined
。这个时候就会执行:
if(!fn)returnPromise.resolve()
这个时候就会执行第三个中间件 next()
之后的代码,然后是第二个、第一个,从而形成了洋葱模型。
其过程如下所示:
简易版 compose
模范 koa
的逻辑,我们可以写一个简易版的 compose
。方便大家的理解:
13420
总结
Koa
的洋葱模型指的是以 next()
函数为分割点,先由外到内执行 Request
的逻辑,再由内到外执行 Response
的逻辑。通过洋葱模型,将多个中间件之间通信等变得更加可行和简单。其实现的原理并不是很复杂,主要是 compose
方法。
参考
Talk about koa’s onion model
如何更好地理解中间件和洋葱模型
作者:Gopal