$.ajax() 是 jQuery 中最核心、最靈活的異步請求方法,功能強大但參數繁多。本文逐一梳理它的常用參數,幫助你真正把這個方法用透、用好。
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 信息自動判斷,並作為回調參數傳遞。可用類型如下:
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 可取消本次 ajax 請求。XMLHttpRequest 對象是唯一參數。
function(XMLHttpRequest){ this; //調用本次ajax請求時傳遞的options參數 }complete:
complete:要求為 Function 類型,請求完成後調用的回調函數(成功或失敗均調用)。參數為 XMLHttpRequest 對象和一個描述成功請求類型的字符串。
function(XMLHttpRequest, textStatus){ this; //調用本次ajax請求時傳遞的options參數 }success:
success:要求為 Function 類型,請求成功後調用的回調函數,有兩個參數:(1) 由服務器返回並依 dataType 處理後的數據;(2) 描述狀態的字符串。
function(data, textStatus){ //data可能是xmlDoc、jsonObj、html、text等等 this; //調用本次ajax請求時傳遞的options參數 }error:
error:要求為 Function 類型,請求失敗時調用的函數,有 3 個參數:XMLHttpRequest 對象、錯誤信息、捕獲的錯誤對象(可選)。
function(XMLHttpRequest, textStatus, errorThrown){ //通常情況下textStatus和errorThrown只有其中一個包含信息 this; //調用本次ajax請求時傳遞的options參數 }contentType:
contentType:要求為 String 類型,發送信息至服務器時的內容編碼類型,默認為 "application/x-www-form-urlencoded",該默認值適合大多數場合。
dataFilter:要求為 Function 類型,用於給 Ajax 返回的原始數據進行預處理,提供 data 和 type 兩個參數。函數返回值將由 jQuery 進一步處理。
function(data, type){ //返回處理後的數據 return data; }global:
global:要求為 Boolean 類型,默認為 true,表示是否觸發全局 ajax 事件。設為 false 將不觸發全局事件,ajaxStart 或 ajaxStop 可用於控制各種 ajax 事件。
ifModified:要求為 Boolean 類型,默認為 false,僅在服務器數據改變時獲取新數據。判斷依據是 Last-Modified 頭信息,默認忽略該信息。
jsonp:要求為 String 類型,在一個 jsonp 請求中重寫回調函數的名字。該值用來替代 "callback=?" 這種請求中 URL 參數裡的 "callback" 部分,例如 {jsonp:'onJsonPLoad'} 會導致將 "onJsonPLoad=?" 傳給服務器。
username:要求為 String 類型,用於響應 HTTP 訪問認證請求的用戶名。
password:要求為 String 類型,用於響應 HTTP 訪問認證請求的密碼。
processData:要求為 Boolean 類型,默認為 true。默認情況下,發送的數據會被轉換為對象以配合默認內容類型 "application/x-www-form-urlencoded"。若要發送 DOM 樹信息或其他不希望轉換的信息,請設為 false。
scriptCharset:要求為 String 類型,只有當 dataType 為 "jsonp" 或 "script"、且 type 為 GET 時,才會用於強制修改字符集。通常在本地與遠程內容編碼不同時使用。
以上就是 $.ajax() 方法各參數的深入剖析。把這些參數吃透,你就能應對絕大多數異步請求場景了。