artTemplate-3.0
2015-06-19 11:04
281 查看
https://github.com/aui/artTemplate
artTemplate-3.0
新一代 javascript 模板引擎目录
特性快速上手
模板语法
下载
方法
NodeJS
使用预编译
更新日志
授权协议
特性
性能卓越,执行速度通常是 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)
更改引擎的默认配置。字段 | 类型 | 默认值 | 说明 |
---|---|---|---|
openTag | String | '{{' | 逻辑语法开始标签 |
closeTag | String | "}}" | 逻辑语法结束标签 |
escape | Boolean | true | 是否编码输出 HTML 字符 |
cache | Boolean | true | 是否开启缓存(依赖 options 的 filename 字段) |
compress | Boolean | false | 是否压缩 HTML 多余空白字符 |
使用预编译
可突破浏览器限制,让前端模板拥有后端模板一样的同步“文件”加载能力:一、按文件与目录组织模板
template('tpl/home/main', data)
二、模板支持引入子模板
{{include '../public/header'}}
基于预编译:
可将模板转换成为非常精简的 js 文件(不依赖引擎)使用同步模板加载接口
支持多种 js 模块输出:AMD、CMD、CommonJS
支持作为 GruntJS 插件构建
前端模板可共享给 NodeJS 执行
自动压缩打包模板
预编译工具:TmodJS
NodeJS
安装
npm install art-template
使用
var template = require('art-template'); var data = {list: ["aui", "test"]}; var html = template(__dirname + '/index/main', data);
配置
NodeJS 版本新增了如下默认配置:字段 | 类型 | 默认值 | 说明 |
---|---|---|---|
base | String | '' | 指定模板目录 |
extname | String | '.html' | 指定模板后缀名 |
encoding | String | 'utf-8' | 指定模板编码 |
base指定模板目录可以缩短模板的路径,并且能够避免
include语句越级访问任意路径引发安全隐患,例如:
template.config('base', __dirname); var html = template('index/main', data)
NodeJS + Express
var template = require('art-template'); template.config('base', ''); template.config('extname', '.html'); app.engine('.html', template.__express); app.set('view engine', 'html'); //app.set('views', __dirname + '/views');
运行 demo:
node demo/node-template-express.js
若使用 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中
template()方法不支持传入模板直接编译
升级方法
如果想继续使用 js 原生语法作为模板语言,请使用 template-native.js查找项目
template.render替换为
template
使用
template.config(name, value)来替换以前的配置
template()方法直接传入的模板改用
template.compile()(v2初期版本)
更新日志
v3.0.3
解决template.helper()方法传入的数据被转成字符串的问题 #96
解决
{{value || value2}}被识别为管道语句的问题 #105 https://github.com/aui/tmodjs/issues/48
v3.0.2
解决管道语法必须使用空格分隔的问题v3.0.1
适配 express3.x 与 4.x,修复路径 BUGv3.0.0
提供 NodeJS 专属版本,支持使用路径加载模板,并且模板的include语句也支持相对路径
适配 express 框架
内置
支持全局缓存配置
简洁语法版支持管道风格的 helper 调用,例如:
{{time | dateFormat:'yyyy年 MM月 dd日 hh:mm:ss'}}
当前版本接口有调整,请阅读 升级参考
v2.0.4
修复低版本安卓浏览器编译后可能产生语法错误的问题(因为此版本浏览器 js 引擎存在 BUG)v2.0.3
优化辅助方法性能NodeJS 用户可以通过 npm 获取 artTemplate:
$ npm install art-template -g
不转义输出语句推荐使用
<%=#value%>(兼容 v2.0.3 版本之前使用的
<%==value%>),而简版语法则可以使用
{{#value}}
提供简版语法的合并版本 dist/template-simple.js
v2.0.2
优化自定义语法扩展,减少体积[重要]为了最大化兼容第三方库,自定义语法扩展默认界定符修改为
{{与
}}。
修复合并工具的BUG #25
公开了内部缓存,可以通过
template.cache访问到编译后的函数
公开了辅助方法缓存,可以通过
template.helpers访问到
优化了调试信息
v2.0.1
修复模板变量静态分析的BUGv2.0 release
编译工具更名为 atc,成为 artTemplate 的子项目单独维护:https://github.com/cdc-im/atcv2.0 beta5
修复编译工具可能存在重复依赖的问题。感谢 @warmhug修复预编译
include内部实现可能产生上下文不一致的问题。感谢 @warmhug
编译工具支持使用拖拽文件进行单独编译
v2.0 beta4
修复编译工具在压缩模板可能导致 HTML 意外截断的问题。感谢 @warmhug完善编译工具对
include支持支持,可以支持不同目录之间模板嵌套
修复编译工具没能正确处理自定义语法插件的辅助方法
v2.0 beta1
对非 String、Number 类型的数据不输出,而 Function 类型求值后输出。默认对 html 进行转义输出,原文输出可使用
<%==value%>(备注:v2.0.3 推荐使用
<%=#value%>),也可以关闭默认的转义功能
template.defaults.escape = false。
增加批处理工具支持把模板编译成不依赖模板引擎的 js 文件,可通过 RequireJS、SeaJS 等模块加载器进行异步加载。
授权协议
Released under the MIT, BSD, and GPL Licenses所有演示例子 | 引擎原理
相关文章推荐
- JVM典型配置
- 纳斯达克业务架构利用Amazon EMR与Amazon S3实现面向大规模数据集的临时性访问
- GRE词汇统计大全(一)
- 局域网内window连接ubuntu会频繁断开的原因总结
- 默认选中 table1的第一行cell
- 《学习OpenCV》第三章课后题7
- Android常用控件之FragmentTabHost的使用
- SQL(1)
- ASP.NET WebApi 文件上传功能
- C++12.4.1 构造函数(与类名相同,没有返回类型)----有初始化列表的构造函数
- 解压小问题
- Selenium私房菜系列6 -- 深入了解Selenium RC工作原理(1)
- JavaScript中的两种全局对象
- JavaScript Type Conversion
- Oracle 数据库安装
- 对程序员说点实在话(转)
- 美团外卖"强杀门"背后的真相,你看到的是真的吗?
- 几个比较难理解的JAVA关键字总结
- Python OpenOPC的学习观感
- iOS 多线程使用总结(很实用)