Express.js 核心技巧：如何安全地重写 Express API 方法-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00602/article/details/148505831

Express.js 核心技巧：如何安全地重写 Express API 方法

expressjs.com 项目地址: https://gitcode.com/gh_mirrors/ex/expressjs.com

作为 Node.js 最流行的 Web 框架之一，Express.js 提供了灵活且可扩展的 API 设计。本文将深入探讨 Express API 的重写机制，帮助开发者在不修改框架源码的情况下，实现对核心 API 的自定义扩展。

理解 Express API 的继承机制

Express 的请求(request)和响应(response)对象上的方法和属性都是通过原型链(prototype)继承实现的。这种设计为开发者提供了两个关键的扩展点：

全局原型：位于 express.request 和 express.response
应用级原型：位于 app.request 和 app.response

全局 vs 应用级修改

修改全局原型会影响同一进程中所有加载的 Express 应用。如果只需要修改特定应用的行为，建议在创建应用后仅修改该应用的原型，这样可以避免意外的副作用。

方法重写实战

开发者可以完全重写现有方法的行为和签名。下面是一个重写 res.sendStatus 方法的示例：

app.response.sendStatus = function (statusCode, type, message) {
  // 这里保持简单以方便演示
  return this.contentType(type)
    .status(statusCode)
    .send(message)
}

这个实现完全改变了原始 res.sendStatus 的签名，现在它接受三个参数：状态码、内容类型和要发送给客户端的消息。

重写后的方法可以这样使用：

res.sendStatus(404, 'application/json', '{"error":"resource not found"}')

重写时的注意事项

确保新方法签名清晰明了
考虑向后兼容性
在文档中明确记录修改
考虑性能影响

属性重写技巧

Express API 中的属性分为两类：

动态赋值属性：如 req.baseUrl, req.originalUrl 等
Getter 定义属性：如 req.secure, req.ip 等

第一类属性无法被重写，因为它们在请求-响应周期中动态赋值。第二类属性可以使用 JavaScript 的 Object.defineProperty 进行重写。

属性重写示例

下面的代码展示了如何重写 req.ip 属性的获取逻辑，使其直接从 Client-IP 请求头中获取值：

Object.defineProperty(app.request, 'ip', {
  configurable: true,
  enumerable: true,
  get() { return this.get('Client-IP') }
})

原型链修改高级技巧

Express 的请求和响应对象需要继承特定的原型链才能正常工作。默认情况下，请求对象继承自 http.IncomingRequest.prototype，响应对象继承自 http.ServerResponse.prototype。

修改原型链的注意事项

谨慎修改全局原型：除非必要，否则建议仅在应用级别进行修改
保持功能一致性：新原型应尽可能与默认原型功能一致
考虑中间件兼容性：某些中间件可能依赖默认原型行为

// 使用 FakeRequest 和 FakeResponse 替代默认的 http 原型
// 仅针对特定应用
Object.setPrototypeOf(Object.getPrototypeOf(app.request), FakeRequest.prototype)
Object.setPrototypeOf(Object.getPrototypeOf(app.response), FakeResponse.prototype)