在打造 JavaScript 應用時,我一直很依賴一個小工具:一個極簡的模板函式。它速度快、支援快取、用法直觀。本文拆解它的實作,順便談談用它的幾個技巧。
這個版本出自 John Resig(jQuery 作者),原始碼附於《Secrets of the JavaScript Ninja》,以 MIT 授權發布:
// 簡易 JavaScript 模板引擎
// John Resig - https://ejohn.org/ - MIT Licensed
(function () {
var cache = {};
this.tmpl = function tmpl(str, data) {
// 判斷傳入的是 id 還是模板本體,並把結果存入快取
var fn = !/\W/.test(str)
? cache[str] = cache[str] || tmpl(document.getElementById(str).innerHTML)
:
// 生成可重用的函式(同時寫入快取)
new Function("obj",
"var p=[],print=function(){p.push.apply(p,arguments);};" +
// 用 with 把資料引入為區域變數
"with(obj){p.push('" +
// 把模板轉成純 JavaScript
str
.replace(/[\r\t\n]/g, " ")
.split("<%").join("\t")
.replace(/((^|%>)[^\t]*)'/g, "$1\r")
.replace(/\t=(.*?%>)/g, "',$1,'")
.split("\t").join("');")
.split("%>").join("p.push('")
.split("\r").join("\\'")
+ "');}return p.join('');"
);
// 提供基本的柯里化:不傳 data 就回傳函式本身
return data ? fn(data) : fn;
};
})();
它的核心手法是:把模板字串編譯成 JavaScript 原始碼,交給 new Function 產生函式。一連串 replace 與 split().join() 做的事,是把 <%= ... %> 翻譯成字串串接的中段插入,把 <% ... %> 翻譯成陳述句的邊界。
值得注意的一個細節:這裡刻意用 split("match").join("replacement") 而非 replace(/match/g, ...)。在當時的瀏覽器上,靜態字串搜尋與替換比正則表達式全域比對更快——看起來不直觀,卻是實測結果。到了現代引擎,兩者差距已經很小,正則版本的可讀性反而更好。
<script type="text/html" id="item_tmpl">
<div id="<%=id%>" class="<%=(i % 2 == 1 ? " even" : "")%>">
<div class="grid_1 alpha right">
<img class="righted" src="<%=profile_image_url%>" />
</div>
<div class="grid_6 omega contents">
<p><b><a href="/<%=from_user%>"><%=from_user%></a>:</b> <%=text%></p>
</div>
</div>
</script>
迴圈也可以直接內嵌:
<script type="text/html" id="user_tmpl">
<% for (var i = 0; i < users.length; i++) { %>
<li><a href="<%=users[i].url%>"><%=users[i].name%></a></li>
<% } %>
</script>
type="text/html" 這個技巧很值得記:瀏覽器遇到不認得的 type 就不會執行該區塊,內容安靜地留在 DOM 裡供你取用。搜尋引擎與螢幕閱讀器也會略過它,等於一個乾淨的模板容器。
最簡單的直接渲染:
var results = document.getElementById("results");
results.innerHTML = tmpl("item_tmpl", dataObject);
預先編譯,之後重複使用:
var show_user = tmpl("item_tmpl"), html = "";
for (var i = 0; i < users.length; i++) {
html += show_user(users[i]);
}
只傳 id 或模板字串時回傳的是編譯好的函式,這正是快取派上用場的地方——同一份模板只編譯一次,後續呼叫都跳過解析。
這個引擎的教學價值遠大於實用價值。它用不到 30 行示範了模板編譯的完整思路:詞法掃描、程式碼生成、快取、柯里化。理解它之後,你會更明白 _.template、Handlebars 乃至 JSX 背後在做什麼。
但新專案請不要直接採用它,原因很實際:new Function 在需要嚴格 Content Security Policy 的環境下會被阻擋;with 陳述式已在嚴格模式中被禁用;而最關鍵的是,<%= %> 不做任何轉義,把使用者輸入直接插入 innerHTML 就是 XSS 的教科書案例。若要沿用這個思路,至少得自己補上 HTML 轉義函式。