您当前的位置:首页 > 电脑百科 > 程序开发 > 框架

一文搞定 Koa 中间件实现原理

时间:2020-08-17 11:08:34  来源:  作者:
一文搞定 Koa 中间件实现原理

 

Koa是一个新的 web 框架,由 Express 幕后的原班人马打造, 致力于成为 web 应用和 API 开发领域中的一个更小、更富有表现力、更健壮的基石。 通过利用 async 函数, Koa 帮你丢弃回调函数,并有力地增强错误处理。 Koa 并没有捆绑任何中间件,而是提供了一套优雅的方法,帮助您快速而愉快地编写服务端应用程序。

Koa 中间件的作用

中间件的功能是可以访问请求对象( request ),响应对象( response )和应用程序的请求-响应周期中的通过 next 对下一个中间件函数的调用。通俗来讲, 利用这一特性在 next 之前对 request 进行处理, 而在 next 之后对 response 进行处理。

简单应用程序

const Koa = require('koa');
const App = new Koa();

app.use(async ctx => {
  ctx.body = 'Hello World';
});

app.listen(3000);

以上代码是 Koa 官网上面的 简单示例 , 接下来一起深入中间件机制的运行原理。

中间件应用 demo

const Koa = require('koa');
const app = new Koa();

app.use(async (ctx, next) => {
  console.log(1);
  await next();
  console.log(2);
});

app.use(async (ctx, next) => {
  console.log(3);
  await next();
  console.log(4);
});

app.use(async (ctx, next) => {
  ctx.body = 'Hello, Koa';
});

app.listen(3001);

结合上面应用demo, 逐步剖析中间件运行原理。每当服务器接收一个客户端请求时, 都会依次打印: 1, 3, 4, 2 。

中间件原理

注册中间件函数

上面应用使用 use 进行注册中间件函数, 看下 Koa 内部中间件的实现。

use(fn) {
  // 省略部分代码...
  this.middleware.push(fn);
  return this;
}

省略了部分校验和转换的代码, use 函数最核心的就是 this.middleware.push(fn) 这一句。将我们注册的中间件函数都缓存到 middleware 栈中, 并且返回了 this 自身, 方便进行链式调用。

上面的 demo 应用注册了三个中间件函数,具体这些中间件函数什么时候执行以及如何执行, 继续看。

创建 server 服务

上面 demo 引用调用 Koa 实例的 listen 方法, 开启端口号为 3001 的服务, 看下 Koa 内部 listen 方法的实现。

listen(...args) {
  const server = http.createServer(this.callback());
  return server.listen(...args);
}

内部使用了 Node 原生的 http 模块, 通过 createServer 创建一个 Server 实例并监听指定的端口号。 http.createServer(RequestListener) 接受请求侦听器函数作为参数, RequestListener 函数接受 request 和 response 对象两个参数。

所以, 知道 this.callback() 函数的调用返回一个函数, 并且这个函数接受 request 和 response 请求和响应对象。

callback 创建 RequestListener 请求侦听器函数

上面说到, callback 函数的调用返回一个 RequestListener 请求侦听器函数, 并且接受 请求对象( request )和响应对象( response )。

callback() {
  // compose 为中间件运行的核心
  const fn = compose(this.middleware);

  // handleRequest 就是 callback 函数返回的函数
  const handleRequest = (req, res) => {
    const ctx = this.createContext(req, res);
    return this.handleRequest(ctx, fn);
  };
  return handleRequest;
}

callback函数主要做了两件事情:

  1. 使用 compose 函数对缓存中间件函数的栈做了一层校验, 并且 返回了一个函数 。后文会详细分析 compose 函数的实现。
  2. 创建一个 RequestListener 请求侦听器函数, 并且返回出去。 如果有客户端请求时, 就会先触发请求侦听器函数执行, 并且接受这次请求的 request 和 response 对象。

const ctx = this.createContext(req, res) 纯碎做了一件根据请求的 request 和 response 创建了一个 ctx 上下文对象, 创建它们三者的互相引用关系等, 这不是这篇文章的重点, 可自行了解。。

然后通过 handleRequest 函数将 ctx 上下文对象和 compose 函数的结果作为参数进行处理, 那么 compose 函数主要做了什么呢?

compose

compose 是一个 koa-compose npm 包, 其内部核心代码也就 20+ 行, 它提供了中间件 next 函数调用的核心承载, 看一下内部的代码:

function compose (middleware) {
  if (!Array.isArray(middleware)) 
    throw new TypeError('Middleware stack must be an array!')
  for (const fn of middleware) {
    if (typeof fn !== 'function') 
      throw new TypeError('Middleware must be composed of functions!')
  }

  /**
   * @param {Object} ctx
   * @return {Promise}
   * @api public
   */
  return function fn (ctx, next) {
    // 简化了部分代码
    return dispatch(0)
    function dispatch (i) {
      let middlewareFn = middleware[i]
      try {
        return Promise.resolve(middlewareFn(ctx, dispatch.bind(null, i + 1)));
      } catch (err) {
        return Promise.reject(err)
      }
    }
  }
}

所以, const fn = compose(this.middleware) 的调用主要做了一些对 middleware 及 middleware 栈内每一个中间件函数的校验, 并返回 fn 函数。

下面结合 handleRequest 函数内部的处理来深入理解 fn 函数的执行过程。

handleRequest

每次客户端有请求时, 都会调用 RequestListener 请求侦听器函数, 并创建请求响应上下文对象后, 传递 上下文对象 和 fn 函数到 handleRequest 函数处理。所以每次请求都会处理一次, 每次请求都会依次触发已注册的中间件函数。

handleRequest(ctx, fn) {
  // 省略无关代码...
  const onerror = err => ctx.onerror(err);
  const handleResponse = () => respond(ctx);
  // 省略无关代码...
  return fn(ctx).then(handleResponse).catch(onerror);
}

fn(ctx) 接受上下文对象参数,执行的结果可以调用 .then , 不用想了吧, 八成返回一个 Promise 对象, 下面再进入到看下 fn 函数内部的实现。

内部调用了 dispatch(0) 根据下标取出 middleware 栈中的第一个中间件函数 middlewareFn :

async (ctx, next) => {
  console.log(1);
  await next();
  console.log(2);
}

希望你对 bing 有深刻的理解。 MDN bind

然后执行第一个中间件函数, 将上下文对象( ctx ) 和 next ( dispatch.bind(null, i + 1) ) 作为参数传递给中间件函数。首先会执行 console.log(1) 打印 1 , 然后执行 await next() 将当前函数的 执行权 转交给 dispatch.bind(null, i + 1) 函数执行。

相当于调用了 dispatch(1) , 则取出第二个中间件函数执行, 依次类推。

看图辅助理解

一文搞定 Koa 中间件实现原理

 

洋葱模型

一文搞定 Koa 中间件实现原理

 

当 dispatch(0) 出栈后则表示所有的中间件函数已依次执行完毕, 如果某个中间件执行出现错误, 就会抛出 Promise.reject 由外部的 onerror 函数处理, 如果没有出现错误则调用 handleResponse 函数并转交给 respond 函数处理 body 的数据格式, 这些不是本篇幅的重点。



Tags:Koa   点击:()  评论:()
声明:本站部分内容及图片来自互联网,转载是出于传递更多信息之目的,内容观点仅代表作者本人,如有任何标注错误或版权侵犯请与我们联系(Email:2595517585@qq.com),我们将及时更正、删除,谢谢。
▌相关推荐
在此前写的文章“从零基础入门进行小程序开发实战”中,已经介绍过背单词的小程序,因为没有备案的服务器资源只能使用系统后台提供的缓存功能存储用户数据。缓存有大小限制,而且...【详细内容】
2021-07-27  Tags: Koa  点击:(108)  评论:(0)  加入收藏
Koa是一个新的 web 框架,由 Express 幕后的原班人马打造, 致力于成为 web 应用和 API 开发领域中的一个更小、更富有表现力、更健壮的基石。 通过利用 async 函数, Koa 帮你丢...【详细内容】
2020-08-17  Tags: Koa  点击:(83)  评论:(0)  加入收藏
1. Context 对象Koa 提供一个 Context 对象,表示一次对话的上下文(包括 HTTP 请求和 HTTP 回复)。通过加工这个对象,就可以控制返回给用户的内容。Context.response.body属性就...【详细内容】
2019-10-18  Tags: Koa  点击:(143)  评论:(0)  加入收藏
▌简易百科推荐
近日只是为了想尽办法为 Flask 实现 Swagger UI 文档功能,基本上要让 Flask 配合 Flasgger, 所以写了篇 Flask 应用集成 Swagger UI 。然而不断的 Google 过程中偶然间发现了...【详细内容】
2021-12-23  Python阿杰    Tags:FastAPI   点击:(6)  评论:(0)  加入收藏
文章目录1、Quartz1.1 引入依赖<dependency> <groupId>org.quartz-scheduler</groupId> <artifactId>quartz</artifactId> <version>2.3.2</version></dependency>...【详细内容】
2021-12-22  java老人头    Tags:框架   点击:(11)  评论:(0)  加入收藏
今天来梳理下 Spring 的整体脉络啦,为后面的文章做个铺垫~后面几篇文章应该会讲讲这些内容啦 Spring AOP 插件 (了好久都忘了 ) 分享下 4ye 在项目中利用 AOP + MybatisPlus 对...【详细内容】
2021-12-07  Java4ye    Tags:Spring   点击:(14)  评论:(0)  加入收藏
&emsp;前面通过入门案例介绍,我们发现在SpringSecurity中如果我们没有使用自定义的登录界面,那么SpringSecurity会给我们提供一个系统登录界面。但真实项目中我们一般都会使用...【详细内容】
2021-12-06  波哥带你学Java    Tags:SpringSecurity   点击:(18)  评论:(0)  加入收藏
React 简介 React 基本使用<div id="test"></div><script type="text/javascript" src="../js/react.development.js"></script><script type="text/javascript" src="../js...【详细内容】
2021-11-30  清闲的帆船先生    Tags:框架   点击:(19)  评论:(0)  加入收藏
流水线(Pipeline)是把一个重复的过程分解为若干个子过程,使每个子过程与其他子过程并行进行的技术。本文主要介绍了诞生于云原生时代的流水线框架 Argo。 什么是流水线?在计算机...【详细内容】
2021-11-30  叼着猫的鱼    Tags:框架   点击:(21)  评论:(0)  加入收藏
TKinterThinter 是标准的python包,你可以在linx,macos,windows上使用它,你不需要安装它,因为它是python自带的扩展包。 它采用TCL的控制接口,你可以非常方便地写出图形界面,如...【详细内容】
2021-11-30    梦回故里归来  Tags:框架   点击:(26)  评论:(0)  加入收藏
前言项目中的配置文件会有密码的存在,例如数据库的密码、邮箱的密码、FTP的密码等。配置的密码以明文的方式暴露,并不是一种安全的方式,特别是大型项目的生产环境中,因为配置文...【详细内容】
2021-11-17  充满元气的java爱好者  博客园  Tags:SpringBoot   点击:(25)  评论:(0)  加入收藏
一、搭建环境1、创建数据库表和表结构create table account(id INT identity(1,1) primary key,name varchar(20),[money] DECIMAL2、创建maven的工程SSM,在pom.xml文件引入...【详细内容】
2021-11-11  AT小白在线中  搜狐号  Tags:开发框架   点击:(29)  评论:(0)  加入收藏
SpringBoot开发的物联网通信平台系统项目功能模块 功能 说明 MQTT 1.SSL支持 2.集群化部署时暂不支持retain&will类型消 UDP ...【详细内容】
2021-11-05  小程序建站    Tags:SpringBoot   点击:(55)  评论:(0)  加入收藏
相关文章
最新更新
栏目热门
栏目头条