回調函數
如果要處理$.Ajax()得到的數據,則需要使用回調函數。beforeSend、error、dataFilter、success、complete。
beforeSend 在發送請求之前調用,并且傳入一個xmlHttPRequest作為參數。error 在請求出錯時調用。傳入xmlhttpRequest對象,描述錯誤類型的字符串以及一個異常對象(如果有的話)dataFilter 在請求成功之后調用。傳入返回的數據以及"dataType"參數的值。并且必須返回新的數據(可能是處理過的)傳遞給success回調函數。success 當請求之后調用。傳入返回后的數據,以及包含成功代碼的字符串。complete 當請求完成之后調用這個函數,無論成功或失敗。傳入XMLHttpRequest對象,以及一個包含成功或錯誤代碼的字符串默認: 取決于數據類型。
內容類型發送請求頭,告訴服務器什么樣的響應會接受返回。如果accepts設置需要修改,推薦在$.ajaxSetup()方法中做一次。
(默認: true) 默認設置下,所有請求均為異步請求。如果需要發送同步請求,請將此選項設置為 false。注意,同步請求將鎖住瀏覽器,用戶其它操作必須等待請求完成才可以執行。
發送請求前可修改 XMLHttpRequest 對象的函數,如添加自定義 HTTP 頭。XMLHttpRequest 對象是唯一的參數。這是一個 Ajax 事件。如果返回false可以取消本次ajax請求。
function (XMLHttpRequest) { this; // 調用本次AJAX請求時傳遞的options參數}cacheBoolean
(默認: true,dataType為script和jsonp時默認為false) jQuery 1.2 新功能,設置為 false 將不緩存此頁面。
complete(XHR, TS)Function
請求完成后回調函數 (請求成功或失敗之后均調用)。參數: XMLHttpRequest 對象和一個描述成功請求類型的字符串。 Ajax 事件。
function (XMLHttpRequest, textStatus) { this; // 調用本次AJAX請求時傳遞的options參數}contentsMapV1.5
一個以"{字符串:正則表達式}"配對的對象,用來確定jQuery將如何解析響應,給定其內容類型。
contentTypeString
(默認: "application/x-www-form-urlencoded") 發送信息至服務器時內容編碼類型。默認值適合大多數情況。如果你明確地傳遞了一個content-type給 $.ajax() 那么他必定會發送給服務器(即使沒有數據要發送)
contextObject
這個對象用于設置Ajax相關回調函數的上下文。也就是說,讓回調函數內this指向這個對象(如果不設定這個參數,那么this就指向調用本次AJAX請求時傳遞的options參數)。比如指定一個DOM元素作為context參數,這樣就設置了success回調函數的上下文為這個DOM元素。就像這樣:
$.ajax({ url: "test.html", context: document.body, success: function(){ $(this).addClass("done");}});convertersmapV1.5
默認: {"* text": window.String, "text html": true, "text json": jQuery.parseJSON, "text xml": jQuery.parseXML}
一個數據類型對數據類型轉換器的對象。每個轉換器的值是一個函數,返回響應的轉化值
crossDomainmapV1.5
默認: 同域請求為false
跨域請求為true如果你想強制跨域請求(如JSONP形式)同一域,設置crossDomain為true。這使得例如,服務器端重定向到另一個域
dataObject,String
發送到服務器的數據。將自動轉換為請求字符串格式。GET 請求中將附加在 URL 后。查看 processData 選項說明以禁止此自動轉換。必須為 Key/Value 格式。如果為數組,jQuery 將自動為不同值對應同一個名稱。如 {foo:["bar1", "bar2"]} 轉換為 "&foo=bar1&foo=bar2"。
dataFilterFunction
給Ajax返回的原始數據的進行預處理的函數。提供data和type兩個參數:data是Ajax返回的原始數據,type是調用jQuery.ajax時提供的dataType參數。函數返回的值將由jQuery進一步處理。
function (data, type) { // 對Ajax返回的原始數據進行預處理 return data // 返回處理后的數據}dataTypeString
預期服務器返回的數據類型。如果不指定,jQuery 將自動根據 HTTP 包 MIME 信息來智能判斷,比如XML MIME類型就被識別為XML。在1.4中,JSON就會生成一個javaScript對象,而script則會執行這個腳本。隨后服務器端返回的數據會根據這個值解析后,傳遞給回調函數??捎?#20540;:
"xml": 返回 XML 文檔,可用 jQuery 處理。
"html": 返回純文本 HTML 信息;包含的script標簽會在插入dom時執行。
"script": 返回純文本 Javascript 代碼。不會自動緩存結果。除非設置了"cache"參數。'''注意:'''在遠程請求時(不在同一個域下),所有POST請求都將轉為GET請求。(因為將使用DOM的script標簽來加載)
"json": 返回 JSON 數據 。
"jsonp": JSONP 格式。使用 JSONP 形式調用函數時,如 "myurl?callback=?" jQuery 將自動替換 ? 為正確的函數名,以執行回調函數。
"text": 返回純文本字符串
errorFunction
(默認: 自動判斷 (xml 或 html)) 請求失敗時調用此函數。有以下三個參數:XMLHttpRequest 對象、錯誤信息、(可選)捕獲的異常對象。如果發生了錯誤,錯誤信息(第二個參數)除了得到null之外,還可能是"timeout", "error", "notmodified" 和 "parsererror"。Ajax 事件。
function (XMLHttpRequest, textStatus, errorThrown) { // 通常 textStatus 和 errorThrown 之中 // 只有一個會包含信息 this; // 調用本次AJAX請求時傳遞的options參數}globalBoolean
(默認: true) 是否觸發全局 AJAX 事件。設置為 false 將不會觸發全局 AJAX 事件,如 ajaxStart 或 ajaxStop 可用于控制不同的Ajax 事件。
headersmapV1.5
Default: {}
一個額外的"{鍵:值}"對映射到請求一起發送。此設置被設置之前beforeSend函數被調用;因此,消息頭中的值設置可以在覆蓋beforeSend函數范圍內的任何設置。
ifModifiedBoolean
(默認: false) 僅在服務器數據改變時獲取新數據。使用 HTTP 包 Last-Modified 頭信息判斷。在jQuery 1.4中,他也會檢查服務器指定的'etag'來確定數據沒有被修改過。
isLocalmapV1.5.1
默認: 取決于當前的位置協議
允許當前環境被認定為“本地”,(如文件系統),即使jQuery默認情況下不會承認它。以下協議目前公認為本地:file, *-extension, and widget。如果isLocal設置需要修改,建議在$.ajaxSetup()方法中這樣做一次。
jsonpString
在一個jsonp請求中重寫回調函數的名字。這個值用來替代在"callback=?"這種GET或POST請求中URL參數里的"callback"部分,比如{jsonp:'onJsonPLoad'}會導致將"onJsonPLoad=?"傳給服務器。
jsonpCallbackString
為jsonp請求指定一個回調函數名。這個值將用來取代jQuery自動生成的隨機函數名。這主要用來讓jQuery生成度獨特的函數名,這樣管理請求更容易,也能方便地提供回調函數和錯誤處理。你也可以在想讓瀏覽器緩存GET請求的時候,指定這個回調函數名。
mimeTypeStringV1.5.1
一個mime類型用來覆蓋XHR的 MIME類型。
passWordString
用于響應HTTP訪問認證請求的密碼
processDataBoolean
(默認: true) 默認情況下,通過data選項傳遞進來的數據,如果是一個對象(技術上講只要不是字符串),都會處理轉化成一個查詢字符串,以配合默認內容類型 "application/x-www-form-urlencoded"。如果要發送 DOM 樹信息或其它不希望轉換的信息,請設置為 false。
scriptCharsetString
只有當請求時dataType為"jsonp"或"script",并且type是"GET"才會用于強制修改charset。通常只在本地和遠程的內容編碼不同時使用。
statusCodemapV1.5
默認: {}
一組數值的HTTP代碼和函數對象,當響應時調用了相應的代碼。例如,如果響應狀態是404,將觸發以下警報:
$.ajax({ statusCode: {404: function() { alert('page not found'); }});success(data, textStatus, jqXHR)Function,Array
請求成功后的回調函數。參數:由服務器返回,并根據dataType參數進行處理后的數據;描述狀態的字符串。還有 jqXHR(在jQuery 1.4.x的中,XMLHttpRequest) 對象 。在jQuery 1.5, 成功設置可以接受一個函數數組。每個函數將被依次調用。Ajax 事件。
function (data, textStatus) { // data 可能是 xmlDoc, jsonObj, html, text, 等等... this; // 調用本次AJAX請求時傳遞的options參數}traditionalBoolean
如果你想要用傳統的方式來序列化數據,那么就設置為true。請參考工具分類下面的jQuery.param 方法。
timeoutNumber
設置請求超時時間(毫秒)。此設置將覆蓋全局設置。
typeString
(默認: "GET") 請求方式 ("POST" 或 "GET"), 默認為 "GET"。注意:其它 HTTP 請求方法,如 PUT 和 DELETE 也可以使用,但僅部分瀏覽器支持。
urlString
(默認: 當前頁地址) 發送請求的地址。
usernameString
用于響應HTTP訪問認證請求的用戶名
xhrFunction
需要返回一個XMLHttpRequest 對象。默認在IE下是ActiveXObject 而其他情況下是XMLHttpRequest 。用于重寫或者提供一個增強的XMLHttpRequest 對象。這個參數在jQuery 1.3以前不可用。
xhrFieldsmapV1.5
一對“文件名-文件值”在本機設置XHR對象。例如,如果需要的話,你可以用它來設置withCredentials為true的跨域請求。
示例
描述:
加載并執行一個 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 });
新聞熱點
疑難解答