DIV CSS 佈局教程網

JavaScript 模板引擎 artTemplate 使用詳解
編輯:關於JavaScript     

artTemplate 是一款輕量的 JavaScript 模板引擎,語法簡潔、性能出色。它的工作方式是:先寫好一段帶佔位符的模板,每次傳入不同的數據,就能渲染出對應的 HTML 片段。項目地址:https://github.com/aui/artTemplate

一、核心特性

性能卓越,執行速度通常是 Mustache 與 tmpl 的 20 多倍。

支持運行時調試,可精確定位異常模板所在的語句。

對 NodeJS Express 友好。

安全:默認對輸出做轉義,編譯後的代碼在沙箱中運行,Node 版本可以安全執行用戶上傳的模板。

支持 include 語句,可在浏覽器端按路徑加載模板。

支持預編譯,可把模板轉換成極其精簡的 js 文件。

模板語句簡潔,無需前綴引用數據,同時提供簡潔版與原生語法版兩種風格。

兼容所有主流浏覽器。

二、語法說明

1. 引入,使用簡潔語法版本:

<script src="dist/template.js"></script>

2. 表達式:用 {{ 與 }} 包裹的內容被視為邏輯表達式。

3. 輸出:

編碼輸出:{{content}}

不編碼輸出:{{#content}}

編碼可以防止數據中包含 HTML 字符串,避免 XSS 攻擊,這也是默認行為的原因。

4. 條件判斷

 {{if admin}}
 <p>admin</p>
 {{else if code > 0}}
 <p>master</p>
 {{else}}
 <p>error!</p>
 {{/if}}

5. 遍歷,數組與對象都可以用 each:

 {{each list as value index}}
 <li>{{index}} - {{value.user}}</li>
 {{/each}}

也可以簡寫:

 {{each list}}
 <li>{{$index}} - {{$value.user}}</li>
 {{/each}}

6. 模板包含,用於嵌入子模板:

{{include 'template_name'}}

子模板默認共享當前數據,也可以顯式指定:

{{include 'template_name' news_list}}

7. 輔助方法,先用 template.helper 注冊:

 template.helper('dateFormat', function (date, format) {
 // ..
 return value;
 });

模板中用管道符調用,支持傳參與嵌套:

{{time | dateFormat:'yyyy-MM-dd hh:mm:ss'}} {{time | say:'cd' | ubb | link}}

三、實例演示

基礎用法

 <!DOCTYPE HTML>
 <html>
 <head>
 <meta charset="UTF-8">
 <title>basic-demo</title>
 <script src="../dist/template.js"></script>
 </head>
 <body>
 <div id="content"></div>
 <script id="test" type="text/html">
 {{if isAdmin}}
 <h1>{{title}}</h1>
 <ul>
 {{each list as value i}}
 <li>索引 {{i + 1}} :{{value}}</li>
 {{/each}}
 </ul>
 {{/if}}
 </script>
 <script>
 var data = {
 title: '基本例子',
 isAdmin: true,
 list: ['文藝', '博客', '攝影', '電影', '民謠', '旅行', '吉他']
 };
 var html = template('test', data);
 document.getElementById('content').innerHTML = html;
 </script>
 </body>
 </html>

 

注意模板放在 type="text/html" 的 script 標籤裡,浏覽器不會執行也不會渲染它,只作為純文本被引擎讀取。

不轉義輸出

 <!DOCTYPE HTML>
 <html>
 <head>
 <meta charset="UTF-8">
 <title>no escape-demo</title>
 <script src="../dist/template.js"></script>
 </head>
 <body>
 <h1>不轉義HTML</h1>
 <div id="content"></div>
 <script id="test" type="text/html">
 <p>不轉義:{{#value}}</p>
 <p>默認轉義: {{value}}</p>
 </script>
 <script>
 var data = {
 value: '<span style="color:#F00">hello world!</span>'
 };
 var html = template('test', data);
 document.getElementById('content').innerHTML = html;
 </script>
 </body>
 </html>

兩行的對比很直觀:默認轉義的那行會把標籤原樣顯示出來。只有在內容可信、且確實需要渲染 HTML 時才使用 {{#}}。

嵌入子模板

 <!DOCTYPE HTML>
 <html>
 <head>
 <meta charset="UTF-8">
 <title>include-demo</title>
 <script src="../dist/template.js"></script>
 </head>
 <body>
 <div id="content"></div>
 <script id="test" type="text/html">
 <h1>{{title}}</h1>
 {{include 'list'}}
 </script>
 <script id="list" type="text/html">
 <ul>
 {{each list as value i}}
 <li>索引 {{i + 1}} :{{value}}</li>
 {{/each}}
 </ul>
 </script>
 <script>
 var data = {
 title: '嵌入子模板',
 list: ['文藝', '博客', '攝影', '電影', '民謠', '旅行', '吉他']
 };
 var html = template('test', data);
 document.getElementById('content').innerHTML = html;
 </script>
 </body>
 </html>

輔助方法

 <!DOCTYPE HTML>
 <html>
 <head>
 <meta charset="UTF-8">
 <title>helper-demo</title>
 <script src="../dist/template.js"></script>
 </head>
 <body>
 <h1>輔助方法</h1>
 <div id="content"></div>
 <script id="test" type="text/html">
 {{time | dateFormat:'yyyy年 MM月 dd日 hh:mm:ss'}}
 </script>
 <script>
 /**
 * 對日期進行格式化
 * @param date 要格式化的日期
 * @param format 進行格式化的模式字符串
 * 支持的模式字母有:
 * y:年, M:年中的月份(1-12), d:月份中的天(1-31),
 * h:小時(0-23), m:分(0-59), s:秒(0-59), S:毫秒(0-999), q:季度(1-4)
 * @return String
 */
 template.helper('dateFormat', function (date, format) {
 if (typeof date === "string") {
 var mts = date.match(/(\/Date(\d+)\/)/);
 if (mts && mts.length >= 3) {
 date = parseInt(mts[2]);
 }
 }
 date = new Date(date);
 if (!date || date.toUTCString() == "Invalid Date") {
 return "";
 }
 var map = {
 "M": date.getMonth() + 1, //月份
 "d": date.getDate(), //日
 "h": date.getHours(), //小時
 "m": date.getMinutes(), //分
 "s": date.getSeconds(), //秒
 "q": Math.floor((date.getMonth() + 3) / 3), //季度
 "S": date.getMilliseconds() //毫秒
 };
 format = format.replace(/([yMdhmsqS])+/g, function(all, t){
 var v = map[t];
 if(v !== undefined){
 if(all.length > 1){
 v = '0' + v;
 v = v.substr(v.length-2);
 }
 return v;
 } else if(t === 'y'){
 return (date.getFullYear() + '').substr(4 - all.length);
 }
 return all;
 });
 return format;
 });
 // --------
 var data = {
 time: 1408536771253,
 };
 var html = template('test', data);
 document.getElementById('content').innerHTML = html;
 </script>
 </body>
 </html>

這個 dateFormat 的實現值得一看:它用一次 replace 配合 map 查表完成格式化,避免了多次字符串替換,性能比常見的鏈式 replace 好很多;同時兼容了 .NET 的 /Date(時間戳)/ 格式,便於直接處理后端返回的日期。

XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved