art-template-plus-plus

1.0.2 • Public • Published

art-template-plus-plus

声明:此工具是在 artTemplate 基础上扩展了 macro (宏)语法,其他语法请参考 artTemplate

一、macro 用法

  1. macro 实参类型包括[string]、[number]、[boolean]、[object]、array]、[引用外部动态数据]
  2. macro 形参类型包括[string]、[number]、[boolean]、[object]、[array]
  3. macro 语法( testMacro 为 macro 名称)
    • macro 定义
    {{macro:testMacro num str boo arr obj list title name defaultValue=10}}
    <div>数字num:{{num}}</div>
    <div>字符串str:{{str}}</div>
    <div>布尔boo:{{if boo}}true{{else}}false{{/if}}</div>
    <div>数组arr:[{{each arr}}{{$value}},{{/each}}]</div>
    <div>对象obj的foo属性:{{obj.foo}}</div>
    <div>引用外部动态数据list:{{each list}}{{$value}},{{/each}}</div>
    <div>引用外部动态数据title:{{title}}</div>
    <div>引用外部动态数据name:{{name}}</div>
    <div>默认defaultValue:{{defaultValue}}</div>
    <div>$rootData为同步数据包装对象,使用它可访问任意外部动态数据,例如访问title:{{$rootData.title}}</div>
    {{/macro}}
    • macro 引用
    {{@macro:testMacro num=123 str="helloworld" boo=true arr=["a","b","c"] obj={foo:"foo",bar:"baz",} list="$list" title="$title" name="$user.name"}}
    • 动态数据
    var data = {
        title: '标签',
        user: { name: "midday", birthYear: "1990", sex: "男" },
        list: ['文艺', '博客', '摄影', '电影', '民谣', '旅行', '吉他']
    };
    • 渲染结果
     <div>数字num:123</div>
     <div>字符串str:helloworld</div>
     <div>布尔boo:true</div>
     <div>数组arr:[a,b,c,]</div>
     <div>对象obj的foo属性:foo</div>
     <div>引用外部动态数据list:文艺,博客,摄影,电影,民谣,旅行,吉他,</div>
     <div>引用外部动态数据title:标签</div>
     <div>引用外部动态数据name:midday</div>
     <div>默认defaultValue:10</div>
     <div>$rootData为同步数据包装对象,使用它可访问任意外部动态数据,例如访问title:标签</div>
  4. macro 测试用例请参考test/macro/macro-tpl.htmltest/macro/macro-test

二、macro 注意事项

  • macro 定义或引用中参数以单个空格分割,参数名、参数值不要包含空格,否则会报语法错误
{{@macro:macroName arg1="a" arg2=[1,2,3] arg3=1}}
  • macro 定义或引用中参数值为 object 时,请遵循如下规则
    • 对象中有嵌套对象,双闭合花括号 }} 之间使用逗号分隔
     {{@macro:macroName arg1={foo:"foo",bar:"baz",} arg2=[1,2,3]}}
    
    • 对象为最后一个参数时,参数值后需要添加空格
     {{@macro:macroName arg1=[1,2,3] arg2={foo:"foo",bar:"baz",} }}
    
  • macro 定义中访问外部动态数据时,语法如下(只能通过根对象 $rootData 逐层获取)
{{macro:testMacro arg1 arg2}}
    {{$rootData.title}}
    {{$rootData.user.name}}
{{/macro}}
  • macro 引用中参数值为动态数据值时,语法如下:
{{@macro:macroName list="$list" title="$title" name="$user.name"}}

================artTemplate 介绍如下================

artTemplate-3.0

新一代 javascript 模板引擎

目录

特性

  1. 性能卓越,执行速度通常是 Mustache 与 tmpl 的 20 多倍(性能测试
  2. 支持运行时调试,可精确定位异常模板所在语句(演示
  3. 对 NodeJS Express 友好支持
  4. 安全,默认对输出进行转义、在沙箱中运行编译后的代码(Node版本可以安全执行用户上传的模板)
  5. 支持include语句
  6. 可在浏览器端实现按路径加载模板(详情
  7. 支持预编译,可将模板转换成为非常精简的 js 文件
  8. 模板语句简洁,无需前缀引用数据,有简洁版本与原生语法版本可选
  9. 支持所有流行的浏览器

快速上手

编写模板

使用一个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(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 接口有调整。

接口变更

  1. 默认使用简洁语法
  2. template.render()方法的第一个参数不再是 id,而是模板字符串
  3. 使用新的配置接口template.config()并且字段名有修改
  4. template.compile()方法不支持 id 参数
  5. helper 方法不再强制原文输出,是否编码取决于模板语句
  6. template.helpers 中的$string$escape$each已迁移到template.utils
  7. template()方法不支持传入模板直接编译

升级方法

  1. 如果想继续使用 js 原生语法作为模板语言,请使用 template-native.js
  2. 查找项目template.render替换为template
  3. 使用template.config(name, value)来替换以前的配置
  4. template()方法直接传入的模板改用template.compile()(v2初期版本)

更新日志

v3.0.3

  1. 解决template.helper()方法传入的数据被转成字符串的问题 #96
  2. 解决{{value || value2}}被识别为管道语句的问题 #105 https://github.com/aui/tmodjs/issues/48

v3.0.2

  1. 解决管道语法必须使用空格分隔的问题

v3.0.1

  1. 适配 express3.x 与 4.x,修复路径 BUG

v3.0.0

  1. 提供 NodeJS 专属版本,支持使用路径加载模板,并且模板的include语句也支持相对路径
  2. 适配 express 框架
  3. 内置print语句支持传入多个参数
  4. 支持全局缓存配置
  5. 简洁语法版支持管道风格的 helper 调用,例如:{{time | dateFormat:'yyyy年 MM月 dd日 hh:mm:ss'}}

当前版本接口有调整,请阅读 升级参考

artTemplate 预编译工具 TmodJS 已更新

v2.0.4

  1. 修复低版本安卓浏览器编译后可能产生语法错误的问题(因为此版本浏览器 js 引擎存在 BUG)

v2.0.3

  1. 优化辅助方法性能
  2. NodeJS 用户可以通过 npm 获取 artTemplate:$ npm install art-template -g
  3. 不转义输出语句推荐使用<%=#value%>(兼容 v2.0.3 版本之前使用的<%==value%>),而简版语法则可以使用{{#value}}
  4. 提供简版语法的合并版本 dist/template-simple.js

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. 编译工具支持使用拖拽文件进行单独编译

v2.0 beta4

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

v2.0 beta1

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

授权协议

Released under the MIT, BSD, and GPL Licenses

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

所有演示例子 | 引擎原理

© tencent.com

Package Sidebar

Install

npm i art-template-plus-plus

Weekly Downloads

1

Version

1.0.2

License

MIT

Last publish

Collaborators

  • midday