$.ajax() 是 jQuery 中最強大也最靈活的 Ajax 方法,掌握它的參數,幾乎能應付所有非同步請求場景。以下逐項說明。
url:String 型別,發送請求的位址,預設為當前頁位址。
type:String 型別,請求方式(post 或 get),預設為 get。其他 HTTP 方法如 put、delete 也能使用,但僅部分瀏覽器支援。
timeout:Number 型別,設定請求逾時時間(毫秒),此設定會覆蓋 $.ajaxSetup() 的全域設定。
async:Boolean 型別,預設 true(非同步)。若要發送同步請求請設為 false,但要注意同步請求會鎖住瀏覽器,使用者其他操作必須等請求完成才能執行。
cache:Boolean 型別,預設 true(dataType 為 script 時預設 false)。設為 false 將不會從瀏覽器快取載入請求資訊。
data:Object 或 String 型別,發送到伺服器的資料。若非字串會自動轉為字串格式,get 請求會附加在 url 後。物件須為 key/value 格式,例如 {foo1:"bar1",foo2:"bar2"} 會轉為 &foo1=bar1&foo2=bar2。若是陣列,jQuery 會自動為不同值對應同一名稱,例如 {foo:["bar1","bar2"]} 轉為 &foo=bar1&foo=bar2。
dataType:String 型別,預期伺服器回傳的資料型別。若不指定,jQuery 會依 HTTP 的 mime 資訊自動判斷回傳 responseXML 或 responseText。可用型別如下:
xml:回傳 XML 文件,可用 jQuery 處理。
html:回傳純文字 HTML 資訊;其中的 script 標籤會在插入 DOM 時執行。
script:回傳純文字 JavaScript 程式碼,不會自動快取結果(除非設定 cache)。注意遠端請求時(非同一網域),所有 post 都會轉為 get。
json:回傳 JSON 資料。
jsonp:JSONP 格式。使用 JSONP 呼叫函式時(如 myurl?callback=?),jQuery 會自動把後一個「?」替換為正確的函式名以執行回呼。
text:回傳純文字字串。
beforeSend:Function 型別,發送請求前可修改 XMLHttpRequest 物件的函式,例如添加自訂 HTTP 標頭;若回傳 false 可取消本次請求。
complete:Function 型別,請求完成後(成功或失敗皆會)呼叫的回呼函式,參數為 XMLHttpRequest 物件與描述狀態的字串。
success:Function 型別,請求成功後呼叫的回呼函式,參數為 (1) 伺服器回傳並依 dataType 處理後的資料,(2) 描述狀態的字串。
error:Function 型別,請求失敗時呼叫的函式,參數為 XMLHttpRequest 物件、錯誤資訊、捕獲的錯誤物件(可選)。
contentType:String 型別,發送資訊至伺服器時的內容編碼型別,預設為 "application/x-www-form-urlencoded",適合大多數場合。
dataFilter:Function 型別,對 Ajax 回傳的原始資料做預處理的函式,提供 data 與 type 兩個參數,回傳值會由 jQuery 進一步處理。
global:Boolean 型別,預設 true,表示是否觸發全域 ajax 事件。設為 false 則不觸發,ajaxStart 或 ajaxStop 可用於控制各種 ajax 事件。
ifModified:Boolean 型別,預設 false。僅在伺服器資料改變時才取新資料,判斷依據是 Last-Modified 標頭資訊。
jsonp:String 型別,在 jsonp 請求中重寫回呼函式的名字,用來替代 URL 參數裡的 "callback" 部分。
username/password:String 型別,用於回應 HTTP 存取認證請求的帳號與密碼。
processData:Boolean 型別,預設 true。預設會把資料轉為物件以配合 "application/x-www-form-urlencoded"。若要發送 DOM 樹或不希望轉換的資訊,請設為 false。
scriptCharset:String 型別,僅當 dataType 為 "jsonp" 或 "script" 且 type 為 GET 時才用於強制修改字元集,通常用於本地與遠端內容編碼不同時。
$(function(){
$('#send').click(function(){
$.ajax({
type: "GET",
url: "test.json",
data: {username:$("#username").val(), content:$("#content").val()},
dataType: "json",
success: function(data){
$('#resText').empty(); //清空 resText 中的所有內容
var html = '';
$.each(data, function(commentIndex, comment){
html += '<div class="comment"><h6>' + comment['username']
+ ':</h6><p class="para">' + comment['content']
+ '</p></div>';
});
$('#resText').html(html);
}
});
});
});
最後補充一下 $.each() 函式:它有別於 jQuery 物件的 each() 方法,是一個全域函式,不操作 jQuery 物件,而是以一個陣列或物件作為第一個參數、回呼函式作為第二個參數。回呼函式擁有兩個參數:第一個是物件的成員或陣列的索引,第二個是對應的變數或內容。