jQuery 除了提供強大的選擇器,對 Ajax 也有相當完整的支援。除了底層的 $.ajax(),它另外包裝了幾個更直覺的簡便方法:
$.get(url, [data], [callback], [type])
$.getJSON(url, [data], [callback])
$.getScript(url, [callback])
$.post(url, [data], [callback], [type])
由於 $.ajax() 功能最強、可設定參數最多,以下把實務上最容易踩到的重點整理出來。
$.ajax() 預設以異步方式發送請求。若情境確實需要同步(例如某些 Flash 與 JS 互動的應用,呼叫一個 JS 函數後必須立刻取得回傳值),才把 async 設為 false。同步會讓瀏覽器在等待期間凍結,非必要不建議使用。
GET 請求的結果常被瀏覽器快取。若希望每次都拿到最新資料,可以把 cache 設為 false,或在網址後附加時間戳,讓瀏覽器視之為新請求而重新向伺服器取資料。以 POST 發送的請求預設不會被快取。
不指定 dataType 時,jQuery 會依 HTTP 回應的 MIME 資訊自動判斷,再以 responseXML 或 responseText 傳入回呼函數。常見取值如下:
"xml":回傳 XML 文件,可用 jQuery 直接處理。
"html":回傳純文字 HTML,其中包含的 script 標籤會在插入 DOM 時執行。
"script":回傳純文字 JavaScript 程式碼,結果預設不快取(除非明確設定 cache)。特別注意:跨網域請求時,因為底層是使用 DOM 的 script 標籤載入,所有 POST 都會被轉為 GET。
"json":回傳 JSON 資料。
"jsonp":以 JSONP 形式呼叫,例如 "myurl?callback=?",jQuery 會自動把問號替換成正確的函式名稱來執行回呼。
"text":回傳純文字字串。
其中 "script" 與 "json" 這兩種設定,還能順便解決 Ajax 的跨網域問題。
若伺服器只回傳字串或數值,用一般的 ajax 呼叫即可。若回傳的是 JSON 物件,建議直接用 jQuery.getJSON,或明確把 dataType 設為 json:由伺服器端輸出 JSON 物件可省下瀏覽器的解析時間,避免「伺服器明明有回應、前端卻取不到資料」的經典錯誤。
Ajax 需要時間,因此拿到資料後的所有處理都應該放在 success 裡。常見的錯誤寫法如下:
function getMyPrizeList(){
if(isNotEmpty(uid)){
var obj = new Object();
jQuery.ajax({
type:"GET", url:"someurl", async:false, cache:false,
dataType:"script", scriptCharset:"gbk",
success:function(json){ obj = json; }
});
obj = eval("(" + obj + ")"); // 這裡往往還拿不到資料
var str = "";
for(var i in obj){
str += '<tr><th>' + prizearray[obj[i].prizeno] + '</th>';
str += '<td>CD-KEY:' + obj[i].cdkey + '</td>';
str += '<td>期限:' + obj[i].expiratedate + '前</td></tr>';
}
jQuery("#prizelist").append(str);
}
}
正確做法是把渲染邏輯全搬進 success 函數:
function getMyPrizeList(){
if(isNotEmpty(uid)){
var obj = new Array();
jQuery.ajax({
type:"GET", url:"someurl", cache:false,
dataType:"script", scriptCharset:"gbk",
success:function(json){
try{ obj = json; }catch(e){}
jQuery("#prizelist").html("");
var str = "";
for(var i = 0; i < obj.length; i++){
str += '<tr><th>' + prizearray[obj[i].prizeno] + '</th>';
str += '<td>CD-KEY:' + obj[i].cdkey + '</td>';
str += '<td>期限:' + obj[i].expiratedate + '前</td></tr>';
}
jQuery("#prizelist").append(str);
}
});
}
}
下面是一個載入人員詳情並回填表單的常見寫法,重點是「用 key 動態對應元素」:
function innerShowDetail(){
$.getJSON('load.do', {id: userId}, function(json){
for(key in json){
if(key == 'id'){
$('#detailDiv #' + key).val(json[key]);
}else if(json[key] == ''){
$('#detailDiv #' + key).html(' ');
}else if(key == 'sex'){
$('#detailDiv #' + key).html(json[key] == '0' ? '女' : '男');
}else if(key == 'group'){
if(json[key] != null){
$('#detailDiv #' + key).html(json[key]['groupName']);
}
}else{
$('#detailDiv #' + key).html(json[key]);
}
}
$('#detailDiv').removeAttr('class');
dialog.setTitle('查看人員[' + json['userName'] + ']詳細資料');
dialog.setContent($('#detailDiv').html());
});
}
掌握以上幾點,$.ajax() 在真實專案裡就夠用了;剩下的眉角,通常來自回呼時機與型別宣告這兩件事。