引用:https://www.jianshu.com/p/bb686b367800
最近ajax的使用十分頻繁,對其許多參數還不是很了解,特此總結。
-
通用寫法
1 $.ajax({ 2 url: "http://www.hzhuti.com", //請求的url地址
3 dataType: "json", //返回格式為json
4 async: true, //請求是否異步,默認為異步,這也是ajax重要特性
5 data: { "id": "value" }, //參數值
6 type: "GET", //請求方式
7 beforeSend: function(request) { 8 //請求前的處理
9 request.setRequestHeader("Content-type","application/json"); 10 request.setRequestHeader("Source","101"); 11 request.setRequestHeader("Token","aaw--wssw-ss..."); 12 }, 13 success: function(data) { 14 //請求成功時處理
15 }, 16 complete: function() { 17 //請求完成的處理
18 }, 19 error: function() { 20 //請求出錯處理
21 } 22 });
-
參數詳解
格式說明:
參數名;
參數類型;
參數說明,默認值,可選值;
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;
}
cache
Boolean
(默認: true) jQuery 1.2 新功能,設置為 false 將不會從瀏覽器緩存中加載請求信息。
complete
Function
請求完成后回調函數 (請求成功或失敗時均調用)。參數: XMLHttpRequest 對象,成功信息字符串。
function (XMLHttpRequest, textStatus) {
}
contentType
String
(默認: "application/x-www-form-urlencoded") 發送信息至服務器時內容編碼類型。默認值適合大多數應用場合。
data
Object,String
發送到服務器的數據。將自動轉換為請求字符串格式。GET 請求中將附加在 URL 后。
查看 processData 選項說明以禁止此自動轉換。必須為 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 格式。使用 JSONP 形式調用函數時,
如 "myurl?callback=?" jQuery 將自動替換 ? 為正確的函數名,以執行回調函數。
error
Function
(默認: 自動判斷 (xml 或 html)) 請求失敗時將調用此方法。
這個方法有三個參數:XMLHttpRequest 對象,錯誤信息,(可能)捕獲的錯誤對象。
function (XMLHttpRequest, textStatus, errorThrown) {
// 通常情況下textStatus和errorThown只有其中一個有值 this;
}
global
Boolean
(默認: true) 是否觸發全局 AJAX 事件。
設置為 false 將不會觸發全局 AJAX 事件,如 ajaxStart 或 ajaxStop 。
可用於控制不同的Ajax事件
ifModified
Boolean
(默認: false) 僅在服務器數據改變時獲取新數據。使用 HTTP 包 Last-Modified 頭信息判斷。
processData
Boolean
(默認: true) 默認情況下,發送的數據將被轉換為對象(技術上講並非字符串) 以配合默認內容類型 "application/x-www-form-urlencoded"。
如果要發送 DOM 樹信息或其它不希望轉換的信息,請設置為 false。
success
Function
請求成功后回調函數。這個方法有兩個參數:服務器返回數據,返回狀態function (data, textStatus) {
// data could be xmlDoc, jsonObj, html, text, etc...
}
