一、art-template

官方文档:https://aui.github.io/art-template/zh-cn/

art-template 是一个简约、超快的模板引擎。
它采用作用域预声明的技术来优化模板渲染速度,从而获得接近 JavaScript 极限的运行性能,并且同时支持 NodeJS 和浏览器。

1. 安装
  • 通过npm安装: npm install art-template --save
  • 下载安装
2. 模板语法:

art-template 同时支持两种模板语法。标准语法可以让模板更容易读写;原始语法具有强大的逻辑处理能力。

标准语法

{{if user}}
<h2>{{user.name}}</h2>
{{/if}}

原始语法

<% if (user) { %>
<h2><%= user.name %></h2>
<% } %>
3. 渲染模板
var template = require('art-template');
var html = template(__dirname + '/tpl-user.art', {
    user: {
        name: 'aui'
    }
});
4.核心方法
// 基于模板名渲染模板
template(filename, data);

// 将模板源代码编译成函数
template.compile(source, options);

// 将模板源代码编译成函数并立刻执行
template.render(source, data, options);
5. 语法

art-template 支持标准语法与原始语法。标准语法可以让模板易读写,而原始语法拥有强大的逻辑表达能力。

标准语法支持基本模板语法以及基本 JavaScript 表达式;原始语法支持任意 JavaScript 语句,这和 EJS 一样。

(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 内容进行转义处理,可能存在安全风险,请谨慎使用。

(3)条件

标准语法

{{if value}} ... {{/if}}{{if v1}} ... {{else if v2}} ... {{/if}}

原始语法

<% if (value) { %> ... <% } %><% if (v1) { %> ... <% } else if (v2) { %> ... <% } %>
(4)循环

标准语法

{{each target}}    {{$index}} {{$value}}{{/each}}

原始语法

<% for(var i = 0; i < target.length; i++){ %>    <%= i %> <%= target[i] %><% } %>
  1. target 支持 arrayobject 的迭代,其默认值为 $data
  2. $value$index 可以自定义:{{each target val key}}
(6)变量

标准语法

{{set temp = data.sub.content}}

原始语法

<% var temp = data.sub.content; %>
(7)模板继承

标准语法

{{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 后,将自动应用布局骨架。

(8)子模板

标准语法

{{include './header.art'}}
{{include './header.art' data}}

原始语法

<% include('./header.art') %>
<% include('./header.art', data) %>
  1. data 数默认值为 $data;标准语法不支持声明 objectarray,只支持引用变量,而原始语法不受限制。
  2. art-template 内建 HTML 压缩器,请避免书写 HTML 非正常闭合的子模板,否则开启压缩后标签可能会被意外“优化。
(9)过滤器

注册过滤器

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'}}

{{value | filter}} 过滤器语法类似管道操作符,它的上一个输出作为下一个输入。

原始语法

<%= $imports.dateFormat($imports.timestamp(date), 'yyyy-MM-dd hh:mm:ss') %>

如果想修改 {{ }}<% %>,请参考 解析规则

6.模板变量
template.defaults.imports

模板通过 $imports 可以访问到模板外部的全局变量与导入的变量。

(1)导入变量
template.defaults.imports.log = console.log;
<% $imports.log('hello world') %>
(2)内置变量清单
  • $data 传入模板的数据
  • $imports 外部导入的变量以及全局变量
  • print 字符串输出函数
  • include 子模板载入函数
  • extend 模板继承模板导入函数
  • block 模板块声明函数

解析规则

template.defaults.rules

art-template 可以自定义模板解析规则,默认配置了原始语法与标准语法。

修改界定符

// 原始语法的界定符规则
template.defaults.rules[0].test = /<%(#?)((?:==|=#|[=-])?)[ \t]*([\w\W]*?)[ \t]*(-?)%>/;
// 标准语法的界定符规则
template.defaults.rules[1].test = /{{([@#]?)[ \t]*(\/?)([\w\W]*?)[ \t]*}}/;

它们是一个正则表达式,你可以只修改界定符部分。例如修改 <% %><? ?>

var rule = template.defaults.rules[0];rule.test = new RegExp(rule.test.source.replace('<%', '<\\\?').replace('%>', '\\\?>'));
7. 添加语法

从一个简单的例子说起,让模板引擎支持 ES6 ${name} 模板字符串的解析:

template.defaults.rules.push({    test: /\${([\w\W]*?)}/,    use: function(match, code) {        return {            code: code,            output: 'escape'        }    }});

其中 test 是匹配字符串正则,use 是匹配后的调用函数。关于 use 函数:

  • 参数:一个参数为匹配到的字符串,其余的参数依次接收 test 正则的分组匹配内容
  • 返回值:必须返回一个对象,包含 codeoutput 两个字段:
  • code 转换后的 JavaScript 语句
  • output 描述 code的类型,可选值:
  • 'escape' 编码后进行输出
  • 'raw' 输出原始内容
  • false 不输出任何内容

值得一提的是,语法规则对渲染速度没有影响,模板引擎编译器会帮你优化渲染性能。

8. 压缩页面
template.defaults.minimize

art-template 内建的压缩器可以压缩 HTML、JS、CSS,它在编译阶段运行,因此完全不影响渲染速度,并且能够加快网络传输。

(1)开启
template.defaults.minimize = true;
(2)配置

参见:https://github.com/kangax/html-minifier

默认配置

template.defaults.htmlMinifierOptions = {    collapseWhitespace: true,    minifyCSS: true,    minifyJS: true,    // 运行时自动合并:rules.map(rule => rule.test)    ignoreCustomFragments: []};
9. 选项
template.defaults// 模板名filename: null,// 模板语法规则列表rules: [nativeRule, artRule],// 是否开启对模板输出语句自动编码功能。为 false 则关闭编码输出功能// escape 可以防范 XSS 攻击escape: true,// 启动模板引擎调试模式。如果为 true: {cache:false, minimize:false, compileDebug:true}debug: detectNode ? process.env.NODE_ENV !== 'production' : false,// bail 如果为 true,编译错误与运行时错误都会抛出异常bail: true,// 是否开启缓存cache: true,// 是否开启压缩。它会运行 htmlMinifier,将页面 HTML、CSS、CSS 进行压缩输出// 如果模板包含没有闭合的 HTML 标签,请不要打开 minimize,否则可能被 htmlMinifier 修复或过滤minimize: true,// 是否编译调试版compileDebug: false,// 模板路径转换器resolveFilename: resolveFilename,// 子模板编译适配器include: include,// HTML 压缩器。仅在 NodeJS 环境下有效htmlMinifier: htmlMinifier,// HTML 压缩器配置。参见 https://github.com/kangax/html-minifierhtmlMinifierOptions: {    collapseWhitespace: true,    minifyCSS: true,    minifyJS: true,    // 运行时自动合并:rules.map(rule => rule.test)    ignoreCustomFragments: []},// 错误事件。仅在 bail 为 false 时生效onerror: onerror,// 模板文件加载器loader: loader,// 缓存中心适配器(依赖 filename 字段)caches: caches,// 模板根目录。如果 filename 字段不是本地路径,则在 root 查找模板root: '/',// 默认后缀名。如果没有后缀名,则会自动添加 extnameextname: '.art',// 忽略的变量。被模板编译器忽略的模板变量列表ignore: [],// 导入的模板变量imports: runtime
10. API
(1)template(filename, content)

根据模板名渲染模板。

  • 参数:
  • {string} filename
  • {Object,string} content
  • 返回值:
  • 如果 contentObject,则渲染模板并返回 string
  • 如果 contentstring,则编译模板并返回 function
var html = template('/welcome.art', {    value: 'aui'});

浏览器版本无法加载外部文件,filename 为存放模板的元素 id

示例

编译模板并缓存。

// compile && cachetemplate('/welcome.art', 'hi, <%=value%>.');// usetemplate('/welcome.art', {    value: 'aui'});
(2).compile(source, options)

编译模板并返回一个渲染函数。

  • 参数:
  • {string} source
  • {Object} options
  • 返回值{function}

示例

var render = template.compile('hi, <%=value%>.');var html = render({value: 'aui'});
(3).render(source, data, options)

编译并返回渲染结果。

  • 参数:
  • {string} source
  • {Object} options
  • 返回值{string}

示例

var html = template.render('hi, <%=value%>.', {value: 'aui'});
(5).defaults

模板引擎默认配置。参考 选项

  • 类型{Object}
(6).extension

给 NodeJS require.extensions 注册的模板渲染函数。

  • 类型{Object}

示例

加载 .ejs 模板:

var template = require('art-template');require.extensions['.ejs'] = template.extension;var view = require('./index.ejs');var html = view(data);

.art 默认被注册,可以直接使用:

var template = require('art-template');var view = require('./index.art');var html = view(data);

需要注意的是:此功能仅对 NodeJS 生效,如果要在浏览器中使用模板文件渲染功能,请使用 Webpack art-template-loader

11. 案例

9.1在浏览器中使用art-template.html

<!DOCTYPE html><html>	<head>		<meta charset="utf-8">		<title></title>	</head>	<body>		<p>我叫{{ name }}</p>		<p>我{{ age }}岁</p>		<p>我来自{{ province }}</p>		<p>我喜欢{{ each hobbies }} {{ $value }} {{/each}}</p>	</body></html>

9.模板引擎.js

// art-template// art-template不仅可以在浏览其中使用,还可以在node中使用// 安装:npm install art-template --savevar http = require('http')var fs = require('fs')var template = require('art-template')http.createServer(function (req, res) {    var url = req.url    if (url === '/') {        //读取文件的模板内容        fs.readFile('./9.1在浏览器中使用art-template.html', function (err, data) {            if (err) {                return res.end('404')            }            //默认读取到的data是二进制数据,模板引擎的render接收的是字符串,需要data转toString            var ret = template.render(data.toString(), {                //里面可以更改对应的值                name: 'wjy',                age: 18,                province: '成都',                hobbies: [                    '打代码',                    '旅游'                ]            })            res.end(ret)        })    }})    .listen(3000, function () {        console.log('runing')    })