傻瓜式解读koa中间件处理模块koa-compose(代码片段)

jaycewu jaycewu     2023-01-13     451

关键词:

最近需要单独使用到koa-compose这个模块,虽然使用koa的时候大致知道中间件的执行流程,但是没仔细研究过源码用起来还是不放心(主要是这个模块代码少,多的话也没兴趣去研究了)。

koa-compose看起来代码少,但是确实绕。闭包,递归,Promise。。。看了一遍脑子里绕不清楚。看了网上几篇解读文章,都是针对单行代码做解释,还是绕不清楚。最后只好采取一种傻瓜的方式:

koa-compose去掉一些注释,类型校验后,源码如下:

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)
      
    
  

写出如下代码:

var index = -1;
function compose() 
    return dispatch(0)

function dispatch (i) 
      if (i <= index) return Promise.reject(new Error('next() called multiple times'))
      index = i
      var fn = middleware[i]
      if (i === middleware.length) fn = next
      if (!fn) return Promise.resolve('fn is undefined')
      try 
        return Promise.resolve(fn(context, dispatch.bind(null, i + 1)));
       catch (err) 
        return Promise.reject(err)
      
 
 
 function f1(context,next)
    console.log('middleware 1');
    next().then(data=>console.log(data));
    console.log('middleware 1');
    return 'middleware 1 return';
  
  function f2(context,next)
    console.log('middleware 2');
    next().then(data=>console.log(data));
    console.log('middleware 2');
    return 'middleware 2 return';
  
  function f3(context,next)
    console.log('middleware 3');
    next().then(data=>console.log(data));
    console.log('middleware 3');
    return 'middleware 3 return';
  
var middleware=[
  f1,f2,f3
]

var context=;
var next=function(context,next)
    console.log('middleware 4');
    next().then(data=>console.log(data));
    console.log('middleware 4');
    return 'middleware 4 return';
;
compose().then(data=>console.log(data));

直接运行结果如下:

"middleware 1"

"middleware 2"

"middleware 3"

"middleware 4"

"middleware 4"

"middleware 3"

"middleware 2"

"middleware 1"

"fn is undefined"

"middleware 4 return"

"middleware 3 return"

"middleware 2 return"

"middleware 1 return"

按着代码运行流程一步步分析:

dispatch(0)

i==0,index==-1 i>index 往下

index=0

fn=f1

Promise.resolve(f1(context, dispatch.bind(null, 0 + 1)))

这就会执行

f1(context, dispatch.bind(null, 0 + 1))

进入到f1执行上下文

console.log(‘middleware 1‘);

输出middleware 1

next()

其实就是调用dispatch(1) bind的功劳

递归开始

dispatch(1)

i==1,index==0 i>index 往下

index=1

fn=f2

Promise.resolve(f2(context, dispatch.bind(null, 1 + 1)))

这就会执行

f2(context, dispatch.bind(null, 1 + 1))

进入到f2执行上下文

console.log(‘middleware 2‘);

输出middleware 2

next()

其实就是调用dispatch(2)

接着递归

dispatch(2)

i==2,index==1 i>index 往下

index=2

fn=f3

Promise.resolve(f3(context, dispatch.bind(null, 2 + 1)))

这就会执行

f3(context, dispatch.bind(null, 2 + 1))

进入到f3执行上下文

console.log(‘middleware 3‘);

输出middleware 3

next()

其实就是调用dispatch(3)

接着递归

dispatch(3)

i==3,index==2 i>index 往下

index=3

i === middleware.length

fn=next

Promise.resolve(next(context, dispatch.bind(null, 3 + 1)))

这就会执行

next(context, dispatch.bind(null, 3 + 1))

进入到next执行上下文

console.log(‘middleware 4‘);

输出middleware 4

next()

其实就是调用dispatch(4)

接着递归

dispatch(4)

i==4,index==3 i>index 往下

index=4

fn=middleware[4]

fn=undefined

reuturn Promise.resolve(‘fn is undefined‘)

回到next执行上下文

console.log(‘middleware 4‘);

输出middleware 4

return ‘middleware 4 return‘

Promise.resolve(‘middleware 4 return‘)

回到f3执行上下文

console.log(‘middleware 3‘);

输出middleware 3

return ‘middleware 3 return‘

Promise.resolve(‘middleware 3 return‘)

回到f2执行上下文

console.log(‘middleware 2‘);

输出middleware 2

return ‘middleware 2 return‘

Promise.resolve(‘middleware 2 return‘)

回到f1执行上下文

console.log(‘middleware 1‘);

输出middleware 1

return ‘middleware 1 return‘

Promise.resolve(‘middleware 1 return‘)

回到全局上下文

至此已经输出

"middleware 1"

"middleware 2"

"middleware 3"

"middleware 4"

"middleware 4"

"middleware 3"

"middleware 2"

"middleware 1"

那么

"fn is undefined"

"middleware 4 return"

"middleware 3 return"

"middleware 2 return"

"middleware 1 return"

怎么来的呢

回头看一下,每个中间件里都有

next().then(data=>console.log(data));

按照之前的分析,then里最先拿到结果的应该是next中间件的,而且结果就是Promise.resolve(‘fn is undefined‘)的结果,然后分别是f4,f3,f2,f1。那么为什么都是最后才输出呢?

Promise.resolve('fn is undefined').then(data=>console.log(data));
console.log('middleware 4');

运行一下就清楚了

或者

setTimeout(()=>console.log('fn is undefined'),0);
console.log('middleware 4');

整个调用过程还可以看成是这样的:

function composeDetail()
  return Promise.resolve(
    f1(context,function()
      return Promise.resolve(
        f2(context,function()
          return Promise.resolve(
            f3(context,function()
              return Promise.resolve(
                next(context,function()
                  return Promise.resolve('fn is undefined')
                )
              )
            )
          )
        )
      )
    )
  )

composeDetail().then(data=>console.log(data));

方法虽蠢,但是compose的作用不言而喻了

最后,if (i <= index) return Promise.reject(new Error(‘next() called multiple times‘))这句代码何时回其作用呢?

一个中间件里调用两次next(),按照上面的套路走,相信很快就明白了。

koa2——中间件

1.什么是koa2中间件?koa对网络请求采用了中间件的形式处理,中间件可以介入请求和相应的处理,是一个轻量级的模块,每个中间负责完成某个特定的功能。中间件的通过next函数联系,执行next()后会将控制权交给下一个中间件,如果没... 查看详情

深入node.jskoa原理,实现koa

...于http模块,listen方法还是创建一个server。use方法存放中间件,相当于订阅。每次请求来了之后就处理请求,然后处理订阅的中间件,有点像发布订阅的模式。这里的createContext是用来创建ctx的。这里做了两层隔离... 查看详情

深入解析koa之核心原理(代码片段)

...原理分析,本文从封装创建应用程序函数、扩展res和req、中间件实现原理、异常处理的等这几个方面来介绍,写的十分的全面细致,具有一定的参考价值,对此有需要的朋友可以参考学习下。如有不足之处,欢迎批评指正。Koa作... 查看详情

koa的中间件(代码片段)

什么是Koa的中间件通俗的讲:中间件就是匹配路由之前或者匹配路由完成做的一系列的操作,我们就可以把它叫做中间件。在express中间件(Middleware)是一个函数,它可以访问请求对象(requestobject(req)),响应对象(responseobject(res)),和web应... 查看详情

使用koa2进行web开发静态文件与路由

静态文件处理这里选择koa-static作为处理静态文件的中间件constKoa=require('koa');constapp=newKoa();constserve=require("koa-static");app.use(serve(__dirname+"/static/html",extensions:['html']));app.listen(3000);static模块的使用... 查看详情

从koa-session源码解读session本质(代码片段)

...浏览器会过期吗?本文将从koa-session(koa官方维护的session中间件)的源码详细解读session的机制原理。希望大家读完后,会对session的本质,以及session和cookie的区别有个更清晰的认识。基础知识相信大家都知道一些关于cookie和sessio... 查看详情

koa笔记02:常用中间件(代码片段)

...xff1a;基础入门》中对Koa做了个基础的介绍,Koa是个HTTP中间件框架,本身并没有提供很多真正业务处理的功能,需要搭配各种中间件来实现,这篇文章选一些常见的中间件进行介绍。基础说明Koa的一些热门的 查看详情

koa2快速上手(代码片段)

...it。2.koa2特点:支持async/await语法糖、支持洋葱模型的中间件。洋葱模型中间件:web服务器在处理一个又一个的请求并作出响应时,在这个过程中需要程序处理,这个处理的程序被称为中间件,多个中间件在处... 查看详情

express和koa的区别

...整体上来看,koa是比express更加轻量,他没有内置的各种中间件的支持,更集中于请求处理。当然在express4.0以后,也移除了一批中间件支持,向轻量化进发。这一点上差别其实不是特别大了。最大的差别是中间件和回调的处理逻... 查看详情

如何评价node.js的koa框架

...1.koa和express在表现上的一点不同是采用ctx一个参数来调用中间件,而不是express的req,res。其实在使用上还是个人认为是更方便了的。2.然后是在中间件连接的方式上有所不同。express的设计是串联的,设计思路超级简洁。koa的某一... 查看详情

koa2--delegates模块源码解读(代码片段)

delegates模块是由TJ大神写的,该模块的作用是将内部对象上的变量或函数委托到外部对象上。然后我们就可以使用外部对象就能获取内部对象上的变量或函数。delegates委托方式有如下:getter:外部对象可以通过该方法访问内部对象... 查看详情

koa中间件(middleware)级联原理(代码片段)

前言上次看到了koa-compose的代码,今天来说一下koa中间件的级联以及工作原理。中间件工作原理初始化koa实例后,我们会用use方法来加载中间件(middleware),会有一个数组来存储中间件,use调用顺序会决定中间件的执行顺序。每个... 查看详情

koa和express对比

...同koa采用了newKoa()的方式,而express采用传统的函数形式2.中间件形式二者不一样,这是由二者处理中间件的逻辑差异导致的,实际上这也是二者最根本的差别3.koa没有回调,而express有回调。Express和Koa最明显的差别就是Handler的处... 查看详情

express和koa中的超时处理

...理现成的模块有connect-time,有一百五十个star,在中间件中已经算不少了,下面是一段使用connect-time的代码varexpress=require('express')vartimeout=require('connect-timeout')varapp=express()app.use(timeout('5s'))//....... 查看详情

koa入门教程

...弃回调函数,并有力地增强错误处理。Koa并没有捆绑任何中间件,而是提供了一套优雅的方法,帮助您快速而愉快地编写服务端应用程序。一、koa的安装与使用二、Koa环境搭建三、koa中间件什么是中间件?一 查看详情

koa2-6(代码片段)

koa-bodyparser中间件  已经学会如何自己编写代码接收并解析POST请求,这样最基本的功能其实是不用我们自己写的,一定有造好的轮子让我们使用,koa-bodyparser就是一个造好的轮子。我们在koa中把这种轮子就叫做中间件。对于POST... 查看详情

源码共读|koa-compose(代码片段)

...型资源:源码地址:koajs/composekoa-composeKoa-compose是一个Koa中间件工具,Koa是一个流行的Node.js网络框架。Koa-compose允许你将多个中间件函数组合成一个单独的函数,这样可以更容易地管理和重用中间件。在Koa中,中间件函数是按照... 查看详情

koa2学习使用session(代码片段)

...不提供session的处理方法,这里我们需要借助一个第三方中间件koa-session来处理session。先安装插件:$npmikoa-session通过注册这个中间件,我们可以直接通过ctx.session来操作session:constKoa=require(‘koa‘)constapp=newKoa()constsession=require 查看详情