您的位置:首页 > 其它

ArtTemplate的简单介绍

2015-08-03 23:01 441 查看


特性

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


快速上手


编写模板

使用一个
type="text/html"
script
标签存放模板:
<script id="test" type="text/html">
<h1>{{title}}</h1>
<ul>
{{each list as value i}}
<li>索引 {{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<list.length;i++) {%>
<div><%=i%>. <%=list[i].user%></div>
<%}%>
<%}%>


查看语法与演示


下载

template.js (简洁语法版, 2.7kb)
template-native.js (原生语法版, 2.3kb)


方法


template(id,
data)

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

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


template.
compile
(source,
options)

将返回一个渲染函数。演示


template.
render
(source,
options)

将返回渲染结果。


template.
helper
(name,
callback)

添加辅助方法。

例如时间格式器:演示


template.
config
(name,
value)

更改引擎的默认配置。
字段类型默认值说明
openTagString
'{{'
逻辑语法开始标签
closeTagString
"}}"
逻辑语法结束标签
escapeBoolean
true
是否编码输出 HTML 字符
cacheBoolean
true
是否开启缓存(依赖 options 的 filename 字段)
compressBoolean
false
是否压缩 HTML 多余空白字符


使用预编译

可突破浏览器限制,让前端模板拥有后端模板一样的同步“文件”加载能力:

一、按文件与目录组织模板
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 版本新增了如下默认配置:
字段类型默认值说明
pathString
''
指定模板目录
extnameString
'.html'
指定模板后缀名
encodingString
'utf-8'
指定模板编码
配置
path
指定模板目录可以缩短模板的路径,并且能够避免
include
语句越级访问任意路径引发安全隐患,例如:
template.config('path', __dirname);
var html = template('index/main', data)


扩展:


Web模板引擎——Mustache


Web 模板引擎是为了使用户界面与业务数据(内容)分离而产生的,它可以生成特定格式的文档,通常是标准的
HTML 文档。当然不同的开发语言有不同模板引擎,如 Javascript 下的 Hogan 、ASP 下的 aspTemplate、以及 PHP 下的 Smarty,这里主要介绍基于 Javascript 语言的模板引擎,目前流行有 Mustache、Hogan、doT.js、JsRender、Kendo UI Templates等,jsperf.com 上可以看到它们的性能对比,首先先介绍下 Mustache


一、Mustache 简介:

Mustache 是一个 logic-less (轻逻辑)模板解析引擎,它的优势在于可以应用在 Javascript、PHP、Python、Perl 等多种编程语言中。


二、Mustache 语法:

Mustache 的模板语法很简单,就那么几个:
{{keyName}}
{{#keyName}} {{/keyName}}
{{^keyName}} {{/keyName}}
{{.}}
{{<partials}}
{{{keyName}}}
{{!comments}}
这里将以 javascript 应用为例进行介绍,先来看个 Demo:
...
<script type="text/javascript" src="mustache.js"></script>
<script type="text/javascript">
var data = {
"company": "Apple",
"address": {
"street": "1 Infinite Loop Cupertino</br>",
"city": "California ",
"state": "CA ",
"zip": "95014 "
},
"product": ["Macbook ","iPhone ","iPod ","iPad "]
}

var tpl = '<h1>Hello {{company}}</h1>';
var html = Mustache.render(tpl, data);

console.log( html )
</script>
...

//运行后 Console 输出:

<h1>Hello Apple</h1>

在 Demo 中可以看到 data 是数据,tpl 是定义的模板,
Mustache.render(tpl,
data)
方法是用于渲染输出最终的 HTML 代码。
借助 Demo 来对语法做简单的介绍:


{{keyName}}

{{}}
就是 Mustache 的标示符,花括号里的 keyName
表示键名,这句的作用是直接输出与键名匹配的键值,例如:
var tpl = '{{company}}';
var html = Mustache.render(tpl, data);
//输出:
Apple


{{#keyName}} {{/keyName}}

#
开始、以
/
结束表示区块,它会根据当前上下文中的键值来对区块进行一次或多次渲染,例如改写下
Demo 中的 tpl:
var tpl = '{{#address}} <p>{{street}},{{city}},{{state}}</p> {{/address}}';
var html = Mustache.render(tpl, data);

//输出:
<p>1 Infinite Loop Cupertino</br>,California,CA</p>

注意:如果
{{#keyName}} {{/keyName}}
中的
keyName 值为 null, undefined, false;则不渲染输出任何内容。


{{^keyName}} {{/keyName}}

该语法与
{{#keyName}} {{/keyName}}
类似,不同在于它是当
keyName 值为 null, undefined, false 时才渲染输出该区块内容。
var tpl = {{^nothing}}没找到 nothing 键名就会渲染这段{{/nothing}};
var html = Mustache.render(tpl, data);
//输出:
没找到 nothing 键名就会渲染这段


{{.}}

{{.}}
表示枚举,可以循环输出整个数组,例如:
var tpl = '{{#product}} <p>{{.}}</p> {{/product}}';
var html = Mustache.render(tpl, data);
//输出:
<p>Macbook </p> <p>iPhone </p> <p>iPod </p> <p>iPad </p>


{{>partials}}

>
开始表示子模块,如{{> address}};当结构比较复杂时,我们可以使用该语法将复杂的结构拆分成几个小的子模块,例如:
var tpl = "<h1>{{company}}</h1> <ul>{{>address}}</ul>"
var partials = {address: "{{#address}}<li>{{street}}</li><li>{{city}}</li><li>{{state}}</li><li>{{zip}}</li>{{/address}}"}
var html = Mustache.render(tpl, data, partials);
//输出:
<h1>Apple</h1>
<ul><li>1 Infinite Loop Cupertino</br></li><li>California</li><li>CA</li><li>95014</li></ul>


{{{keyName}}}

{{keyName}}
输出会将等特殊字符转译,如果想保持内容原样输出可以使用
{{{}}}
,例如:
var tpl = '{{#address}} <p>{{{street}}}</p> {{/address}}'
//输出:
<p>1 Infinite Loop Cupertino</br></p>


{{!comments}}

!
表示注释,注释后不会渲染输出任何内容。
{{!这里是注释}}
//输出:


 
内容来自用户分享和网络整理,不保证内容的准确性,如有侵权内容,可联系管理员处理 点击这里给我发消息
标签:  ArtTemplate