深入理解 Koa 框架中间件原理


Posted in Javascript onOctober 18, 2018

Node 主要用在开发 Web 应用,koa 是目前 node 里最流行的 web 框架。

在 Node 开启一个 http 服务简直易如反掌,官网 demo。

const http = require("http");

const server = http.createServer((req, res) => {
 res.statusCode = 200;
 res.setHeader("Content-Type", "text/plain");
 res.end("Hello World\n");
});

const hostname = "127.0.0.1";
const port = 3000;
server.listen(port, hostname, () => {
 console.log(`Server running at http://${hostname}:${port}/`);
});
  • 引入 http 模块, http 的 createServer 方法创建了一个 http.Server 的实例。
  • server 监听 3000 端口。
  • 我们传入到 createServer 里的函数实际是监听 request 事件的回调,每当请求进来,监听函数就会执行。
  • request 事件的监听函数,其函数接受两个参数,分别是 req 和 res 。其中 req 是一个可读流, res 是一个可写流。我们通过 req 获取 http 请求的所有信息,同时将数据写入到 res 来对该请求作出响应。

koa 应用

koa 如何创建一个 server, 直接上个官网的例子

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

// x-response-time

app.use(async (ctx, next) => {
 const start = Date.now();
 await next();
 const ms = Date.now() - start;
 ctx.set("X-Response-Time", `${ms}ms`);
});

// logger

app.use(async (ctx, next) => {
 const start = Date.now();
 await next();
 const ms = Date.now() - start;
 console.log(`${ctx.method} ${ctx.url} - ${ms}`);
});

// response

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

app.listen(3000);

中间件概念在编程中使用广泛, 不管是前端还是后端, 在实际编程中或者框架设计都有使用到这种实用的模型。

基本上,Koa 所有的功能都是通过中间件实现的。

每个中间件默认接受两个参数,第一个参数是 Context 对象,第二个参数是 next 函数。只要调用 next 函数,就可以把执行权转交给下一个中间件。

如果中间件内部没有调用 next 函数,那么执行权就不会传递下去。

多个中间件会形成一个栈结构(middle stack),以“先进后出”(first-in-last-out)的顺序执行。整个过程就像,先是入栈,然后出栈的操作。

上面代码的执行顺序是:

请求 ==> x-response-time 中间件 ==> logger 中间件 ==> response中间件 ==> logger 中间件 ==> response-time 中间件 ==> 响应

理解 Koa 的中间件机制(源码分析)

阅读源码,化繁为简,我们看看 koa 的中间件系统是如何实现的。

class Application extends Emitter {
 constructor() {
  super();
  this.middleware = [];
 },

 use(fn) {
  this.middleware.push(fn);
  return this;
 },

 callback() {
  const fn = compose(this.middleware);

  return function(req, res) {
   return fn(ctx);
  };
 },

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

好了,精简结束,一不小心,去枝末节,最后只剩下不到 20 行代码。

这就是框架的核心,简化后的代码非常清晰,有点不可思议,但核心就是这么简单。

我们先分析以上代码做了什么事。

  • 我们定义了一个 middleware 数组来存储中间件。
  • 我们定一个了一个 use 方法来注册一个中间件。其实就是简单的 push 到自身的 mideware 这个数组中。
  • 我们还使用了一个 compose 方法,传入 middleware ,应该是做了一些处理,返回了一个可执行的方法。

你一定对中间的 compose 方法很好奇,初此之外的代码都容易理解,唯独这个 compose 不太知道究竟做了什么。

其实, compose 就是整个中间件框架的核心。

compose 之外,代码已经很清楚的定义了

  • 中间件的存储
  • 中间件的注册

而 compose 方法做了最为重要的一件事

  • 中间件的执行

核心源码 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);
   }
  }
 };
}

我试图去简化一下这个方法,但方法本身已经足够简洁。

代码很简洁。

通过 next()传递 实现中间件调用, 结合 Promise 采用 递归调用 的通知机制。

看图

深入理解 Koa 框架中间件原理

这种形式的控制流让整个 Koa 框架中间件的访问呈现出 自上而下的中间件流 + 自下而上的 response 数据流 的形式。

Koa 本身做的工作仅仅是定制了中间件的编写规范,而不内置任何中间件。一个 web request 会通过 Koa 的中间件栈,来动态完成 response 的处理。

koa 在中间件语法上面采用了 async + await 语法来生成 Promise 形式的程序控制流。

总结

koa 是非常精简的框架, 其中的精粹思想就是洋葱模型(中间件模型), koa 框架的中间件模型非常好用并且简洁, 但是也有自身的缺陷, 一旦中间件数组过于庞大, 性能会有所下降,我们需要结合自身的情况与业务场景作出最合适的选择.

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持三水点靠木。

Javascript 相关文章推荐
javascript 一些用法小结
Sep 11 Javascript
jQuery 类twitter的文本字数限制带提示效果插件
Apr 16 Javascript
js实现拖拽 闭包函数详细介绍
Nov 25 Javascript
javascript常用的方法整理
Aug 20 Javascript
jquery地址栏链接与a标签链接匹配之特效代码总结
Aug 24 Javascript
详解javascript中的事件处理
Nov 06 Javascript
如何获取元素的最终background-color
Feb 06 Javascript
JS数组操作之增删改查的简单实现
Aug 21 Javascript
基于jQuery实现的设置文本区域的光标位置
Jun 15 jQuery
node中的cookie的具体使用
Sep 13 Javascript
详解Vue CLI 3.0脚手架如何mock数据
Nov 23 Javascript
js面向对象方式实现拖拽效果
Mar 03 Javascript
JS实现十分钟倒计时代码实例
Oct 18 #Javascript
基于Vue实现可以拖拽的树形表格实例详解
Oct 18 #Javascript
JavaScript的词法结构精华篇
Oct 17 #Javascript
Javascript中parseInt的正确使用方式
Oct 17 #Javascript
教你如何编写Vue.js的单元测试的方法
Oct 17 #Javascript
详解vue如何使用rules对表单字段进行校验
Oct 17 #Javascript
Vue绑定内联样式问题
Oct 17 #Javascript
You might like
php中curl和file_get_content的区别
2014/05/10 PHP
php封装实现钉钉机器人报警接口的示例代码
2020/08/08 PHP
Jquery跨域获得Json时invalid label错误的解决办法
2011/01/11 Javascript
javascript测试题练习代码
2012/10/10 Javascript
Javascript中引用示例介绍
2014/02/21 Javascript
当达到输入长度时表单自动切换焦点
2014/04/06 Javascript
JS获取图片高度宽度的方法分享
2015/04/17 Javascript
深入浅析AngularJS和DataModel
2016/02/16 Javascript
JavaScript面试开发常用的知识点总结
2016/08/08 Javascript
Node.js配合node-http-proxy解决本地开发ajax跨域问题
2016/08/31 Javascript
网页瀑布流布局jQuery实现代码
2016/10/21 Javascript
使用JS代码实现点击按钮下载文件
2016/11/12 Javascript
详解nodejs操作mongodb数据库封装DB类
2017/04/10 NodeJs
vue-lazyload使用总结(推荐)
2018/11/01 Javascript
Vue 组件参数校验与非props特性的方法
2019/02/12 Javascript
解决layui追加或者动态修改的表单元素“没效果”的问题
2019/09/18 Javascript
Python列表常见操作详解(获取,增加,删除,修改,排序等)
2019/02/18 Python
Python爬虫解析网页的4种方式实例及原理解析
2019/12/30 Python
配置python的编程环境之Anaconda + VSCode的教程
2020/03/29 Python
Django-xadmin+rule对象级权限的实现方式
2020/03/30 Python
python使用信号量动态更新配置文件的操作
2020/04/01 Python
python小白学习包管理器pip安装
2020/06/09 Python
科尔士百货公司官网:Kohl’s
2016/07/11 全球购物
介绍一下Python下range()函数的用法
2013/11/07 面试题
大学军训通讯稿
2014/01/13 职场文书
初一地理教学反思
2014/01/16 职场文书
医科大学毕业生自荐信
2014/02/03 职场文书
《满井游记》教学反思
2014/02/26 职场文书
交通事故赔偿协议书
2014/04/15 职场文书
公安机关党的群众路线教育实践活动剖析材料
2014/10/10 职场文书
2014年教研工作总结
2014/12/06 职场文书
先进工作者个人总结
2015/02/15 职场文书
初中体育课教学反思
2016/02/16 职场文书
python 算法题——快乐数的多种解法
2021/05/27 Python
Python pandas之求和运算和非空值个数统计
2021/08/07 Python
在MySQL中你成功的避开了所有索引
2022/04/20 MySQL