artTemplate-3.0
https://github.com/aui/artTemplate
artTemplate-3.0
新一代 javascript 模板引擎
目录
特性
- 性能卓越,执行速度通常是 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,修复路径 BUG
v3.0.0
- 提供 NodeJS 专属版本,支持使用路径加载模板,并且模板的
include
语句也支持相对路径 - 适配 express 框架
- 内置
print
语句支持传入多个参数 - 支持全局缓存配置
- 简洁语法版支持管道风格的 helper 调用,例如:
{{time | dateFormat:'yyyy年 MM月 dd日 hh:mm:ss'}}
当前版本接口有调整,请阅读 升级参考
artTemplate 预编译工具 TmodJS 已更新
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
- 修复模板变量静态分析的BUG
v2.0 release
编译工具更名为 atc,成为 artTemplate 的子项目单独维护:https://github.com/cdc-im/atc
v2.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
artTemplate-3.0的更多相关文章
- artTemplate-3.0(与项目实际结合)
引入artTemplate.js <script type="text/javascript" src="${ctx}/assets/plugins/artTemp ...
- 腾讯的模板引擎---artTemplate
主要方法如下5种,在此不详细说artTemplate的方法,主要记录三种使用artTemplate的方法. template(id, data) 根据 id 渲染模板.内部会根据document.ge ...
- artTemplate性能卓越的 js 模板引擎
artTemplate-3.0 新一代 javascript 模板引擎 目录 特性 快速上手 模板语法 下载 方法 NodeJS 使用预编译 更新日志 授权协议 特性 性能卓越,执行速度通常是 Mus ...
- 应用node+express+mysql 实现简单的增删改查
记录下来备忘 1.准备好webstrom编辑器,编辑器调整字体大小等在file->settings->editor下设置 注册码 来源网上: 2017.2.27更新 选择“license ...
- ZAM 3D 制作简单的3D字幕 流程(二)
原地址:http://www.cnblogs.com/yk250/p/5663907.html 文中表述仅为本人理解,若有偏差和错误请指正! 接着 ZAM 3D 制作简单的3D字幕 流程(一) .本篇 ...
- ZAM 3D 制作3D动画字幕 用于Xaml导出
原地址-> http://www.cnblogs.com/yk250/p/5662788.html 介绍:对经常使用Blend做动画的人来说,ZAM 3D 也很好上手,专业制作3D素材的XAML ...
- 微信小程序省市区选择器对接数据库
前言,小程序本身是带有地区选着器的(网站:https://mp.weixin.qq.com/debug/wxadoc/dev/component/picker.html),由于自己开发的程序的数据是很 ...
- osg编译日志
1>------ 已启动全部重新生成: 项目: ZERO_CHECK, 配置: Debug x64 ------1> Checking Build System1> CMake do ...
- 性能卓越的js模板引擎--artTemplate
artTemplate能够将数据与View视图的分离,充分利用 javascript 引擎特性,使得其性能无论在前端还是后端都有极其出色的表现. 在 chrome 下渲染效率测试中分别是知名引擎 Mu ...
随机推荐
- 利用maven中resources插件的copy-resources目标进行资源copy和过滤
maven用可以利用如下配置进行资源过滤,pom.xml的配置如下: <build> <!-- 主资源目录 --> <resources> <resource ...
- asp.net页面压缩
http压缩方法(IIS 6.0 与IIS 7.0的详解) 在网上看了有关这方面的博客,再加上自己的实践,整理了一下,希望对大家有所帮助 本片文章采用两种压缩方法:一种是在IIS上开启GZIP压缩 ...
- JAVASCRIPT——文字出现效果练习
写一句诗.诗的最初状态是隐藏的,效果是让诗缓慢出现,直到显示完全 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional// ...
- ios消息的交互方式
注意这些都是界面回传(即从第二个界面传到第一个界面,从第一个界面传到第二个界面的时候用第二个界面的属性即可) iOS消息的交互方式有4种,分别为:通知,代理,block,kvo 现在我们对这个4中 ...
- C# 知识点回顾
一.基础知识 1.主函数:主函数是程序运行的入口. 2.数据类型: 值类型:整形(有符号.无符号)浮点型(float.double.decimal) 字符型(char.datetime) 结构体(范例 ...
- Unix下C程序内存泄露检测工具:valgrind的安装使用
Valgrind是一款用于内存调试.内存泄漏检测以及性能分析的软件开发工具. Valgrind的最初作者是Julian Seward,他于2006年由于在开发Valgrind上的工作获得了第二届Goo ...
- 设计模式之UML类图
在学设计模式的过程中经常碰到各式各样的UML类图.那些眼花缭乱的符号有什么含义呢? 类图含义 类图中的关系 从网上找来一张图作为实例 依赖关系:比如动物依赖氧气和水,这里如学生要依赖自行车.用虚线箭头 ...
- <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"的作用
为页面添加正确的DOCTYPE 很多设计师和开发者都不知道什么是DOCTYPE,DOCTYPE有什么用.DOCTYPE是document type的简写.主要用来说明你用的XHTML或者HTML是什么 ...
- SpringDataRedis事务处理
public Long leftPush(V value) { return this.ops.leftPush(this.getKey(), value); } public Long leftPu ...
- 支持https的压力测试工具
支持https的压力测试工具 测试了linux下的几种压力测试工具,发现有些不支持https,先简单总结如下: 一.apache的ab工具 /home/webadm/bin/ab -c 50 -n 1 ...