精华 翻译:为什么你应该抛弃Express的视图渲染引擎
发布于 7 年前 作者 pockry 16146 次浏览 最后一次编辑是 5 年前 来自 分享

翻译自StrongLoop Blog, 作者:Patrick Steele-Idem。你也可以到我的博客看本文。

Nodejs Express框架的一个被人们广为使用的特性是它的渲染引擎。Express视图渲染引擎允许Controller提供一个视图名称和视图模型对象给Express,然后返回由HTTP响应流输出的一些字节。基于为eBay的Nodejs技术栈提供支持所获得的经验,我们发现了这个方法的缺点并决定彻底的弃用它。我们这么做了之后,能明显看到页面加载速度的提升、更好的模块性以及开发者生产力的提高。本文将解释为什么你不应该使用Express视图渲染引擎,并提供一个推荐的替代方案。

Express视图渲染引擎

在解释Express视图渲染引擎的缺点之前,让我们先来快速的过一遍它的用法。首先你必须使用类似下面的代码来配置你的Express app:

app.set('views', path.join(__dirname, 'views'));
app.set('view engine', 'jade');

第一行代码告诉Express在views目录下搜索所有模板,第二行则在这些模板上应用jade模板引擎。

配置好之后,你能在Controller中使用res.render(viewName, viewModel)方法来渲染视图,代码如下:

app.get('/', function (req, res) {
  res.render('index', { title: 'Hey', message: 'Hello there!'});
})

这里面的机制是,Express将视图名称对应到模板文件的路径,使用关联的模板引擎来渲染模板,将结果输出到response,最后结束响应。

不好的地方

这个方法看起来如此简单,你可能从来没想过它会出错。但实际上它还是有不少问题,当出问题时会影响web程序性能和可维护性,下面我们讲到这些。

破坏模块性

Express强制性的要求设置一个views目录,所有模板都堆放在这里。本来你可以将模板放到Controller或使用这些模板的UI组件附近,现在你不得不将它们放到一个单独的顶级目录里。一个典型的基于Express的项目,它的目录结构将会与下面类似:

    routes/
        home.js
        login.js
        …
    views/
        home.jade
        login.jade
        …

使用Express推荐的目录结构,你不得不将源码按照类型而非特性来分来。作为结果,紧密相关的文件将被分离到截然不同的目录树里面,这意味着如果你需要修改一个功能,你可能需要遍历整个项目的目录以修改不同的文件。在后面的替代方案里我会介绍一个更健康的、模块化的目录结构。

与Express高度耦合

当使用Express视图渲染引擎,意味着你在使用一个与Express高度耦合的特性。如果你想在客户端渲染一个模板呢?如何解析局部模板?如果你想切换到另一个web框架或者不使用框架呢?事实是,Express引入的这个解析和渲染模板的新方法,只能在服务端并且只能在Express中使用。当构建同构(isomorphic)web app时,我们希望在服务端和客户端使用更一致的渲染模板的方法。

没有Streaming

Express视图渲染引擎不支持streaming(流式传输),这对于客户端和服务端两方的性能都有负面影响。在服务端,当渲染一个HTML页面模板时,整个HTML输出都被当做一个超长的字符串存储在内存里,当整个HTML输出都构造完成之后,才开始向HTML响应里输出第一个字节。这是因为所有的视图引擎都必须使用回调来实现。而只有当整个HTML都被渲染完毕,回调才会被调用。不使用streaming来输出HTML,我们将浪费服务端的内存,以及增加客户端等待响应的时间。

使用streaming来传输响应的好处还包括,更早的发送页面的<head>部分,因此客户端能够更快的下载页面的CSS文件。为了感受streaming带来的好处,你需要使用支持streaming的模板引擎。此外,支持异步渲染的模板引擎(如MarkoDustNunjucks)甚至能够在视图模型构造完成之前就输出响应,因此能带来更多的性能提升。

集中式的配置

并不是所有的配置都不好,但不必要的配置是不好的。如果应用不同的地方需要不用的配置,集中式的配置将引起冲突。比如,如果需要多个view目录呢?Express的sub-apps能在一定程度上解决这个问题,但最好的办法的还是避免额外的配置。

解决办法

Express将它自己描述为一个框架,那么绕过Express视图渲染引擎实际上还是很容易的。这将让开发者创造更灵活的、易理解的和更高性的应用。首先你必须理解一个重要的概念,res对象实际上是一个可写的HTTP响应流(尽管它已经被Express重度修改过),因此你能够直接向响应里输出:

app.get('/', function (req, res) {
    res.write('Hello Frank');
    res.end();
});

如果你想渲染一个jade模板到HTTP响应,你可以照下面做:

var templatePath = require.resolve('./template.jade');
var templateFn = require('jade').compileFile(templatePath);

app.get('/', function (req, res) {
    res.write(templateFn({name: 'Frank'});
    res.end();
});

这个方法比起res.render()有些啰嗦,但它很直观也更灵活。

注意:你可能注意到我们使用了require.resolve来获得模板的绝对路径,这个模板和我们的Controller模块放在一起。

如果你的模板引擎支持输出到一个流,代码将会更简单。比如Marko模板引擎的代码如下:

var templatePath = require.resolve('./template.marko');
var template = require('marko').load(templatePath);

app.get('/', function (req, res) {
    template.render({name: 'Frank'}, res);
});

视图解析程序

如果你觉得你的app需要使用视图解析程序(比如你需要为A/B测试使用不同的模板,或者根据用户的地区来确定模板),也有一个非常干净的解决办法。下面的代码假想了一个独立于Express的视图解析程序,它是如何根据名称和一些上下文(本例中是请求和当前目录)来解析视图模板的。

var myViewResolver = require('my-view-resolver');

app.get('/', function (req, res) {
    var template = myViewResolver.resolve('hello', req, __dirname);
    template.render({name: 'Frank'}, res);
});

使用一个明确的视图解析程序能让代码更容易理解,并提供更高的灵活度。

项目结构

现在你可以不受只能有一个views目录的限制了。让我们来看看新的项目结构:

    pages/
        home/
            index.js
            style.css
            template.marko
        login/
            index.js
            style.css
            template.marko

新的项目结构让关联的文件放在相同的目录,从此之后可以模块化的开发和维护项目了。

总结

尽管Express是一个极简主义的框架,但也没有必要一定要使用它所有的特性。有些时候独立的模块能比它做得更好。Nodejs其中的一条指导原则就是“模块应该只做一件事并把它做好”,并且我认为Express将诸如视图渲染和路由这些特性分离开来会更好。我们已经看到Express 4.x里分离了不少核心的中间件,我认为还应该更进一步。也许我们根本不需要一个框架。也许我们只需要一些在一起工作良好的模块就行。

希望现在你对于绕过Express视图渲染的好处已经明了于心了,如果你想看看具体的示例,可以看这里的示例程序。这里还有更大型的天气示例应用可供参考,希望能对你有所帮助。

14 回复

Express强制性的要求设置一个views目录

关于上面这一点我不认同,你一样可以把目录设在根目录爱怎么玩怎么玩。但是实际上按分类摆放文件的形式应该更符合逻辑或者语义一些。本来就应该逻辑和渲染分离,你又把他们放在一起是闹哪样。

至于所谓的前端渲染,那就更没有关系了。你就算把它单独罗列,怎么就破坏前端渲染了?说实话“新”的目录结构不是特别敢恭维的——至少是我的主观意见,模块化感觉不是这么个模块化的方法的。

没有 Streaming 这点倒是的确。

最后其实感觉原作者有些强拉硬扯,非要把这东西说得很不好,有些误导之嫌,好像是为了说它的渲染机制不好而说的。让新手理解渲染机制倒是真的,说真这样有点不应该了。不过有可能是我自己太唯心了,上面说得都是我个人的主观观点而已。

@xadillax 你说的也有道理,原作者说的模块化应该是项目的模块化吧,它这种结构用在小项目上的确有点怪怪的,但如果是非常大的项目,那么就很有必要按照功能来模块化了。

@pockry 模块化也是建立在类型基础上的,不然杂糅起来很难看也不好扩展。

a再大点要考虑的不仅仅是模块化了,要开始服务化了。

没看出新的方案有啥不一样

做了一半的bigpipe,有点标题党了

@yeaha 哈哈,原来的标题气势太不足就自己给换了个。

在做一个Bigpipe渲染模块,基于Hogan(mustache)模板引擎,你会看到

function curry () {...}
var view = require('bigpipe').View(__dirname + '/tpl/page');
var app = require('express')();
var routes = require('./lib/routes');
var pool = require('mysql').createPool(...);
app.get('/product', curry(routes.index)(pool, view))
	   ...
	   ;

// 加入页面缓存
view
    .option('/product.tpl', {
        partial: {
	        header: '/header.tpl',
		    footer: '/footer.tpl'
	    },
	    options: {
	        relative_path: 'http://127.0.0.1',
	        title: 'Product',
		    css: require('bigpipe').css('/css/base.css', '/css/my.css'),
		    js: require('bigpipe').js('/js/jquery.js', 'async:/js/ttt.js')
	    }
    })
    .option('/store.tpl', {
        partial: {
	        header: '/header.tpl',
		    footer: '/footer.tpl'
	    },
	    options: {
	        relative_path: 'http://127.0.0.1',
	        title: 'Store',
		    css: require('bigpipe').css('/css/base.css', '/css/store.css'),
		    js: require('bigpipe').js('async:/js/new.js')
	    }
    })
    ...

// 模板预编译
require('bigpipe').compile(__dirname + '/tpl/pagelet', _dirname + 'public/js/pagelet.js');

exports.index = function (pool, view, req, res, next) {
    // chunk渲染 
    require('bigpipe').Bigpipe(view, res)
	    .page('/product.tpl')
	    .pagelet('product-list', '/product/list.tpl', function (fill) {
	       pool.query('select * from tb', function (err, result) {
		        fill(result);
		    });
	    })
	    .pagelet('msg', '/msg.tpl', function (fill) {
	        pool.query('select * from msg', function (err, result) {
		        fill(result);
		    });
	    })
	    .end();
};

有点标题党的意思, 非常庞大的项目,这种设置是比较束缚。 但是换言之,庞大的项目,早就该拆分,各模块独立发布了

@tulayang 谢谢分享,学习了,不过我觉得原作者并不是想实现一个bigpipe,他只是想绕过Express中的render从而提高一些性能,同时获得一些便利。不过项目如果再大一些可能就要bigpipe了。

@xadillax:没错,views目录的说法有点扯,spring mvc用了那么多年,也没见controller跟jsp放一块过。同样赞同流式传输的观点。

个人感觉应该纯粹将服务器当成一个内容提供者,网页构建全部让前端做,服务器只提供零件,充分利用浏览器的计算能力,给服务器减压

@yyrdl 这。。你已经跳出大家在讨论的点了

@alsotang 他们是在讨论用哪个渲染框架吗?@@

模板分开放,有利用团队svn开发 比如程序员只修改程序,美工来调页面,如果放在一个目录下,这个种适合全栈(+美工)程序员 ,这样的能招到几个?

回到顶部