Node.js / Express.js - 如何覆盖/拦截 res.render 函数？

Question

我正在使用 Connect/Express.js 构建一个 Node.js 应用程序，我想拦截 res.render(view, option) 函数以在将其转发到原始渲染函数之前运行一些代码。

app.get('/someUrl', function(req, res) {

    res.render = function(view, options, callback) {
        view = 'testViews/' + view;
        res.prototype.render(view, options, callback);
    };

    res.render('index', { title: 'Hello world' });
});

这看起来像是一个人为的例子，但它确实适合我正在构建的整体框架。

我对 JavaScript 上的 OOP 和原型继承的了解有点薄弱。我该怎么做这样的事情？

---

更新：经过一些实验，我想出了以下内容：

app.get('/someUrl', function(req, res) {

    var response = {};

    response.prototype = res;

    response.render = function(view, opts, fn, parent, sub){
        view = 'testViews/' + view;
        this.prototype.render(view, opts, fn, parent, sub);
    };

    response.render('index', { title: 'Hello world' });
});

它似乎工作。不确定这是否是最佳解决方案，因为我正在为每个请求创建一个新的响应包装对象，这会是一个问题吗？

Answer 1

response 对象没有原型。这应该可行（采用 Ryan 将其放入中间件的想法）：

var wrapRender = function(req, res, next) {
  var _render = res.render;
  res.render = function(view, options, callback) {
    _render.call(res, "testViews/" + view, options, callback);
  };
};

但是，破解 ServerResponse.prototype 可能会更好：

var express = require("express")
  , http = require("http")
  , response = http.ServerResponse.prototype
  , _render = response.render;

response.render = function(view, options, callback) {
  _render.call(this, "testViews/" + view, options, callback);
};

Answer 2

老问题，但发现自己问同样的问题。如何拦截 res 渲染？ 现在使用 express 4.0x 的东西。

您可以使用/编写中间件。这个概念起初对我来说有点令人生畏，但经过一些阅读之后，它变得更有意义了。对于其他阅读本文的人来说，重写 res.render 的动机是提供全局视图变量。我希望session 在我的所有模板中都可用，而不必在每个 res 对象中输入它。

基本的中间件格式是。

app.use( function( req, res, next ) {
    //....
    next();
} );

下一个参数和函数调用对于执行至关重要。 next 是回调函数，允许多个中间件在不阻塞的情况下做他们的事情。为了更好的explanation read here

这可以用来覆盖渲染逻辑

app.use( function( req, res, next ) {
    // grab reference of render
    var _render = res.render;
    // override logic
    res.render = function( view, options, fn ) {
        // do some custom logic
        _.extend( options, {session: true} );
        // continue with original render
        _render.call( this, view, options, fn );
    }
    next();
} );

我已经使用 express 3.0.6 测试了这段代码。它应该可以毫无问题地与 4.x 一起使用。 您还可以使用

覆盖特定的 URL 组合

app.use( '/myspcificurl', function( req, res, next ) {...} );

Answer 3

使用中间件来覆盖它们的每个实例的响应或请求方法并不是一个好主意，因为中间件会针对每个请求执行，并且每次调用它时都会使用 CPU 和内存，因为你正在创建一个新函数。

您可能知道 javascript 是一种基于原型的语言，每个对象都有一个原型，例如响应和请求对象。通过查看代码（express 4.13.4），您可以找到它们的原型：

req => express.request
res => express.response

因此，当您想为响应的每个实例覆盖一个方法时，最好在它的原型中覆盖它，因为它在每个响应实例中都可用：

var app = (global.express = require('express'))();
var render = express.response.render;
express.response.render = function(view, options, callback) {
    // desired code
    /** here this refer to the current res instance and you can even access req for this res: **/
    console.log(this.req);
    render.apply(this, arguments);
};

Answer 4

我最近发现自己需要做同样的事情，为我的每个模板提供特定于配置的 Google Analytics（分析）属性 ID 和 cookie 域。

这里有很多很棒的解决方案。

我选择采用与 Lex 提出的解决方案非常接近的方法，但遇到了调用 res.render() 尚未包含现有选项的问题。例如，以下代码在调用 extend() 时导致异常，因为未定义选项：

return res.render('admin/refreshes');

我添加了以下内容，它解释了可能的各种参数组合，包括回调。其他人提出的解决方案也可以使用类似的方法。

app.use(function(req, res, next) {
  var _render = res.render;
  res.render = function(view, options, callback) {
    if (typeof options === 'function') {
      callback = options;
      options = {};
    } else if (!options) {
      options = {};
    }
    extend(options, {
      gaPropertyID: config.googleAnalytics.propertyID,
      gaCookieDomain: config.googleAnalytics.cookieDomain
    });
    _render.call(this, view, options, callback);
  }
  next();
});

编辑： 事实证明，当我需要实际运行一些代码时，这一切可能会很方便，但有一种非常简单的方法可以完成我想要做的事情。我再次查看了 Express 的源代码和文档，结果发现 app.locals 用于渲染每个模板。因此，就我而言，我最终将上面所有的中间件代码替换为以下分配：

app.locals.gaPropertyID = config.googleAnalytics.propertyID;
app.locals.gaCookieDomain = config.googleAnalytics.cookieDomain;