DIV CSS 佈局教程網

jQuery Templates .tmpl() 用法詳解:用 HTML 模板取代字串拼接
編輯:JQuery特效代碼     

動態請求資料來更新頁面,是現代網頁的基本功:評論分頁遞增載入、社群網站的捲動載入、儀表板的定時輪詢都屬此列。這些情境的難題不在請求,而在「拿到 JSON 之後怎麼變成 HTML」。

為什麼需要模板

回傳的資料通常有三種形態:已拼好的 HTML、JSON、XML。直接回傳 HTML 看似省事,但傳輸量偏大,也把版型邏輯綁死在伺服器端;XML 則已逐漸被 JSON 取代。剩下最合理的路,是回傳精瘦的 JSON,由瀏覽器負責渲染。

問題就在這裡:結構簡單時還好,一旦要處理巢狀、迴圈、條件分支,用字串拼接寫出來的程式碼幾乎無法維護——少一個引號就全盤崩掉,改一處樣式要動十幾行。這個痛點,與當年 PHP 頁面混雜 HTML 與 SQL 的困境如出一轍,而當年的答案是 Smarty 這類模板引擎。JavaScript 這邊的答案,就是 jquery.tmpl。

支援的標籤

  • ${}:輸出變數,等同 {{=}},會經過 HTML 編碼,可防 XSS。
  • {{html}}:輸出變數但不編碼,適合輸出 HTML 片段。
  • {{if}} {{else}} {{/if}}:條件分支。
  • {{each}}:迴圈,迴圈內以 $value 存取當前迭代項目。

模板定義:兩種寫法

寫法一,用 script 標籤承載,這是最推薦的方式,因為模板與資料分離、可讀性最高:

<script id="movieTemplate" type="text/x-jquery-tmpl">
  <li><b>${Name}</b> (${ReleaseYear})</li>
</script>

關鍵在 type="text/x-jquery-tmpl"——瀏覽器不認得這個 MIME 類型,因此不會執行也不會渲染,內容就原封不動留在 DOM 裡供 jQuery 取用。

寫法二,用字串動態註冊:

function makeTemplate() {
    var markup = '<li><b>${Name}</b> (${ReleaseYear})</li>';
    $.template("movieTemplate", markup);
}

資料與渲染

var movies = [
    { Name: "The Red Violin", ReleaseYear: "1998" },
    { Name: "Eyes Wide Shut", ReleaseYear: "1999" },
    { Name: "The Inheritance", ReleaseYear: "1976" }
];

$("#movieTemplate").tmpl(movies).appendTo("#movieList");

一行完成渲染與插入,對比十幾行的迴圈拼接,差距不言而喻。

實例一:可增刪的鍵值編輯器

<!DOCTYPE html>
<html>
<head>
<script src="https://code.jquery.com/jquery-1.12.4.min.js"></script>
<script src="jquery.tmpl.min.js"></script>
</head>
<body>
<ul class="param-list"></ul>

<script type="text/x-jquery-tmpl" id="new-param-tmpl">
  <li rel="${num}">
    <input type="text" name="key[${num}]"   value="${key}"   placeholder="key" /> =
    <input type="text" name="value[${num}]" value="${value}" placeholder="value" />
    <button type="button" class="button small remove-param">移除</button>
    <button type="button" class="button small add-param">新增</button>
  </li>
</script>

<script>
$(function () {
    function addParam(key, value) {
        var param_list = $('.param-list');
        var num = param_list.find('li').length;
        var built = $('#new-param-tmpl').tmpl({
            num: num,
            key: key || '',
            value: value || ''
        });
        if (key) { param_list.prepend(built); } else { param_list.append(built); }
        param_list.find('li:not(:last) .add-param').hide();
        param_list.find('li:last .add-param').show();
        param_list.find('li:not(:last) .remove-param').show();
        param_list.find('li:last .remove-param').hide();
    }

    $('.param-list').on('click', '.remove-param', function () {
        $(this).parent().remove();
        return false;
    });
    $('.param-list').on('click', '.add-param', function () {
        addParam();
        return false;
    });

    addParam();
});
</script>
</body>
</html>

這裡把原範例的 .live() 換成 .on() 的事件委派。live() 自 jQuery 1.7 起即被標記為不建議使用、1.9 正式移除;對於動態產生的元素,改用 $(document).on('click', '.selector', fn) 才是正確寫法。

實例二:最簡渲染

<ul id="movieList"></ul>

<script id="movieTemplate" type="text/x-jquery-tmpl">
  <li><b>${Name}</b> (${ReleaseYear})</li>
</script>

<script type="text/javascript">
var movies = [
    { Name: "The Red Violin",  ReleaseYear: "1998" },
    { Name: "Eyes Wide Shut",  ReleaseYear: "1999" },
    { Name: "The Inheritance", ReleaseYear: "1976" }
];
$("#movieTemplate").tmpl(movies).appendTo("#movieList");
</script>

該用 tmpl 嗎?

要誠實說明:jQuery Templates 曾以官方插件的身分登場,但後來官方已停止維護,微軟將後續發展交給 JsRender / JsViews。若是新專案,更合適的選擇包括:

  • 輕量需求:原生 <template> 標籤加上 cloneNode(),或 ES6 模板字面串搭配 innerHTML。
  • 中型以上:Vue、Alpine.js 等宣告式框架,響應式資料綁定省去大量手工 DOM 操作。
  • 仍偏好模板語法:Handlebars、Mustache、JsRender 都成熟可用。

但理解 tmpl 的思路仍有價值——「用 HTML 描述結構、用資料填洞」這個抽象,是所有現代前端框架的共同起點。

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