本文將為大家詳細說明輕量級 JavaScript 模板引擎 Mustache.js 的使用方式。
基本範例
function show(t) { $("#content").html(t); } var view = { title: 'YZF', cacl: function () { return 6 + 4; } }; $("#content").html(Mustache.render("{{title}} spends {{cacl}}", view)); 從範例中可以清楚看到 Mustache 模板的語法——只要用 {{ 和 }} 把屬性名稱包起來即可。
同時也能觀察到一個特性:當指定的屬性是函式時,Mustache 不會直接輸出函式內容,而是先執行它,再把回傳的結果渲染出來。
不轉義 HTML 標籤
var view = { name: "YZF", company: "<b>ninesoft</b>" }; show(Mustache.render("{{name}} <br /> {{company}} <br />{{{company}}}<br/>{{&company}}", view)); 這個範例說明,Mustache 預設會把值裡的 HTML 標記進行轉義,但有時候我們並不希望如此。
因此,只要改用 {{{ 和 }}} 包覆,或使用 {{& 和 }},Mustache 便不會轉義其中的 HTML 標記。
綁定子屬性
var view = { "name": { first: "Y", second: "zf" }, "age": 21 }; show(Mustache.render("{{name.first}}{{name.second}} age is {{age}}", view)); 看到第一個範例時,或許就有人想知道能否綁定子屬性。答案是可以——只需透過「.」即可存取子屬性,非常直覺。
條件式選擇是否渲染指定部分
var view = { person: false }; show(Mustache.render("eff{{#person}}abc{{/person}}", view)); 需求層出不窮——如果我們希望能根據給定的值來決定是否渲染某個區塊,Mustache 也能勝任。要留意的是,導致不渲染的情況不只 false,null、空陣列、0、空字串同樣有效。語法很簡單,用 {{#key}} ... {{/key}} 控制中間內容即可。
循環輸出
var view = { stooges: [ { "name": "Moe" }, { "name": "Larry" }, { "name": "Curly" } ] }; show(Mustache.render("{{#stooges}}{{name}}<br />{{/stooges}}", view));學會前面幾種用法,大部分場景都能應付,但循環輸出仍是一個常見痛點。若一個一個手寫想必十分煩躁,Mustache 對此自有解方。這裡輸出的是一組由物件組成的陣列;如果輸出的是純陣列,則需以 {{.}} 取代 {{name}}。
循環輸出指定函式處理後的結果
var view = { "beatles": [ { "firstname": "Johh", "lastname": "Lennon" }, { "firstname": "Paul", "lastname": "McCartney" } ], "name": function () { return this.firstname + this.lastname; } }; show(Mustache.render("{{#beatles}}{{name}}<br />{{/beatles}}", view)); 除了能循環輸出,我們還希望能對資料做後續加工。這同樣符合 Mustache 的設計——它會把陣列中的值傳給你的函式,並輸出函式回傳的結果。此例中最外層是陣列,只要在其中使用函式,外層陣列就會作為參數傳入。
自訂函式
var view = { "name": "Tater", "bold": function () { return function (text, render) { return render(text) + "<br />"; } } } show(Mustache.render("{{#bold}}{{name}}{{/bold}}", view)); 前面我們都用變數作為節,那如果用函式當作節會有什麼效果呢?
此時 Mustache 會呼叫我們函式所回傳的函式,並把節中間的原始字串作為第一個參數、預設的解譯器作為第二個參數,於是我們就能自行加工內容。
反義節
var view = { "repos": [] }; show(Mustache.render("{{#repos}}{{.}}{{/repos}}{{^repos}}no repos{{/repos}}", view)); 前面用過的節只能選擇是否輸出某個區塊,這裡我們再補上一塊拼圖。
若改用 {{^ 和 }} 定義節,則該區塊只會在值為空、null、空陣列或空字串時才顯示。如此一來,就能實現類似 if-else 的效果。
部分模板
var view = { names: [ { "name": "y" }, { "name": "z" }, { "name": "f" } ] }; var base = "<h2>Names</h2>{{#names}}{{>user}}{{/names}}"; var name = "<b>{{name}}</b>"; show(Mustache.render(base, view, { user: name })); Mustache 雖然省下不少時間,但如果定義了很多彼此無法互相嵌套的模板,仍會顯得繁瑣。
因此這裡要介紹如何定義「部分模板」,讓它能在其他模板中被引用,方式就是 {{>templatename}}。
最大的差別在於,此時 Mustache.render 多了一個第三個參數。
預先編譯模板
Mustache.parse(template); //其他代碼 Mustache.render(template,view);
模板機制雖有優點,但也有成本——編譯模板需要時間。因此,在已知某個模板會被重複使用的前提下,我們可以事先將它編譯好,以便後續調用時省去重複編譯的開銷。
希望本文所述對大家的學習有所幫助。