第54章 模板系统详解
渲染引擎
工作原理
每个页面都对应一个 API 调用、一个模板文件和一个语言文件。
例如,当你访问 /topic/351/nodebb-wiki 时,应用程序会加载三个资源:API 返回数据 /api/topic/351/nodebb-wiki,本例中的模板文件 topic.tpl,以及相应的语言文件 topic.json*
只需在 URL 路径前加上 api/ 即可获取对应的 JSON 返回数据。API 返回中的任何值都可以在模板中使用。
*页面名称对应模板和语言文件的文件名(例如 http://domain.com/topic/xyz 对应 topic.tpl)。
模板基础
以 API 返回数据为参考,你可以在模板逻辑中使用这些值的任意部分。以上述 API 调用为例,访问返回数据根级别的值可以这样做:
{title}
访问对象中的值:
{privileges.read}
最后,你可以遍历数组并创建块,如下所示:
{{{ each posts }}}
{{posts.content}}
{{{ end }}}
上述代码会为 posts 数组中的每一项生成对应的块副本。
单花括号 {} 会对变量进行 HTML 转义,双花括号 {{}} 不进行转义并直接输出原始内容。
如果 {{}} 使用的值来自不可信来源,请确保已对其进行消毒处理。
模板逻辑
NodeBB 的模板系统实现了一些基本逻辑。继续以上面的 API 调用为例,你可以编写 IF 条件语句如下:
{{{ if unreplied }}}
This thread is unreplied!
{{{ end }}}
另一个例子:
{{{ if !disableSocialButtons }}}
{{{ else }}}
Sharing has been disabled.
{{{ end }}}
检查数组长度可以这样做:
{{{ if posts.length }}}
There be some posts
{{{ end }}}
在遍历数组时,可以通过 @first 或 @last 检查当前索引是否为首位或末位,如下所示:
{{{ each posts }}}
{{{ if @first }}}
{{{ end }}}
{posts.content}
{{{ if @last }}}
End of posts. Click here to scroll to the top.
{{{ end }}}
{{{ end }}}
关于更多高级文档,请查看 bencpressjs 仓库
向客户端 JavaScript 暴露模板变量
让 JavaScript 了解服务端数据有两种方式:
通过 jQuery.get
如果需要来自其他页面的数据,我们可以向任何 API 调用发起 $.get 请求。例如,如果想了解特定用户更多信息,可以这样调用:
$.get(config.relative_path + '/api/user/psychobunny', {}, function(user) {
console.log(user)
});
查看此 API 调用的实际效果:http://community.nodebb.org/api/user/psychobunny
通过模板变量
在每个页面上,用于渲染该页面的数据都存储在 ajaxify.data 中。例如,在主题页面中,可以通过 ajaxify.data.title 访问主题标题,或通过 ajaxify.data.cid 访问分类 ID。
国际化
模板引擎同样与国际化的系统进行了交互。我们可以在语言字符串中嵌入变量。让我们使用这个 API 调用和语言文件作为示例。现在可以这样做:
{{tx("register:help.username_restrictions", minimumUsernameLength, maximumUsernameLength)}}
这将把字符串: A unique username between %1 and %2 characters 翻译为: A unique username between 2 and 16 characters
高级主题
从客户端 JavaScript 动态引入和渲染模板文件
模板引擎会按需懒加载模板并对其进行缓存。如果代码需要临时调用某个模板或局部文件,可以这样做:
ajaxify.loadTemplate('myTemplate', function(myTemplate) {
var html = templates.parse(myTemplate, myData);
});
你还可以访问每个模板内部的各个块,这在执行某些操作时非常有用,例如渲染新帖的 <li> 并将其动态插入已加载的 <ul> 中。
Some stuff here...
{{{ each posts }}}
We just want to pull this block only.
{{{ end }}}
... some stuff here
ajaxify.loadTemplate('myTemplate', function(myTemplate) {
var block = templates.getBlock(myTemplate, 'posts');
var html = templates.parse(block, myData);
});
在服务端 Node.js 中渲染模板
模板系统像大多数其他模板框架一样集成到 Express 中。只需使用 app.render 或 res.render 来解析相应的模板。
res.render('myTemplate', myData);
app.render('myTemplate', myData, function(err, parsedTemplate) {
console.log(parsedTemplate);
});