下表整理了 jQuery 中 $.ajax 的常用參數及其含義,是進行 Ajax 開發時必須熟悉的基礎知識。
url(String,默認:當前頁地址)發送請求的地址。
type(String,默認:"GET")請求方式("POST" 或 "GET"),默認為 "GET"。注意:其他 HTTP 方法如 PUT 和 DELETE 也可以使用,但僅部分瀏覽器支持。
timeout(Number)設置請求超時時間(毫秒),此設置將覆蓋全局設置。
async(Boolean,默認:true)默認所有請求均為異步。若需發送同步請求,請設為 false。注意,同步請求會鎖住瀏覽器,用戶的其他操作必須等待請求完成才能執行。
beforeSend(Function)發送請求前可修改 XMLHttpRequest 對象的函數,比如添加自定義 HTTP 頭。XMLHttpRequest 對象是唯一的參數。
function (XMLHttpRequest) {
this; // the options for this ajax request
}
cache(Boolean,默認:true)jQuery 1.2 新增功能,設置為 false 將不會從瀏覽器緩存中加載請求信息。
complete(Function)請求完成後的回調函數(無論成功或失敗都會調用)。參數為 XMLHttpRequest 對象與成功信息字符串。
function (XMLHttpRequest, textStatus) {
this; // the options for this ajax request
}
contentType(String,默認:"application/x-www-form-urlencoded")發送信息至服務器時的內容編碼類型,默認值適合大多數場合。
data(Object 或 String)發送到服務器的數據,將自動轉為請求字符串格式,GET 請求中會附加在 URL 之後。必須為 Key/Value 格式。如果為數組,jQuery 會自動為相同名稱對應多個值,如 {foo:["bar1", "bar2"]} 轉為 '&foo=bar1&foo=bar2'。
dataType(String)預期服務器返回的數據類型。若不指定,jQuery 會根據 HTTP 包的 MIME 信息自動判斷並返回 responseXML 或 responseText。可用值:
"xml":返回 XML 文檔,可用 jQuery 處理;
"html":返回純文本 HTML 信息,包含 script 元素;
"script":返回純文本 JavaScript 代碼,不會自動緩存結果;
"json":返回 JSON 數據;
"jsonp":JSONP 格式,使用 "myurl?callback=?" 時 jQuery 會自動把 ? 替換為正確的函數名以執行回調。
error(Function,默認:自動判斷 xml 或 html)請求失敗時調用。這個方法有三個參數:XMLHttpRequest 對象、錯誤信息、(可能)捕獲的錯誤對象。
function (XMLHttpRequest, textStatus, errorThrown) {
// 通常情況下 textStatus 和 errorThrown 只有其中一個有值
this; // the options for this ajax request
}
global(Boolean,默認:true)是否觸發全局 AJAX 事件。設為 false 將不觸發 ajaxStart 或 ajaxStop 等全局事件,可用於控制不同的 Ajax 事件。
ifModified(Boolean,默認:false)僅在服務器數據改變時才獲取新數據,使用 HTTP 包的 Last-Modified 頭信息判斷。
processData(Boolean,默認:true)默認情況下發送的數據會被轉換為對象以配合默認內容類型。如果要發送 DOM 樹信息或其他不希望轉換的信息,請設為 false。
success(Function)請求成功後的回調函數,有兩個參數:服務器返回數據與返回狀態。
function (data, textStatus) {
// data could be xmlDoc, jsonObj, html, text, etc...
this; // the options for this ajax request
}
這裡有四個重要的 Ajax 事件參數:beforeSend、success、complete、error。我們可以定義這些事件來很好地處理每一次 Ajax 請求。需要注意的是,這些回調裡的 this 都指向該次 Ajax 請求的選項信息。想用好 jQuery 進行 Ajax 開發,以上參數都值得反覆研讀並牢記於心。