JavaScript 实现类似Express的中间件系统(实例详解)

更新时间：2023年02月14日 15:44:11 作者：锋利的绵羊

在 Express 中可以给一个请求设置若干个中间件，在处理响应时会按顺序执行这些中间件，正在执行的中间件可以控制是否执行下一个中间件，这篇文章主要介绍了JavaScript 实现类似Express的中间件系统的相关资料,需要的朋友可以参考下

Express 的中间件系统

在 Express 中可以给一个请求设置若干个中间件，在处理响应时会按顺序执行这些中间件，正在执行的中间件可以控制是否执行下一个中间件。

模拟实现的 Express 将拥有这些功能：

Express 类拥有三个实例方法： run(url) 开始执行中间件，接收 url。
use(fn) 设置应用中间件，在路由中间件之前执行。
get(url, fn) 设置路由中间件，只在 url 与请求路由一致时执行。
fn 的定义为：(req:any, res:any, next) => void。
在 fn 中调用 next() 方法执行下一个中间件。
在 fn 中调用 res.end(response) 方法后将本次响应值为 response 并且不再执行后续中间件。
req 和 res 会逐层传递，可以被修改。
调用 run(url) 方法后开始执行中间件。
如果没有注册对应的路由中间件，则只执行应用中间件。
如果有对应的路由中间件，则先执行应用中间件后执行路由中间件。
中间件按照注册顺序执行。

大概的使用方式如下：

class Express {}

const app = new Express();

app.use(function (req, res, next) {
  console.log("mid");
  next();
});

app.use(function (req, res, next) {
  console.log("mid");
  next();
});

app.get("/home", function (req, res, next) {
  console.log("page home");
  next();
});

app.get("/detail", function (req, res, next) {
  console.log("page detail");
  next();
});

app.run("/home");

实现代码

const appMiddlewareKey = Symbol("app_middleware");
class Express {
  constructor() {
    this.middleware = {};
  }

  use(fn) {
    this.get(appMiddlewareKey, fn);
  }

  get(url, fn) {
    if (!this.middleware[url]) {
      this.middleware[url] = [];
    }

    function wrap(ctx) {
      return new Promise((resolve, reject) => {
        ctx.res.end = (response) => {
          reject(response);
        };
        try {
          const result = fn(ctx.req, ctx.res, () => {
            resolve(ctx);
          });
          if (result instanceof Promise) {
            result.catch(reject);
          }
        } catch (error) {
          reject(error);
        }
      });
    }

    this.middleware[url].push(wrap);
  }

  run(url) {
    const chain = [].concat(this.middleware[appMiddlewareKey]);
    const route = this.middleware[url];
    if (route) {
      chain.push(...route);
    }
    const ctx = {
      req: {
        url,
      },
      res: {},
    };

    let promise = Promise.resolve(ctx);
    chain.forEach((middleware) => {
      promise = promise.then(middleware);
    });
    return promise.then((ctx) => ctx.res);
  }
}

如何实现异步执行链

在调用 use() 方法或 get() 方法设置中间件时，将传入的回调函数包装成一个返回 Promise 对象的新函数。

function wrap(ctx) {
  return new Promise((resolve, reject) => {
    // 提供停止执行中间件的方法
    ctx.res.end = (response) => {
      reject(response);
    };
    try {
      const result = fn(ctx.req, ctx.res, () => {
        resolve(ctx);
      });
      if (result instanceof Promise) {
        result.catch(reject); // 如果传入中间件回调返回值为 Promise
      }
    } catch (error) {
      reject(error);
    }
  });
}
this.middleware[url].push(wrap);

在调用 .run() 方法时，先根据传入的 url 决定要执行的中间件，然后遍历中间件列表，拼接成一个 Promise 链。

let promise = Promise.resolve(ctx);
chain.forEach((middleware) => {
  promise = promise.then(middleware);
});

如何将控制权交给中间件函数

wrap() 方法中，给实际的中间件函数传递一个方法，这个方法调用后 wrap() 返回的 Promise 才会被 resolve，这个方法就是 next() 方法。

const result = fn(ctx.req, ctx.res, () => {
  resolve(ctx);
});

使用示例

应用级中间件与路由级中间件

用 use() 绑定的中间件为应用级中间件，用 get() 绑定的为路由级中间件。应用级中间件总是会执行，只调用 .run() 方法接收到的对应 url 的路由中间件。

以下例子不调用 /detail 的路由中间件。

app.use(function (req, res, next) {
  res.name = "zhangkb";
  next();
});

app.get("/home", function (req, res, next) {
  console.log("page home", req);
  next();
});

app.get("/detail", function (req, res, next) {
  console.log("page home", req);
  next();
});

app.run("/home");

.run() 的返回值与异常处理

.run() 方法返回一个 Promise 对象，如果所有中间件都执行完毕无异常则返回 res 对象：

app.use(function (req, res, next) {
  res.name = "zhangkb";
  next();
});

app.run("/").then((res) => {
  console.log("success", res);
});

如果在中间件中用 throw 关键字抛出异常或者调用 res.end() 方法，则会停止执行后续中间件，并将抛出的异常对象（或 res.end() 的参数）作为 Promise 的失败原因。

app.use(function (req, res, next) {
  res.name = "zhangkb";
  res.end(new Error("reason")); // 主动停止
  throw new Error("reason"); // 抛出异常
  next();
});

app.run("/").catch((error) => {
  console.log("error", error);
});

到此这篇关于JavaScript 实现类似Express的中间件系统的文章就介绍到这了,更多相关js Express的中间件系统内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

js学习总结_轮播图之渐隐渐现版(实例讲解)
下面小编就为大家带来一篇js学习总结_轮播图之渐隐渐现版(实例讲解)。小编觉得挺不错的，现在就分享给大家，也给大家做个参考。一起跟随小编过来看看吧
2017-07-07
快速对接payjq的个人微信支付接口过程解析
这篇文章主要介绍了快速对接payjq的个人微信支付接口过程解析,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
2019-08-08
JavaScript中this详解
都说 JavaScript 是一种很灵活的语言，这其实也可以说它是一个混乱的语言。它把函数式编程和面向对象编程糅合一起，再加上动态语言特性，简直强大无比，下面小编给大家介绍Javascript中this详解，需要的小伙伴可以来参考下
2015-09-09
老生常谈js中0到底是 true 还是 false
下面小编就为大家带来一篇老生常谈js中0到底是 true 还是 false。小编觉得挺不错的，现在就分享给大家，也给大家做个参考。一起跟随小编过来看看吧
2017-03-03
完美的js图片轮换效果
这篇文章主要为大家详细介绍了完美的js图片轮换效果，包括左右移动和缓动效果，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2017-02-02
理解JavaScript中的事件
理解JavaScript中的事件...
2006-09-09
ES6新数据结构Set与WeakSet用法分析
这篇文章主要介绍了ES6新数据结构Set与WeakSet用法,结合实例形式简单分析了Set与WeakSet的功能、使用方法及相关注意事项,需要的朋友可以参考下
2017-03-03
Echarts图例组件的属性与源代码
图例组件展现了不同系列的标记(symbol),颜色和名字,可以通过点击图例控制哪些系列不显示,这篇文章主要给大家介绍了关于Echarts图例组件的相关资料,需要的朋友可以参考下
2021-06-06
webpack的pitching loader详解
这篇文章主要介绍了webpack的pitching loader详解，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2019-09-09
js实现简单的倒计时
这篇文章主要为大家详细介绍了js实现简单的倒计时，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2021-01-01