DIV CSS 佈局教程網

tmpl 模板引擎:bug 修復與 with 語句帶來的效能黑洞
編輯:關於JavaScript     

精妙的 tmpl

前端模板類開源的不少,但最屬 jQuery 作者 John Resig 的「JavaScript Micro Templating」精妙,寥寥幾筆就完成了模板引擎的核心功能。作者介紹可見 https://ejohn.org/blog/javascript-micro-templating/ 。

(function(){
var cache = {};

this.tmpl = function (str, data){
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(obj){p.push('" +
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('');");
return data ? fn( data ) : fn;
};
})();

麻雀雖小五臟俱全,除了基本的資料附加,還有快取機制與邏輯支援。若評選「最省能的 JavaScript 自訂函式」,第一名是 $(getElementById 簡版),第二名大概就是 tmpl。

三個 bug

一、無法正確處理轉義字元。

tmpl('<%=name%>//<%=id%> ', {name:'糖餅', id: '1987'});

它會報錯,正常應輸出「糖餅/1987」。解法很簡單,在解析前補一行把反斜線本身轉義:str.replace(/\\/g, "\\\\")。

二、無法正確區分第一個參數是 ID 還是模板。 若頁面模板的 id 帶有底線(如 tmpl-photo-thumb),它不會去查這個元素,而會誤認為傳入的是原始模板直接編譯。原始模板與元素 id 最直觀的差別是是否含空白,所以把判斷式從 !/\W/.test(str) 改成 !/\s/.test(str) 即可。

三、殘留測試用程式碼。 print=function(){p.push.apply(p,arguments);} 這段是除錯用的,可刪。

效能疑雲:罪魁禍首是 with

直到看了介紹 YayaTemplate 的文章,我才認真看待這個問題。那篇文章測試了各大流行模板引擎,結論是 YayaTemplate 最快。tmpl 雖然不敵,但也讓我打消了顧慮——實際應用中它與傳統字串拼接差不多,只有超大規模解析才會拉開差距。(一次給瀏覽器塞上千條列表資料還嫌慢,問題多半不在引擎。)

不過若真要追根究柢,為什麼 tmpl 會比 YayaTemplate 慢?

語法解析? 不是。YayaTemplate 用「JavaScript 包裹 HTML」的新穎語法,但最終都得靠正則表達式解析成標準語法,效率差異有限,而且雙方都有快取,只解析原始模板一次。

資料轉換? 就是這裡。模板引擎會把資料以變數形式放進閉包,而兩者的變數宣告機制不同:

YayaTemplate 用傳統傳參——遍歷資料物件,把屬性名當成 new Function 的參數名,再用 apply 傳值進去。

tmpl 則用了 JavaScript 裡並不常用的 with,寫起來簡潔,還省了 var。

問題就出在 with。它的本意是讓屬性存取更省事,但它在語言中的存在會嚴重拖累引擎速度,因為它阻止了變數名的詞法作用域綁定——引擎無法在編譯期確定某個識別字指向哪裡,只能延後到執行期動態解析。

優化版

把 with 換成傳統傳參,效能立刻大躍進。實測 24 萬筆資料下:Firefox 提升約 5 倍、Chrome 2.4 倍、Safari 2.1 倍、Opera 1.84 倍、IE9 1.35 倍、IE6 1.1 倍,最終與 YayaTemplate 不分上下。測試網址:https://www.planeart.cn/demo/tmpl/tmpl.html

/**
* 微型模板引擎 tmpl 0.2
*
* 0.2 更新:
* 1. 修復轉義字符與id判斷的BUG
* 2. 放棄低效的 with 語句從而最高提升3.5倍的執行效率
* 3. 使用隨機內部變量防止與模板變量產生沖突
*
* @author John Resig, Tang Bin
* @param {String} 模板內容或者裝有模板內容的元素ID
* @param {Object} 附加的數據
* @return {String} 解析好的模板
*
* @example
* 方式一:在頁面嵌入模板(會自動緩存編譯結果)
* <script type="text/tmpl" id="tmpl-demo">
* <ol title="<%=name%>">
* <% for (var i = 0, l = list.length; i < length; i ++) { %>
* <li><%=list[i]%></li>
* <% } %>
* </ol>
* </script>
* tmpl('tmpl-demo', {name: 'demo data', list: [202, 96, 133, 134]})
*
* 方式二:直接傳入模板(緩存交給外部控制)
*/
var tmpl = (function (cache, $) {
return function (str, data) {
var fn = !/\s/.test(str)
? cache[str] = cache[str]
|| tmpl(document.getElementById(str).innerHTML)
: function (data) {
var i, variable = [$], value = [[]];
for (i in data) {
variable.push(i);
value.push(data[i]);
};
return (new Function(variable, fn.$))
.apply(data, value).join("");
};
fn.$ = fn.$ || $ + ".push('"
+ str.replace(/\\/g, "\\\\")
.replace(/[\r\t\n]/g, " ")
.split("<%").join("\t")
.replace(/((^|%>)[^\t]*)'/g, "$1\r")
.replace(/\t=(.*?)%>/g, "',$1,'")
.split("\t").join("');")
.split("%>").join($ + ".push('")
.split("\r").join("\\'")
+ "');return " + $;
return data ? fn(data) : fn;
}})({}, '$' + (+ new Date));

模板引擎依賴 Function 建構子,它和 eval 一樣提供了「用文字存取 JavaScript 解析引擎」的能力,效能上必然有所損失,但在 JavaScript 裡已別無他法。另外,Function 建構子對參數名稱有規範要求,所以資料的成員命名必須符合變數命名規則,否則會報錯——好在這個錯誤在執行當下就會暴露,不會變成埋在線上的地雷。

三個實用小技巧

一、快取優化。 傳 ID 時 tmpl 會自動快取,只解析一次。若你直接傳模板字串又要重複使用,建議用變數存起來:

// 生成模板緩存
var render = tmpl(listTmpl);
// 可多次調用模板
elem.innerHTML = render(data1);
elem.innerHTML = render(data2);

二、避免未定義變數使整個程式崩掉。 模板裡輸出了某變數,但傳入的資料少了這個欄位,就會拋未定義錯誤。無法保證資料完整時,可以先探測。原版用 obj 保存原始傳入資料,升級版則是 this:

<% if (this.dataName !== undefined) { %>
<%=dataName %>
<% } %>

三、除錯模板。 由於模板是以文字呼叫 JavaScript 引擎,除錯工具無法定位出錯行。升級版可以把編譯後的程式碼印出來:

<script id="tmpl" type="text/tmpl">
<ul>
<% for (var i = 0, l = list.length; i < l; i ++) { %>
<li><%=list[i].index%>. 用戶: <%=list[i].user%>; 網站:<%=list[i].site%></li>
<% } %>
</ul>

window.console(tmpl('tmpl').$);

輸出結果:

"$1318348744541.push('
<ul> '); for (var i = 0, l = list.length; i < l; i ++) { $1318348744541.push('
<li>',list[i].index,'. 用戶: ',list[i].user,'; 網站:',list[i].site,'</li>
'); } $1318348744541.push('
</ul>
');return $1318348744541"

有了編譯後的語句,就能對照檢查模板哪裡寫錯了。($1318348744541 是隨機產生的臨時陣列名,可忽略。)

最後感謝 tmpl 原作者與 YayaTemplate 作者的付出,正因為有他們,我才有機會深入分析實現機制、解決問題並從中受益。獨樂不如眾樂,分享之。

唐斌 – 2011.10.09 – 湖南長沙

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