$.ajax() 是 jQuery 中最底層、最靈活的 Ajax 實現。所有其他封裝方法(如 $.get、$.post)最終都基於它。本文將系統梳理它的語法、參數、回調函數、數據類型及高級用法。
一、定義與用法
ajax() 方法通過 HTTP 請求加載遠程數據,返回其創建的 XMLHttpRequest 對象。最簡單的情況下可以不帶任何參數直接使用。需要注意,所有選項都可以通過 $.ajaxSetup() 函數進行全局設置。
語法:
jQuery.ajax([settings])
其中 settings 為可選的、用於配置 Ajax 請求的鍵值對集合。
二、常用參數
- async(Boolean,默認 true)
- 默認所有請求均為異步。若設置為 false 則發送同步請求,但同步請求會鎖住瀏覽器,用戶其它操作必須等待請求完成才能執行,因此不建議使用。
- beforeSend(XHR)(Function)
- 發送請求前修改 XMLHttpRequest 對象的函數,例如添加自定義 HTTP 頭。若返回 false 可取消本次請求。
- cache(Boolean,默認 true,dataType 為 script/jsonp 時默認為 false)
- 設置為 false 將不使用緩存結果。
- complete(XHR, TS)(Function)
- 請求完成後的回調函數,無論成功或失敗都會調用。
- contentType(String,默認 "application/x-www-form-urlencoded")
- 發送信息至服務器時的內容編碼類型,默認值適合大多數情況。
- context(Object)
- 用於設置回調函數的上下文,即讓回調函數內的 this 指向該對象。
- data(Object/String)
- 發送到服務器的數據,會自動轉換為請求字符串格式。必須為 Key/Value 格式,若為數組,jQuery 會自動為相同名稱的不同值進行處理,如 {foo:["bar1","bar2"]} 轉為 'foo=bar1&foo=bar2'。值得注意的是,用對象形式傳參時,若值中包含 "&" 等特殊字符則無需手動轉義,而用字符串 URL 傳參時則可能需要用 encodeURIComponent() 處理。
- dataType(String)
- 預期服務器返回的數據類型。若不指定,jQuery 會根據 HTTP 包的 MIME 信息智能判斷。可用值包括:xml、html、script、json、jsonp、text。
- error(Function)
- 請求失敗時調用的函數,有三個參數:XMLHttpRequest 對象、錯誤信息、(可選)捕獲的異常對象。錯誤信息可能是 timeout、error、notmodified 或 parsererror。
- global(Boolean,默認 true)
- 是否觸發全局 AJAX 事件。設置為 false 則不會觸發 ajaxStart、ajaxStop 等全局事件。
- success(Function)
- 請求成功後的回調函數,參數為服務器返回並經 dataType 處理後的數據,以及描述狀態的字符串。
- timeout(Number)
- 設置請求超時時間(毫秒),此設置會覆蓋全局設置。
- type(String,默認 "GET")
- 請求方式,可為 "POST" 或 "GET"。其它如 PUT、DELETE 也可使用,但僅部分瀏覽器支持。
- url(String,默認當前頁地址)
- 發送請求的地址。
三、回調函數
若要處理 $.ajax() 得到的數據,需要使用以下回調函數:
- beforeSend:發送請求前調用,傳入 XMLHttpRequest 作為參數。
- error:請求出錯時調用,傳入 XHR 對象、錯誤類型字符串及異常對象。
- dataFilter:請求成功後調用,傳入返回數據與 dataType 值,必須返回新數據傳給 success。
- success:請求成功後調用,傳入返回數據及成功狀態字符串。
- complete:請求完成後調用,無論成功或失敗,傳入 XHR 對象與狀態字符串。
四、數據類型(dataType)
$.ajax() 依賴服務器提供的信息來判斷如何處理返回數據:
- 若為 XML,可用普通 XML 方法或 jQuery 選擇器遍歷。
- 若為 text 或 xml,數據不經處理,直接將 responseText 或 responseXML 傳給 success。
- 若為 html,任何內嵌的 JavaScript 都會在 HTML 作為字符串返回前執行。
- 若為 json,會先嘗試用 JSON.parse() 解析為 JavaScript 對象,瀏覽器不支持時則用函數構建。
- 若為 jsonp,會創建 callback=? 查詢參數,服務器需返回帶回調函數名的 JSON 數據以完成跨域請求。
需要特別注意:必須確保服務器報告的 MIME 類型與選擇的 dataType 相匹配,例如 XML 需服務器聲明 text/xml 或 application/xml 才能獲得一致結果。
五、發送數據到服務器
默認情況下 Ajax 使用 GET 方法,可通過 type 參數改為 POST。data 選項既可包含查詢字符串(如 key1=value1&key2=value2),也可以是映射對象(如 {key1:'value1'}),後者會被自動轉換為查詢字符串。若想發送 XML 對象等不希望被轉換的數據,可將 processData 設為 false,並相應修改 contentType 的值。
六、高級選項
global 選項可用於阻止響應註冊的回調函數,在請求非常頻繁且短暫時十分有用。username 與 password 可用於響應需要 HTTP 認證的請求。cache 設為 false 可禁止使用緩存結果,ifModified 設為 true 則僅在數據有變動時才獲取新數據。
需要強調的是,Ajax 的首字母 A 代表 asynchronous(異步),意味著所有操作並行、完成順序沒有先後。async 參數默認為 true,強烈不建議設為 false,否則會導致瀏覽器被鎖死。此外,$.ajax 返回其創建的 XMLHttpRequest 對象,調用對象上的 .abort() 可在請求完成前掛起請求。