當頁面需要用資料動態產生大量 HTML 時,用字串拼接既醜又難維護。JavaScript 也可以借用「模板」這個概念來解決,而 jQuery 官方曾經接受的模板插件 jquery.tmpl 就是一例。本文示範它的基本用法。

假設後端回傳這樣一段 JSON 資料:
[
{"tId": 1, "tName": "張三", "tAge": 14, "tClass": 1, "TeachClass": {"cId": 1, "cName": "1班"}},
{"tId": 2, "tName": "李四", "tAge": 25, "tClass": 1, "TeachClass": {"cId": 1, "cName": "1班"}},
{"tId": 4, "tName": "趙六", "tAge": 16, "tClass": 2, "TeachClass": {"cId": 2, "cName": "2班"}}
]
而你想要呈現的畫面長這樣:

接著依照顯示需求撰寫模板。這裡的概念類似 ASP.NET 的 repeater 控制項——記得一定要設定 id,因為稍後要憑 id 選到它:

模板本體的寫法:
<script id="studentTpl" type="text/x-jquery-tmpl">
<tr>
<td>${tId}</td>
<td>${tName}</td>
<td>${tAge}</td>
<td>${TeachClass.cName}</td>
</tr>
</script>
注意 type="text/x-jquery-tmpl" 這個非標準的 MIME 型別:瀏覽器不認得它就完全不會執行,內容會被當成純文字留在 DOM 中,正好適合存放模板。而 ${ } 是插值語法,可以直接讀取巢狀屬性。

$.getJSON('data.php', function (data) {
// 把資料塞進模板,並附加到 tbody
$('#studentTpl').tmpl(data).appendTo('#studentTable tbody');
});

<script id="tpl" type="text/x-jquery-tmpl">
{{if tAge >= 18}}
<tr class="adult">${tName}(成人)</tr>
{{else}}
<tr class="minor">${tName}(未成年)</tr>
{{/if}}
{{each(i, item) items}}
<li>${i}: ${item.name}</li>
{{/each}}
{{html rawHtml}}
</script>
jquery.tmpl 在 2010 年被列為官方模板插件,但已於 jQuery 1.8 之後停止維護並從官方推薦中移除。原因之一是 ${ } 插值預設不做 HTML 跳脫,若資料來自使用者輸入,直接就會產生 XSS 漏洞。上面範例之所以還算安全,是因為資料是經過設計的假資料;實戰中若欄位可能含使用者輸入,就必須自己跳脫。
現代的替代方案:
map 就能取代大半場景。<template> 元素:HTML 標準提供的模板機制,內容不會被渲染也不會載入資源,用 cloneNode 取出後填值即可。用原生寫法重現上面的效果:
const rows = data.map(s => `
<tr>
<td>${escapeHtml(s.tId)}</td>
<td>${escapeHtml(s.tName)}</td>
<td>${escapeHtml(s.tAge)}</td>
<td>${escapeHtml(s.TeachClass.cName)}</td>
</tr>
`).join('');
document.querySelector('#studentTable tbody').innerHTML = rows;
function escapeHtml(str) {
const div = document.createElement('div');
div.textContent = String(str);
return div.innerHTML;
}
或者用 <template> 搭配 cloneNode,這種做法完全不經過 innerHTML,天然免疫 XSS:
const tpl = document.getElementById('studentTpl');
const tbody = document.querySelector('#studentTable tbody');
data.forEach(s => {
const clone = tpl.content.cloneNode(true);
clone.querySelector('.t-name').textContent = s.tName; // textContent 自動跳脫
clone.querySelector('.t-age').textContent = s.tAge;
tbody.appendChild(clone);
});
結論:模板這個概念本身完全正確且至今通用,只是 jquery.tmpl 這個具體實作已經退場。理解它想解決的問題,再挑一個有在維護、且預設做跳脫的工具即可。