DIV CSS 佈局教程網

TrimPath JavaScript 模板引擎詳解:語法、迴圈、巨集與後端整合
編輯:關於JavaScript     

TrimPath 是一個純前端的 JavaScript 模板引擎。原理跟 C#、PHP 的模板引擎沒有本質差異——讀入模板、用資料替換佔位符——差別只在「模板從哪裡讀」:後端語言通常從 .html、.txt 檔案讀,TrimPath 則是從頁面上隱藏的 <textarea> 讀取。

載入 template.js 之後,腳本會建立一個 TrimPath 物件供你使用。

核心方法

parseDOMTemplate(elementId, optionalDocument):取得指定 id 元素的 innerHTML,解析成模板並回傳 templateObject,解析失敗會丟出例外。optionalDocument 是多文件(iframe、frameset)環境下的可選參數。

.process():把模板再進一步解析成最終程式碼。

var result = parseDOMTemplate(elementId, optionalDocument).process();   // 用資料替換模板

TrimPath.processDOMTemplate(elementId, contextObject, optionalFlags, optionalDocument):一步到位的輔助函式,內部就是 parseDOMTemplate().process(),從 textarea 讀模板後直接替換資料。

最簡單的例子

<html>
<head>
<title>TrimPath 學習測試</title>
<script src="../../Scripts/trimpath/template.js" type="text/javascript"></script>
</head>
<body>
<div id="ShowDiv"></div>
<textarea id="temp" style="display:none;"> ${Name}敗走麥城! </textarea>
</body>
</html>
<script language="javascript">
var data = { Name: "關雲長" };
var result = TrimPath.processDOMTemplate("temp", data);
document.getElementById("ShowDiv").innerHTML = result;
</script>

輸出:關雲長敗走麥城!

條件判斷 if / elseif / else

<textarea id="temp" style="display:none;">
{if Name == "關雲長"}
  ${Name}龍卷旋風斬!
{elseif Name == "郭嘉"}
  ${Name}冰河爆裂破!
{else}
  ${Name}放大!
{/if}
</textarea>

<script language="javascript">
var data = { Name: "郭嘉" };
var result = TrimPath.processDOMTemplate("temp", data);
document.getElementById("ShowDiv").innerHTML = result;
</script>

迴圈 for / forelse

<textarea id="temp" style="display: none;">
<table width="400" cellspacing="0" cellpadding="0" border="1">
{for i in data}
  <tr><td>${i.Name}</td><td>${i.Big}</td></tr>
{/for}
</table>
</textarea>

<script type="text/javascript">
var data = [
  { Name: "關羽", Big: "龍卷旋風斬" },
  { Name: "郭嘉", Big: "冰河爆裂破" },
  { Name: "諸葛", Big: "臥龍光線" },
];
var result = TrimPath.processDOMTemplate("temp", data);
document.getElementById("ShowDiv").innerHTML = result;
</script>

語法結構:

{for varName in listExpr}
主循環體
{forelse}
當輸入為 null 或 listExpr 數量為 0 時
{/for}

forelse 這段很好用——空資料時不必在後端多寫一個分支,直接在模板裡給提示文案就好。

巨集 macro

巨集讓你可以把一段模板片段包成可重複呼叫的函式,還能帶參數:

<textarea id="temp" style="display: none;">
{macro htmlList(list, optionalListType)}
  {var listType = optionalListType != null ? optionalListType : "ul"}
  <${listType}>
  {for item in list}
    <li>${item}</li>
  {/for}
  </${listType}>
{/macro}
${htmlList(["AA","BB","CC"], "")}
</textarea>

CDATA 區塊

如果模板裡要輸出「看起來像佔位符但其實是純文字」的內容,用 {cdata} 包起來就不會被解析:

<textarea id="temp" style="display: none;">
{cdata}${Name}{/cdata} 被解釋成了 ${Name}
</textarea>

內嵌 JavaScript

{eval} 區塊裡的程式碼會被執行,可以用來在模板裡定義事件處理函式:

<textarea id="temp" style="display: none;">
<select onchange="sel_onchange()">
  <option value="1">1</option>
  <option value="2">2</option>
</select>
{eval}
  sel_onchange = function() {
    alert('我不小心被 change 了');   // 這裡的註解不影響執行
  }
{/eval}
</textarea>

與 .NET MVC 搭配

後端只負責吐 JSON,前端拿資料套模板,這樣視圖與資料完全分離:

public class HomeController : Controller {
    public ActionResult Index() { return View(); }

    public ActionResult GetJson() {
        Person p1 = new Person(1, "劉備", 30);
        Person p2 = new Person(2, "關羽", 28);
        Person p3 = new Person(3, "張飛", 36);
        List<Person> ListPerson = new List<Person>();
        ListPerson.Add(p1); ListPerson.Add(p2); ListPerson.Add(p3);
        return Json(ListPerson, JsonRequestBehavior.AllowGet);
    }
}

public class Person {
    public Person(int id, string name, int age) { Id = id; Name = name; Age = age; }
    public int Id { get; set; }
    public string Name { get; set; }
    public int Age { get; set; }
}

前端:

<%@ Page Language="C#" Inherits="System.Web.Mvc.ViewPage" %>
<html>
<head>
<title>TrimPath 學習測試</title>
<script src="../../Scripts/jquery.min.js" type="text/javascript"></script>
<script src="../../Scripts/trimpath/template.js" type="text/javascript"></script>
</head>
<body>
<div id="ShowDiv"></div>
<textarea id="temp" style="display: none;">
<table width="400" cellspacing="0" cellpadding="0" border="1">
  <tr><td>Id</td><td>姓名</td><td>年齡</td></tr>
  {for i in data}
  <tr><td>${i.Id}</td><td>${i.Name}</td><td>${i.Age}</td></tr>
  {/for}
</table>
</textarea>
</body>
</html>
<script type="text/javascript">
var data;
$(function() {
  $.ajax({
    url: "/Home/GetJson", type: 'post', async: true, dataType: 'json',
    success: function(response) {
      data = response;
      var result = TrimPath.processDOMTemplate("temp", data);
      document.getElementById("ShowDiv").innerHTML = result;
    }
  })
})
</script>

使用上的注意事項

模板放在 textarea 裡有個現實問題:HTML 特殊字元必須自行處理,而且編輯器對 textarea 內的程式碼沒有語法高亮,維護起來比獨立檔案吃力。另外,把資料直接塞進 innerHTML 代表沒有任何轉義,使用者輸入的內容若含 HTML 標籤就會被執行,正式環境記得先過一層轉義。

以今日的標準來看,TrimPath 已經算是歷史產物,主流選擇多半是 Vue、React 這類具備響應式與虛擬 DOM 的方案。但理解「模板 = 讀取 + 替換」這個最基礎的模型,對後續學習任何模板語法都很有幫助。

以上就是 TrimPath 模板引擎的語法與整合方式整理,需要的朋友可以搭配範例一起實作。

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