文档章节

javascript 模板引擎artTemplate

lghyt
 lghyt
发布于 2016/06/14 09:55
字数 1507
阅读 210
收藏 0

artTemplate

新一代 JAVASCRIPT 模板引擎

=================

artTemplate 是新一代 javascript 模板引擎,它在 v8 中的渲染效率可接近 javascript 性能极限,在 chrome 下渲染效率测试中分别是知名引擎 Mustache 与 micro tmpl 的 25 、 32 倍(性能测试)。

引擎支持调试。若渲染中遇到错误,调试器可精确定位到产生异常的模板语句,解决前端模板难以调试的问题(详情)。

另外,artTemplate 的模板还支持使用自动化工具预编译,这一切都在 2KB(Gzip) 中实现!

快速上手

编写模板

使用一个type="text/html"script标签存放模板:
    
    <script id="test" type="text/html">
    <h1><%=title%></h1>
    <ul>
        <%for(i = 0; i < list.length; i ++) {%>
            <li>条目内容 <%=i + 1%> :<%=list[i]%></li>
        <%}%>
    </ul>
    </script>
    
模板逻辑语法开始与结束的界定符号为&lt;% 与%&gt;,若&lt;%后面紧跟=号则输出变量内容。

渲染模板

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

演示

嵌入子模板

&lt;%include(id, [data])%&gt;语句可以嵌入子模板,其中第二个参数是可选的,它默认传入当前的数据。

    <script id="test" type="text/html">
    <h1><%=title%></h1>
    <%include('list')%>
    </script>
    
    <script id="list" type="text/html">
    <ul>
        <%for(i = 0; i < list.length; i ++) {%>
            <li>条目内容 <%=i + 1%> :<%=list[i]%></li>
        <%}%>
    </ul>
    </script>
    
演示

不转义HTML

模板引擎默认数据包含的 HTML 字符进行转义以避免 XSS 漏洞,若不需要转义的地方可使用==

    <script id="test" type="text/html">
    <%==value%>
    </script>
    
若需要关闭默认转义,可以设置template.isEscape = false

演示

在js中存放模板

template.compile([id], source)将返回一个渲染函数。其中 id 参数是可选的,如果使用了 id 参数,可以使用template.render(id, data)渲染模板。

    var source =
      '<ul>'
    +    '<% for (var i = 0; i < list.length; i ++) { %>'
    +        '<li>索引 <%= i + 1 %> :<%= list[i] %></li>'
    +    '<% } %>'
    + '</ul>';
    
    var data = {
        list: ['文艺', '博客', '摄影', '电影', '民谣', '旅行', '吉他']
    };
    
    var render = template.compile(source);
    var html = render(data);
    document.getElementById('content').innerHTML = html;
    
演示

添加辅助方法

template.helper(name, callback)辅助方法一般用来进行字符串替换,如 UBB 替换、脏话替换等。

例如扩展一个UBB替换方法:

    template.helper('$ubb2html', function (content) {
        return content
        .replace(/[b]([^[]?)[/b]/igm, '<b>$1</b>')
        .replace(/[i]([^[]
?)[/i]/igm, '<i>$1</i>')
        .replace(/[u]([^[]?)[/u]/igm, '<u>$1</u>')
        .replace(/[url=([^]]
)]([^[]?)[/url]/igm, '<a href="$1">$2</a>')
        .replace(/[img]([^[]
?)[/img]/igm, '<img src="$1" />');
    });
    
在模板中的使用方式:

    <%=$ubb2html(content) %>
    
注意:引擎不会对辅助方法输出的 HTML 字符进行转义。
    
演示

设置界定符

若前端模板语法与后端语法产生冲突,可以修改模板引擎界定符,例如:

    template.openTag = "<!--[";
    template.closeTag = "]-->";
    
演示

自定义语法

artTemplate 提供一个语法扩展用来简化模板逻辑语法。语法示例:

    {{if admin}}
        <h3>{{title}}</h3>
        <ul>
            {{each list}}
                <li>{{$index + 1}}: {{$value}}</li>
               {{/each}}
        </ul>
    {{/if}}
    
安装:把 extensions/template-syntax.js 合并到 template.js 底部。
    
更多语法说明

自动化工具

预编译工具

使用它可以让前端模版不再受浏览器的限制,支持如后端模版一样按文件放置、include 语句等特性,可以像后端一样书写前端模板!

编译后的模板不再依赖前端模板引擎与后端,模板可以通过 SeaJS 或 RequireJS 等加载器进行异步加载,亦能利用它们成熟的打包合并工具进行上线前的优化,如合并与压缩。

项目主页:<https://github.com/aui/tmodjs>

抽取工具

./tools/combine.html

可以把 HTML 中的模板提取出来以便把模板嵌入到 js 文件中。

与编译工具不同的是,抽取后的模板仍然依赖引擎运行。

模板编码规范

1、不能使用 javascript 关键字作为模板变量(包括 ECMA5 严格模式下新增的关键字):

> break, case, catch, continue, debugger, default, delete, do, else, false, finally, for, function, if, in, instanceof, new, null, return, switch, this, throw, true, try, typeof, var, void, while, with, abstract, boolean, byte, char, class, const, double, enum, export, extends, final, float, goto, implements, import, int, interface, long, native, package, private, protected, public, short, static, super, synchronized, throws, transient, volatile, arguments, let, yield

2、模板运行在沙箱中,内部无法访问外部变量,除非给模板定义辅助方法。例如:

    template.helper('Math', Math)

> 模板中若任意引用外部对象,复杂的依赖管理将会让项目难以维护,这种方式将利于后续模板迁移(包括通过工具预编译)。

更新记录

v2.0.2

1.    优化自定义语法扩展,减少体积
2.    [重要]为了最大化兼容第三方库,自定义语法扩展默认界定符修改为{{}}
3.    修复合并工具的BUG #25
4.    公开了内部缓存,可以通过template.cache访问到编译后的函数
5.    公开了辅助方法缓存,可以通过template.helpers访问到
6.    优化了调试信息

v2.0.1

1.    修复模板变量静态分析的BUG

v2.0 release

1.    编译工具更名为 atc,成为 artTemplate 的子项目单独维护:<https://github.com/cdc-im/atc>

v2.0 beta5

  1. 修复编译工具可能存在重复依赖的问题。感谢 @warmhug
  2. 修复include内部实现可能产生上下文不一致的问题。感谢 @warmhug
  3. 支持使用拖拽文件到compile.cmd图标上进行单独编译

v2.0 beta4

  1. 修复编译工具在压缩模板可能导致 HTML 意外截断的问题。感谢 @warmhug
  2. 完善编译工具对include支持支持,可以支持不同目录之间模板嵌套
  3. 修复编译工具没能正确处理自定义语法插件的辅助方法

v2.0 beta1

1.    对非String、Number类型的数据不输出,而Function类型求值后输出。
2.    默认对html进行转义输出,原文输出可使用&lt;%==value%&gt;,也可以关闭默认的转义功能template.isEscape = false
3.    增加批处理工具支持把模板编译成不依赖模板引擎的 js 文件,可通过 RequireJS、SeaJS 等模块加载器进行异步加载。

授权协议

Released under the MIT, BSD, and GPL Licenses

本文转载自:http://www.lvtao.net/web/javascript-artTemplate.html

共有 人打赏支持
lghyt
粉丝 5
博文 2
码字总数 53
作品 0
海口
私信 提问
高性能JavaScript模板引擎原理解析

本文将用最简单的示例代码描述现有的 javascript 模板引擎的原理,包括新一代 javascript 模板引擎 artTemplate 的特性实现原理,欢迎共同探讨。 artTemplate 介绍 artTemplate 是新一代 ja...

李朝强
2013/07/29
0
0
APP前端模板——Arttemplate

手机APP用Html5开发,为性能起见,提倡使用原生的javascript,jQuery亦嫌笨重。 然前端无模板,感觉代码极差,难以阅读。对比语法与性能,选择腾迅出品的2.7KB的前端模板——Arttemplate。 ...

高雷
2015/03/10
9
0
为什么不用自家的 js 模板呢

为什么不用自家的 js 模板呢(!art-template - Template Engine | http://aui.github.com/artTemplate/)? 自家的框架,不用自家的模板,真是搞不懂。。...

taolive
2015/06/09
799
7
第115天:Ajax 中artTemplate模板引擎(一)

一、不分离与分离的比较 1、前后端不分离,以freemarker模板引擎为例,看一下不分离的前后端请求的流程是什么样的? 从上图可以看出,前后端开发人员的工作耦合主要在(3)Template的使用。 ...

半指温柔乐
2017/12/15
0
0
移动端SPA开发框架 - Staple

Staple是一个专为移动设备设计的SPA(单页面Web应用)开发框架。Staple解决了SPA应用开发过程中的许多细节问题,以便于让开发者专注与实际业务逻辑的开发。Staple基于Babel和RequireJS构建,...

蔡晓东
2017/02/17
0
0

没有更多内容

加载失败,请刷新页面

加载更多

走上真正的教育之路——《中国最美的语文》读后感3100字

走上真正的教育之路——《中国最美的语文》读后感3100字: 文:张平。《中国最美的语文》,乍一听,你可能会觉得这个作者或者编辑有些大言不惭,竟然起这么大而狂的名字,可能名不副实。我没...

原创小博客
12分钟前
0
0
tomcat线程模型

Connector结构 BIO模式 NIO模式

grace_233
32分钟前
2
0
Javascript

变量定义 以$,_,字母开头 大小写敏感 var 关键字声明变量 声明未赋值undefined 数据类型 字符串,数字,布尔,数组,NULL,undefined 变量均为对象 函数 无默认值 var声明的是局部变量 函数外声明...

关元
33分钟前
1
0
文件系统、服务、防火墙、SELINUX——安全四大金刚

一提到安全,大家都会想到防火墙,和文件系统权限。而实际工作环境中,我们在Linux的安全配置,会涉及到四个级别。我们思考一个场景,你要在百度盘中存放一个文件,这个动作需要考虑下面四个...

Linux就该这么学
35分钟前
1
0
从源码角度理解Java设计模式——门面模式

一、门面模式介绍 门面模式定义:也叫外观模式,定义了一个访问子系统的接口,除了这个接口以外,不允许其他访问子系统的行为发生。 适用场景:子系统很复杂时,增加一个接口供外部访问。 优...

我叫刘半仙
44分钟前
2
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部