在 Ajax 盛行的今天,我們對頁面互動有了更高要求,動態生成 HTML 就是其中一環。動態生成 HTML 的方式有很多,核心不外乎在前端(JS)或後端(C#/PHP…)把資料組裝成想要的模板,再輸出給使用者(innerHTML、documentWrite 等方式)。
傳統拼接方式的缺點
1)拼接字串的過程容易出錯,常忘了 '/ "> 等配對符號。
2)修改前台模板時容易遺忘同步更改動態生成的模板。
3)拼接字串不直觀美觀,不利於查找錯誤,例如資料中存在 HTML 內容會導致各種麻煩。
4)難以滿足較高的業務邏輯需求,處理判斷較麻煩,例如 A 情況生成 X 模板、B 情況生成 Y 模板。
5)複用性低,相似的模板難以共用。
需求
1)簡單直觀的模板;2)易於維護(方便查錯、有程式碼著色);3)模板可複用;4)能處理一定的邏輯判斷。
解決方案
基於以上缺點,jQuery Tmpl 這個外掛能很好地滿足需求。使用它只需引入這個外掛即可,體積十分小巧(5.97KB),對效能影響不大。據聞它由 Microsoft 開發,對 ASP.NET MVC 的友好度很高。

從上圖能直觀看到 Tmpl 的工作原理:我們只需提供資料與模板。資料可透過後端 Json 方法傳到前台,而模板則是接下來的重點。
1)模板程式碼寫在哪裡?
<script type="text/x-jquery-tmpl" id="testTemplate"> /* 模板程式碼 */ </script>
可見模板程式碼的容器就是 <script> 標籤,只是 type 是 'text/x-jquery-tmpl' 而非平常用的 'text/javascript'。在 Visual Studio 2012 中已對這個類型有智慧提示。
2)模板的語法
我把 jQuery Tmpl 的語法分為三大類:
1. 顯示類:{{html}} / {{= }} / ${ }。這三個標籤都能把資料輸出到模板中,但 {{html}} 不會對資料編碼(用於輸出 HTML 碼段),而 {{=}} 和 ${} 則會編碼,防止資料破壞模板結構。



當我們把 name 的值換成一段 HTML(如 <a href="...">…</a>),就能看出 {{html}} / {{=}} / ${} 的差別:

可見用 {{html}} 輸出內容有一定風險(XSS 攻擊),所以在非確定性資料的安全性考量下,最好用 ${} 輸出,簡單又安全。當然,若能在輸出時呼叫函式處理就更棒了:



2. 條件判斷及循環:{{if}} / {{else}} / {{/if}} / {{each}}。請注意沒有 for / while / switch,jQuery Tmpl 只支援較簡單的邏輯判斷,若滿足不了需求,可以自己寫函式再呼叫。



可以注意到 {{each}} 有兩種寫法:不在 each 後加 (i, v) 時,用 $value 代表當前項的值;而 {{each(i, v)}} 中 i 代表當前項序次、v 代表當前項的值。若條件判斷較複雜,也可用函式判斷(與 JS 一樣)。


3. 復用類:
{{temp}} —— 當分支模板過長(寫在一個模板中較混亂)或使用已寫好的通用模板時,{{temp}} 用來呼叫指定 ID 的模板來顯示資料。

最終效果與之前相同,但把各段獨立開來,提高了可讀性與複用性。若想循環呼叫其他模板(例如輸出興趣愛好那樣):

其中在 eachTemplate 模板中用 $data 代表傳進來的遍歷項的值,相當方便。
{{wrap}} 用於指定模板來包含當前模板,類似於母版頁,當前模板則屬於子頁面。


可見 'wrapTemplate' 作為公共部分,在模板中用 {{html $item.html}} 輸出子頁面的 HTML 內容,且 $item.html 還具備一定的篩選功能。


可見這裡只輸出了第二個 P。$item.html 方法還有一個選項 $item.html(filter, textOnly),textOnly 為 bool 值,若為 true 則只輸出元素的文字而忽略其標籤。


可見 strong 元素沒有了加粗效果,只剩文字。
總結
實際使用時不會常用到進階功能,本文也僅介紹了 jQuery Tmpl 的基礎用法。它能避免我們在 JS 中拼接字串時「改了前台卻忘了改 JS」的窘境,多分支判斷下拼接字串的劣處更明顯。現在把 Tmpl 模板放在前台要生成程式碼的地方,就能大幅減少錯誤發生。
以上內容並未涉及與 ASP.NET 的互動及更多進階技巧,若反應良好將再寫一篇結合 ASP.NET MVC 的應用文章~ ^_^