ajax 參數詳解
ajax請求參數解析
1、url [Object]
一個用來包含發送請求的URL字元串
2、accepts [Map]
默認:取決於數據類型
內容類型發送請求頭,告訴伺服器什麼樣的響應會被接收返回。如果accepts設置需要修改,推薦在$.ajaxSetup()方法中做一次
3、async [Boolean]
默認:true
默認設置下,所有請求均為非同步請求,如果需要發送同步請求,請將此選項設置為false。注意,如果需要發送同步請求。將此選項設置為false。注意,同步請求將鎖住瀏覽器,用戶其它操作必須等待請求完成後才可以執行
4、beforeSend(XHR) [Function]
發送請求前可修改 XMLHttpRequest 對象的函數,如添加自定義 HTTP 頭。XMLHttpRequest 對象是唯一的參數。這是一個 Ajax 事件。如果返回false可以取消本次ajax請求。
5、cache [Boolean]
(默認: true,dataType為script和jsonp時默認為false) jQuery 1.2 新功能,設置為 false 將不快取此頁面。
6、complete(XHR, TS) [Function]
請求完成後回調函數 (請求成功或失敗之後均調用)。參數: XMLHttpRequest 對象和一個描述成功請求類型的字元串
7、contents [Map]
一個以”{字元串:正則表達式}”配對的對象,用來確定jQuery將如何解析響應,給定其內容類型。
8、contentType [String]
(默認: “application/x-www-form-urlencoded”) 發送資訊至伺服器時內容編碼類型。默認值適合大多數情況。如果你明確地傳遞了一個content-type給 $.ajax() 那麼他必定會發送給伺服器(即使沒有數據要發送)
9、context [Object]
這個對象用於設置Ajax相關回調函數的上下文。也就是說,讓回調函數內this指向這個對象(如果不設定這個參數,那麼this就指向調用本次AJAX請求時傳遞的options參數)。比如指定一個DOM元素作為context參數,這樣就設置了success回調函數的上下文為這個DOM元素。
10、crossDomain [map]
默認: 同域請求為false
跨域請求為true如果你想強制跨域請求(如JSONP形式)同一域,設置crossDomain為true。這使得例如,伺服器端重定向到另一個域
11、data [Object,String]
發送到伺服器的數據。將自動轉換為請求字元串格式。GET 請求中將附加在 URL 後。查看 processData 選項說明以禁止此自動轉換。必須為 Key/Value 格式。如果為數組,jQuery 將自動為不同值對應同一個名稱。如 {foo:[“bar1”, “bar2”]} 轉換為 “&foo=bar1&foo=bar2″。
12、dataFilter [Function]
給Ajax返回的原始數據的進行預處理的函數。提供data和type兩個參數:data是Ajax返回的原始數據,type是調用jQuery.ajax時提供的dataType參數。函數返回的值將由jQuery進一步處理。
13、dataType [String]
預期伺服器返回的數據類型。如果不指定,jQuery 將自動根據 HTTP 包 MIME 資訊來智慧判斷,比如XML MIME類型就被識別為XML。在1.4中,JSON就會生成一個JavaScript對象,而script則會執行這個腳本。隨後伺服器端返回的數據會根據這個值解析後,傳遞給回調函數。可用值:
“xml”: 返回 XML 文檔,可用 jQuery 處理。
“html”: 返回純文本 HTML 資訊;包含的script標籤會在插入dom時執行。
“script”: 返回純文本 JavaScript 程式碼。不會自動快取結果。除非設置了”cache”參數。”’注意:”’在遠程請求時(不在同一個域下),所有POST請求都將轉為GET請求。(因為將使用DOM的script標籤來載入)
“json”: 返回 JSON 數據 。
“jsonp”: JSONP 格式。使用 JSONP形式調用函數時,如 “myurl?callback=?” jQuery 將自動替換 ? 為正確的函數名,以執行回調函數。
“text”: 返回純文本字元串
14、error [Function]
(默認: 自動判斷 (xml 或 html)) 請求失敗時調用此函數。有以下三個參數:XMLHttpRequest 對象、錯誤資訊、(可選)捕獲的異常對象。如果發生了錯誤,錯誤資訊(第二個參數)除了得到null之外,還可能是”timeout”, “error”, “notmodified” 和 “parsererror”。
15、headers [map]
Default: {}
一個額外的”{鍵:值}”對映射到請求一起發送。此設置被設置之前beforeSend函數被調用;因此,消息頭中的值設置可以在覆蓋beforeSend函數範圍內的任何設置。
16、jsonp [String]
在一個jsonp請求中重寫回調函數的名字。這個值用來替代在”callback=?”這種GET或POST請求中URL參數里的”callback”部分,比如{jsonp:’onJsonPLoad’}會導致將”onJsonPLoad=?”傳給伺服器。
17、jsonpCallback [String]
為jsonp請求指定一個回調函數名。這個值將用來取代jQuery自動生成的隨機函數名。這主要用來讓jQuery生成度獨特的函數名,這樣管理請求更容易,也能方便地提供回調函數和錯誤處理。你也可以在想讓瀏覽器快取GET請求的時候,指定這個回調函數名。
18、mimeType [String]
一個mime類型用來覆蓋XHR的 MIME類型。
19、password [String]
用於響應HTTP訪問認證請求的密碼
20、processData [Boolean]
(默認: true) 默認情況下,通過data選項傳遞進來的數據,如果是一個對象(技術上講只要不是字元串),都會處理轉化成一個查詢字元串,以配合默認內容類型 “application/x-www-form-urlencoded”。如果要發送 DOM 樹資訊或其它不希望轉換的資訊,請設置為 false。
21、scriptCharset [String]
只有當請求時dataType為”jsonp”或”script”,並且type是”GET”才會用於強制修改charset。通常只在本地和遠程的內容編碼不同時使用。
22、statusCode [map]
默認: {}
一組數值的HTTP程式碼和函數對象,當響應時調用了相應的程式碼。例如,如果響應狀態是404,將觸發以下警報:
$.ajax({
statusCode: {404: function() {
alert('page not found');
}
});
23、success(data, textStatus, jqXHR) [Function,Array]
請求成功後的回調函數。參數:由伺服器返回,並根據dataType參數進行處理後的數據;描述狀態的字元串。還有 jqXHR(在jQuery 1.4.x的中,XMLHttpRequest) 對象 。在jQuery 1.5, 成功設置可以接受一個函數數組。每個函數將被依次調用。
24、traditional [Boolean]
如果你想要用傳統的方式來序列化數據,那麼就設置為true。請參考工具分類下面的jQuery.param 方法。
25、timeout [Number]
設置請求超時時間(毫秒)。此設置將覆蓋全局設置。
26、type [String]
(默認: “GET”) 請求方式 (“POST” 或 “GET”), 默認為 “GET”。注意:其它 HTTP 請求方法,如 PUT 和 DELETE 也可以使用,但僅部分瀏覽器支援。
27、username [String]
用於響應HTTP訪問認證請求的用戶名
案例
描述:
載入並執行一個 JS 文件。
jQuery 程式碼:
$.ajax({
type: "GET",
url: "test.js",
dataType: "script"
});
描述:
保存數據到伺服器,成功時顯示資訊。
jQuery 程式碼:
$.ajax({
type: "POST",
url: "some.php",
data: "name=John&location=Boston",
success: function(msg){
alert( "Data Saved: " + msg );
}
});
描述:
裝入一個 HTML 網頁最新版本。
jQuery 程式碼:
$.ajax({
url: "test.html",
cache: false,
success: function(html){
$("#results").append(html);
}
});
描述:
同步載入數據。發送請求時鎖住瀏覽器。需要鎖定用戶交互操作時使用同步方式。
jQuery 程式碼:
var html = $.ajax({
url: "some.php",
async: false
}).responseText;
描述:
發送 XML 數據至伺服器。設置 processData 選項為 false,防止自動轉換數據格式。
jQuery 程式碼:
var xmlDocument = [create xml document];
$.ajax({
url: "page.php",
processData: false,
data: xmlDocument,
success: handleResponse
});