art-template 是一个渲染性能出众模板引擎,无论在 NodeJS 还是在浏览器中都可以运行。
- 拥有接近 JavaScript 渲染极限的的性能
- 调试友好:语法、运行时错误日志精确到模板所在行;支持支持在模板文件上打断点(Webpack Loader)
- 支持压缩输出页面中的 HTML、CSS、JS 代码
- 支持 Express、Koa、Webpack
- 支持模板继承与子模板
- 兼容 EJS、Underscore、LoDash 模板语法
- 模板编译后的代码支持在严格模式下运行
- 支持 JavaScript 语句与模板语法混合书写
- 支持自定义模板的语法解析规则
- 浏览器版本仅 6KB 大小
{{if user}}
<h2>{{user.name}}</h2>
{{/if}}
或:
<% if (user) { %>
<h2><%= user.name %></h2>
<% } %>
var template = require('art-template');
var html = template(__dirname + '/tpl-user.art', {
user: {
name: 'aui'
}
});
<script src="lib/template-web.js"></script>
<script id="tpl-user" type="text/html">
{{if user}}
<h2>{{user.name}}</h2>
{{/if}}
</script>
var html = template('tpl-user', {
user: {
name: 'aui'
}
});
// 基于模板名渲染模板
template(filename, data);
// 将模板源代码编译成函数
template.compile(source, options);
// 将模板源代码编译成函数并立刻执行
template.render(source, data, options);
npm install art-template --save
art-template 同时支持 {{expression}}
简约语法与任意 JavaScript 表达式 <% expression %>
。
1. 标准输出
{{value}}
{{data.key}}
{{data['key']}}
{{a ? b : c}}
{{a || b}}
{{a + b}}
或
<%= value %>
<%= data.key %>
<%= data['key'] %>
<%= a ? b : c %>
<%= a || b %>
<%= a + b %>
模板一级特殊变量可以使用 $data
加下标的方式访问:
{{$data['user list']}}
2. 原始输出
{{@value}}
或
<%- value %>
原始输出语句不会对 HTML
内容进行转义
{{if value}} ... {{/if}}
{{if v1}} ... {{else if v2}} ... {{/if}}
或
<% if (value) { %> ... <% } %>
<% if (value) { %> ... <% } else { %> ... <% } %>
{{each target}}
{{$index}} {{$value}}
{{/each}}
或
<% for(var i = 0; i < target.length; i++){ %>
<%= i %> <%= target[i] %>
<% } %>
target
支持Array
与Object
的迭代,其默认值为$data
$value
与$index
可以自定义:{{each target val key}}
{{set temp = data.sub.content}}
或
<% var temp = data.sub.content; %>
{{extend './layout.art'}}
{{block 'head'}} ... {{/block}}
或
<% extend('./layout.art') %>
<% block('head', function(){ %> ... <% }) %>
模板继承允许你构建一个包含你站点共同元素的基本模板“骨架”。
layout.art:
<!doctype html>
<html>
<head>
<meta charset="utf-8">
<title>{{block 'title'}}My Site{{/block}}</title>
{{block 'head'}}
<link rel="stylesheet" href="main.css">
{{/block}}
</head>
<body>
{{block 'content'}}{{/block}}
</body>
</html>
index.art:
{{extend './layout.art'}}
{{block 'title'}}{{title}}{{/block}}
{{block 'head'}}
<link rel="stylesheet" href="custom.css">
{{/block}}
{{block 'content'}}
<p>This is just an awesome page.</p>
{{/block}}
渲染 index.art 后,将自动应用布局骨架。
{{include './header.art'}}
{{include './header.art' data}}
或
<% include('./header.art') %>
<% include('./header.art', data) %>
include
第二个参数默认值为 $data
。
<% print(val, val2, val3) %>
// 向模板中导入变量
template.defaults.imports.dateFormat = function(date, format){/*[code..]*/};
template.defaults.imports.timestamp = function(value){return value * 1000};
{{date | timestamp | dateFormat 'yyyy-MM-dd hh:mm:ss'}}
或
<%= $imports.dateFormat($imports.timestamp(date), 'yyyy-MM-dd hh:mm:ss') %>
{{value | filter}}
过滤器语法类似管道操作符,它的上一个输出作为下一个输入。
template.defaults.minimize = true;
art-template 的页面压缩功能是在编译阶段实现的,因此完全不影响渲染速度,并且能够加快网络传输速度。但也有一个限制,它会尝试“优化”未闭合的 HTML 标签,因此请避免书写这样没有正确闭合的模板��:
<body>
或:
</body></html>
使用子模板载入网页头与底公共部分的时候很容易出现此问题,解决方案是使用 模板继承 代替子模板。
设置 template.defaults.debug=true
后,它会设置如下 选项:
{
"bail": false,
"cache": false,
"minimize": false,
"compileDebug": true
}
debug
默认配置:
- Node 环境 =
process.env.NODE_ENV !== 'production'
- 浏览器环境 =
false
模板通过 $imports
可以访问到模板外部的全局变量。
$data
传入模板的数据$imports
外部导入的变量�以及全局变量print
字符串输出函数include
子模板载入函数extend
模板继承模板导入函数block
模板块声明函数
template.defaults.imports.log = console.log;
<% $imports.log('hello world') %>
art-template 支持修改默认模板界定符 {{
}}
与 <%
%>
:
// 原生语法的界定符规则
template.defaults.rules[0].test = /<%(#?)((?:==|=#|[=-])?)([\w\W]*?)(-?)%>/;
// 简洁语法的界定符规则
template.defaults.rules[1].test = /{{[ \t]*([@#]?)(\/?)([\w\W]*?)[ \t]*}}/;
它们是一个正则表达式,你可以只修改界定符部分。例如修改 <%
%>
为 <?
?>
:
var rule = template.defaults.rules[0];
rule.test = new RegExp(rules.test.source.replace('<%', '<?').replace('%>', '?>'));
从一个简单的例子说起,让模板引擎支持 ES6 ${name}
模板字符串的解析:
template.defaults.rules.push({
test: /\${([\w\W]*?)}/,
use: function(match, code) {
return {
code: code,
output: 'escape'
}
}
});
其中 test
是匹配字符串正则,use
是匹配后的调用函数。关于 use
函数:
- 参数:一个参数为匹配到的字符串,其余的参数依次接收
test
正则的分组匹配内容 - 返回值:必须返回一个对象,包含
code
与output
两个字段:code
转换后的 JavaScript 语句output
描述code
的类型,可选值:'escape'
编码后进行输出'raw'
输出原始内容false
不输出任何内容
值得一提的是,语法规则对渲染速度没有影响,模板引擎编译器会帮你优化渲染性能。
加载 .art
模板:
var template = require('art-template');
var view = require('./index.art');
var html = view(data);
加载 .ejs
模板:
var template = require('art-template');
require.extensions['.ejs'] = template.extension;
var view = require('./index.ejs');
var html = view(data);
需要注意的是:此功能仅对 NodeJS 生效,如果要在浏览器中使用模板文件渲染功能,请使用 Webpack art-template-loader。
根据模板名渲染模板。
var html = template('/welcome.art', {
value: 'aui'
});
在浏览器中,
filename
请传入存放模板的元素id
编译模板并缓存。
// compile && cache
template('/welcome.art', 'hi, <%=value%>.');
// use
template('/welcome.art', {
value: 'aui'
});
编译模板并返回一个渲染函数。
var render = template.compile('hi, <%=value%>.');
var html = render({value: 'aui'});
编译并返回渲染结果。
var html = template.render('hi, <%=value%>.', {value: 'aui'});
模板引擎默认配置。参考 选项。
template.defaults
// 模板名
filename: null,
// 模板语法规则列表
rules: [nativeRule, artRule],
// 是否开启对模板输出语句自动编码功能。为 false 则关闭编码输出功能
// escape 可以防范 XSS 攻击
escape: true,
// 是否开启调试模式。如果为 true: {bail:false, cache:false, minimize:false, compileDebug:true}
debug: detectNode ? process.env.NODE_ENV !== 'production' : false,
// bail 如果为 true,编译错误与运行时错误都会抛出异常
bail: false,
// 是否开启缓存
cache: true,
// 是否开启压缩。它会运行 htmlMinifier,将页面 HTML、CSS、CSS 进行压缩输出
// 如果模板包含没有闭合的 HTML 标签,请不要打开 minimize,否则可能被 htmlMinifier 修复或过滤
minimize: true,
// 是否编译调试版。编译为调试版本可以在运行时进行 DEBUG
compileDebug: false,
// 模板路径转换器
resolveFilename: resolveFilename,
// HTML 压缩器。仅在 NodeJS 环境下有效
htmlMinifier: htmlMinifier,
// HTML 压缩器配置。参见 https://github.com/kangax/html-minifier
htmlMinifierOptions: {
collapseWhitespace: true,
minifyCSS: true,
minifyJS: true,
// 运行时自动合并:rules.map(rule => rule.test)
ignoreCustomFragments: []
},
// 错误事件。仅在 bail 为 false 时生效
onerror: onerror,
// 模板文件加载器
loader: loader,
// 缓存中心适配器(依赖 filename 字段)
caches: caches,
// 模板根目录。如果 filename 字段不是本地路径,则在 root 查找模板
root: '/',
// 默认后缀名。如果没有后缀名,则会自动添加 extname
extname: '.art',
// 忽略的变量。被模板编译器忽略的模板变量列表
ignore: [],
// 导入的模板变量
imports: runtime
赞助 art-template 持续优化