請求已經格式化好的HTML片段固然方便,但代價是:你在傳輸文字內容的同時,也把一大堆標籤一起送了下來。當資料量小、又需要立刻處理時,這種開銷顯得不划算。比較理想的情況是只傳純資料,讓前端拿到一個可以直接遍歷的結構。
用jQuery選擇器操作HTML固然可行,但JavaScript本身還內建了一種更省字元、也更省程式碼的資料格式。
JavaScript物件由一組「鍵—值」對構成,用花括號定義;陣列則用方括號搭配遞增索引動態宣告。兩種語法一組合,再龐大的結構都能輕鬆表達。
Douglas Crockford把這種精簡語法命名為JSON(JavaScript Object Notation)。它的表達力足以取代冗長的XML:
{
"key": "value",
"key 2": [
"array",
"of",
"items"
]
}
不過JSON對值有明確限制:所有物件的鍵與所有字串值都必須包在雙引號裡,函式也不是合法的JSON值。正因為這些約束,實務上不建议手寫編輯JSON,而應由伺服器端程式產生。
把字典詞條編碼後存成 b.json,開頭大致如下:
[
{
"term": "BACCHUS",
"part": "n.",
"definition": "A convenient deity invented by the...",
"quote": [
"Is public worship, then, a sin,",
"That for devotions paid to Bacchus",
"The lictors dare to run us in,",
"And resolutely thump and whack us?"
],
"author": "Jorace"
},
{
"term": "BACKBITE",
"part": "v.t.",
"definition": "To speak of a man as you find him when..."
},
{
"term": "BEARD",
"part": "n.",
"definition": "The hair that is commonly cut off by..."
}
]
要讀取這份資料,用 $.getJSON() 即可。伺服器回傳的只是一段JSON文字,這個方法會負責解析,並把結果以JavaScript物件的形式交給呼叫端。
到目前為止用到的jQuery方法,都得先透過 $() 建立物件才能呼叫——因為它們的操作對象是選擇器選出來的那組DOM節點。但 $.getJSON() 不一樣:邏輯上並沒有哪個DOM元素是它的操作對象,結果只交給程式碼使用,不會插入頁面。因此它被定義為全域jQuery函式,而非某個jQuery執行個體的方法。
這類函式掛在jQuery命名空間底下,可以避免名稱衝突。
$(document).ready(function() {
$('#letter-b a').click(function(event){
event.preventDefault();
$.getJSON('b.json');
});
});
點下去什麼也不會發生:檔案確實載入了,但程式並不知道該拿回傳的資料做什麼。這時需要一個回呼函式。
$(document).ready(function() {
$('#letter-b a').click(function(event){
event.preventDefault();
$.getJSON('b.json', function(data){
// 在這裡處理 data
});
});
});
AJAX請求是非同步的,回呼函式提供了一種「等資料回來再說」的機制,而不是立刻往下執行。回呼會收到一個參數,用來承接伺服器回傳的資料。這裡使用匿名函式是為了精簡,當然也可以傳入具名函式的參照。
拿到data之後,需要迭代最外層陣列,為每一項組出對應的HTML。除了標準for迴圈,jQuery還提供了另一個實用全域函式 $.each()(對應的方法版本是 .each())。它接收的第一個參數是陣列或物件,第二個是回呼函式,回呼會收到「目前索引」與「目前項目」兩個參數。
$(document).ready(function() {
$('#letter-b a').click(function(event){
event.preventDefault();
$.getJSON('b.json', function(data){
var html = '';
$.each(data, function(entryIndex, entry){
html += '<div class="entry">';
html += '<h3 class="term">' + entry.term + '</h3>';
html += '<div class="part">' + entry.part + '</div>';
html += '<div class="definition">';
html += entry.definition;
html += '</div>';
html += '</div>';
});
$('#dictionary').html(html);
});
});
});
組好字串後,用 .html() 塞進 <div id="dictionary">,原有的內容會被整批替換。
關於安全:這種做法的前提是資料內容必須能安全地拼進HTML,也就是不能含任何 < 字元。若資料來源不完全可控,就該改用轉義處理。
詞條裡的引用段落需要多一層 $.each():
$(document).ready(function() {
$('#letter-b a').click(function(event){
event.preventDefault();
$.getJSON('b.json', function(data){
var html = '';
$.each(data, function(entryIndex, entry){
html += '<div class="entry">';
html += '<h3 class="term">' + entry.term + '</h3>';
html += '<div class="part">' + entry.part + '</div>';
html += '<div class="definition">' + entry.definition;
if (entry.quote){
html += '<div class="quote">';
$.each(entry.quote, function(lineIndex, line){
html += '<div class="quote-line">' + line + '</div>';
});
if (entry.author){
html += '<div class="quote-author">' + entry.author + '</div>';
}
html += '</div>';
}
html += '</div></div>';
});
$('#dictionary').html(html);
});
});
});
寫完之後點擊B字母的連結,右側就會出現對應的字典條目。
JSON格式雖然簡潔,卻不容任何錯誤。方括號、花括號、引號、逗號都必須正確無誤,否則檔案根本不會載入。更麻煩的是,多數瀏覽器在載入失敗時不會給出任何錯誤訊息,腳本只是安靜地全面停擺——這也是為什麼建議由伺服器端程式產生JSON,而不是手工維護。