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

作者:慢半拍时间:2026-10-26 10:34:02浏览:174

本文详解如何使用 JavaScript 模拟实现类似 Express 的中间件系统。通过解析应用级与路由级中间件的注册机制、利用 Promise 链处理异步执行流程,以及 next 函数对执行权的控制,展示了完整的中间件运行原理与异常处理机制。

Express 的中间件系统

在 Express 框架中,开发者可以为请求配置多个中间件。这些中间件在处理响应时按注册顺序依次执行,且当前正在执行的中间件拥有控制权,可以决定是否继续执行后续的中间件。

本模拟实现的 Express 框架具备以下核心功能:

  • Express 类提供三个实例方法: run(url) 用于启动中间件执行流程,接收请求的 url 参数。
  • use(fn) 用于注册应用级中间件,这类中间件会在所有路由中间件之前执行。
  • get(url, fn) 用于注册路由级中间件,仅在 url 与当前请求的 url 匹配时才会执行。
  • fn 函数的类型定义为:(req:any, res:any, next) => void。
  • 在 fn 函数内部,通过调用 next() 方法来触发并执行下一个中间件。
  • 在 fn 函数内部,调用 res.end(response) 方法后将本次响应值设置为 response,并且立即终止后续中间件的执行。
  • req 和 res 对象会逐层传递给各个中间件,且允许在中间件中对其进行修改。
  • 通过调用 run(url) 方法即可开始执行已注册的中间件。
  • 如果未注册与请求 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的中间件系统内容请搜索本站以前的文章或继续浏览下面的相关文章希望大家以后多多支持本站!

作者最新文章