artTemplate-3.0

artTemplate-3.0原文
artTemplate-3.0
新一代 javascript 模板引擎

一、特性

1.性能卓越，执行速度通常是 Mustache 与 tmpl 的 20 多倍（性能测试）
2.支持运行时调试，可精确定位异常模板所在语句（演示）
3.对 NodeJS Express 友好支持
4.安全，默认对输出进行转义、在沙箱中运行编译后的代码（Node版本可以安全执行用户上传的模板）
5.支持include语句，可在浏览器端实现按路径加载模板
6.支持预编译，可将模板转换成为非常精简的 js 文件
7.模板语句简洁，无需前缀引用数据
8.支持所有流行的浏览器

二、快速上手
编写模板

使用一个type=”text/html”的script标签存放模板：

<script id="test" type="text/html">
{{title}}</h1>

    {{each list as value i}}
        
索引 {{i + 1}} ：{{value}}</li>
    {{/each}}
</ul>
script>

渲染模板

var data = {
    title: '标签',
    list: ['文艺', '博客', '摄影', '电影', '民谣', '旅行', '吉他']
};
var html = template('test', data);
document.getElementById('content').innerHTML = html;

三、模板语法

有两个版本的模板语法可以选择。
简洁语法
推荐使用，语法简单实用，利于读写。

{{if admin}}
    {{include 'admin_content'}}

    {{each list}}
        <div>{{$index}}. {{$value.user}}div>
    {{/each}}
{{/if}}

原生语法

<%if (admin){%>
    <%include('admin_content')%>

    <%for (var i=0;i
        <div><%=i%>. <%=list[i].user%>div>
    <%}%>
<%}%>

artTemplate 简洁语法版
使用

引用简洁语法的引擎版本，例如：

<script src="dist/template.js">script>

表达式

{{ 与 }} 符号包裹起来的语句则为模板的逻辑表达式。

输出表达式
对内容编码输出：

{{content}}

不编码输出：

{{#content}}

编码可以防止数据中含有 HTML 字符串，避免引起 XSS 攻击。

条件表达式

{{if admin}}
    <p>adminp>
{{else if code > 0}}
    <p>masterp>
{{else}}
    <p>error!p>
{{/if}}

遍历表达式

无论数组或者对象都可以用 each 进行遍历。

{{each list as value index}}
    <li>{{index}} - {{value.user}}li>
{{/each}}

亦可以被简写：

{{each list}}
    <li>{{$index}} - {{$value.user}}li>
{{/each}}

模板包含表达式
用于嵌入子模板。

{{include 'template_name'}}

子模板默认共享当前数据，亦可以指定数据：

{{include 'template_name' news_list}}

辅助方法

使用template.helper(name, callback)注册公用辅助方法：

template.helper('dateFormat', function (date, format) {
    // ..
    return value;
});

模板中使用的方式：

{{time | dateFormat:'yyyy-MM-dd hh:mm:ss'}}

支持传入参数与嵌套使用：

{{time | say:'cd' | ubb | link}} 

artTemplate 原生语法版 省略。。。。

四、下载略。。。

五、方法

template(id, data)

根据 id 渲染模板。内部会根据document.getElementById(id)查找模板。

如果没有 data 参数，那么将返回一渲染函数。

template.compile(source, options)

将返回一个渲染函数。

template.render(source, options)

将返回渲染结果。

template.helper(name, callback)

添加辅助方法。

template.config(name, value)

更改引擎的默认配置。

六、使用预编译
可突破浏览器限制，让前端模板拥有后端模板一样的同步“文件”加载能力：
一、按文件与目录组织模板

template('tpl/home/main', data)

二、模板支持引入子模板

{{include '../public/header'}}

基于预编译：

可将模板转换成为非常精简的 js 文件（不依赖引擎）
使用同步模板加载接口
支持多种 js 模块输出：AMD、CMD、CommonJS
支持作为 GruntJS 插件构建
前端模板可共享给 NodeJS 执行
自动压缩打包模板

预编译工具：TmodJS

七、NodeJS
安装

npm install art-template -g

使用

var template = require('art-template');
var data = {list: ["aui", "test"]};

var html = template(__dirname + '/index/main', data);

配置

NodeJS 版本新增了如下默认配置：

配置path指定模板目录可以缩短模板的路径，并且能够避免include语句越级访问任意路径引发安全隐患，例如：

template.config('path', __dirname);
var html = template('index/main', data)

NodeJS + Express

app.register('.html', require('art-template'));

若使用 js 原生语法作为模板语法，请改用 require('art-template/node/template-native.js')

八、升级参考
为了适配 NodeJS express，artTemplate v3.0.0 接口有调整。
接口变更

默认使用简洁语法
template.render()方法的第一个参数不再是 id，而是模板字符串
使用新的配置接口template.config()并且字段名有修改
template.compile()方法不支持 id 参数
helper 方法不再强制原文输出，是否编码取决于模板语句
template.helpers 中的$string、$escape、$each已迁移到template.utils中

升级方法

如果想继续使用 js 原生语法作为模板语言，请使用 template-native.js
查找项目template.render替换为template
使用template.config(name, value)来替换以前的配置

高性能JavaScript模板引擎原理解析