首頁  >  ajax  > $.ajax(url,[settings])

返回值:XMLHttpRequestjQuery.ajax(url,[settings])

jQuery $.ajax() 方法概述

通過 HTTP 請求加載遠(yuǎn)程數(shù)據(jù)。

jQuery 底層 AJAX 實(shí)現(xiàn)。簡單易用的高層實(shí)現(xiàn)見 $.get, $.post 等。$.ajax() 返回其創(chuàng)建的 XMLHttpRequest 對象。大多數(shù)情況下你無需直接操作該函數(shù),除非你需要操作不常用的選項(xiàng),以獲得更多的靈活性。

最簡單的情況下,$.ajax()可以不帶任何參數(shù)直接使用。

注意,所有的選項(xiàng)都可以通過$.ajaxSetup()函數(shù)來全局設(shè)置。

回調(diào)函數(shù)

如果要處理$.ajax()得到的數(shù)據(jù),則需要使用回調(diào)函數(shù)。beforeSend、error、dataFilter、success、complete。

  • beforeSend 在發(fā)送請求之前調(diào)用,并且傳入一個XMLHttpRequest作為參數(shù)。
  • error 在請求出錯時調(diào)用。傳入XMLHttpRequest對象,描述錯誤類型的字符串以及一個異常對象(如果有的話)
  • dataFilter 在請求成功之后調(diào)用。傳入返回的數(shù)據(jù)以及"dataType"參數(shù)的值。并且必須返回新的數(shù)據(jù)(可能是處理過的)傳遞給success回調(diào)函數(shù)。
  • success 當(dāng)請求之后調(diào)用。傳入返回后的數(shù)據(jù),以及包含成功代碼的字符串。
  • complete 當(dāng)請求完成之后調(diào)用這個函數(shù),無論成功或失敗。傳入XMLHttpRequest對象,以及一個包含成功或錯誤代碼的字符串。

數(shù)據(jù)類型

$.ajax()函數(shù)依賴服務(wù)器提供的信息來處理返回的數(shù)據(jù)。如果服務(wù)器報告說返回的數(shù)據(jù)是XML,那么返回的結(jié)果就可以用普通的XML方法或者jQuery的選擇器來遍歷。如果見得到其他類型,比如HTML,則數(shù)據(jù)就以文本形式來對待。

通過dataType選項(xiàng)還可以指定其他不同數(shù)據(jù)處理方式。除了單純的XML,還可以指定 html、json、jsonp、script或者text。

其中,text和xml類型返回的數(shù)據(jù)不會經(jīng)過處理。數(shù)據(jù)僅僅簡單的將XMLHttpRequest的responseText或responseHTML屬性傳遞給success回調(diào)函數(shù),

'''注意''',我們必須確保網(wǎng)頁服務(wù)器報告的MIME類型與我們選擇的dataType所匹配。比如說,XML的話,服務(wù)器端就必須聲明 text/xml 或者 application/xml 來獲得一致的結(jié)果。

如果指定為html類型,任何內(nèi)嵌的JavaScript都會在HTML作為一個字符串返回之前執(zhí)行。類似的,指定script類型的話,也會先執(zhí)行服務(wù)器端生成JavaScript,然后再把腳本作為一個文本數(shù)據(jù)返回。

如果指定為json類型,則會把獲取到的數(shù)據(jù)作為一個JavaScript對象來解析,并且把構(gòu)建好的對象作為結(jié)果返回。為了實(shí)現(xiàn)這個目的,他首先嘗試使用JSON.parse()。如果瀏覽器不支持,則使用一個函數(shù)來構(gòu)建。JSON數(shù)據(jù)是一種能很方便通過JavaScript解析的結(jié)構(gòu)化數(shù)據(jù)。如果獲取的數(shù)據(jù)文件存放在遠(yuǎn)程服務(wù)器上(域名不同,也就是跨域獲取數(shù)據(jù)),則需要使用jsonp類型。使用這種類型的話,會創(chuàng)建一個查詢字符串參數(shù) callback=? ,這個參數(shù)會加在請求的URL后面。服務(wù)器端應(yīng)當(dāng)在JSON數(shù)據(jù)前加上回調(diào)函數(shù)名,以便完成一個有效的JSONP請求。如果要指定回調(diào)函數(shù)的參數(shù)名來取代默認(rèn)的callback,可以通過設(shè)置$.ajax()的jsonp參數(shù)。

注意,JSONP是JSON格式的擴(kuò)展。他要求一些服務(wù)器端的代碼來檢測并處理查詢字符串參數(shù)。更多信息可以參閱 最初的文章

如果指定了script或者jsonp類型,那么當(dāng)從服務(wù)器接收到數(shù)據(jù)時,實(shí)際上是用了<script>標(biāo)簽而不是XMLHttpRequest對象。這種情況下,$.ajax()不再返回一個XMLHttpRequest對象,并且也不會傳遞事件處理函數(shù),比如beforeSend。

發(fā)送數(shù)據(jù)到服務(wù)器

默認(rèn)情況下,Ajax請求使用GET方法。如果要使用POST方法,可以設(shè)定type參數(shù)值。這個選項(xiàng)也會影響data選項(xiàng)中的內(nèi)容如何發(fā)送到服務(wù)器。

data選項(xiàng)既可以包含一個查詢字符串,比如 key1=value1&key2=value2 ,也可以是一個映射,比如 {key1: 'value1', key2: 'value2'} 。如果使用了后者的形式,則數(shù)據(jù)再發(fā)送器會被轉(zhuǎn)換成查詢字符串。這個處理過程也可以通過設(shè)置processData選項(xiàng)為false來回避。如果我們希望發(fā)送一個XML對象給服務(wù)器時,這種處理可能并不合適。并且在這種情況下,我們也應(yīng)當(dāng)改變contentType選項(xiàng)的值,用其他合適的MIME類型來取代默認(rèn)的 application/x-www-form-urlencoded 。

高級選項(xiàng)

global選項(xiàng)用于阻止響應(yīng)注冊的回調(diào)函數(shù),比如.ajaxSend,或者ajaxError,以及類似的方法。這在有些時候很有用,比如發(fā)送的請求非常頻繁且簡短的時候,就可以在ajaxSend里禁用這個。更多關(guān)于這些方法的詳細(xì)信息,請參閱下面的內(nèi)容。

如果服務(wù)器需要HTTP認(rèn)證,可以使用用戶名和密碼可以通過username和password選項(xiàng)來設(shè)置。

Ajax請求是限時的,所以錯誤警告被捕獲并處理后,可以用來提升用戶體驗(yàn)。請求超時這個參數(shù)通常就保留其默認(rèn)值,要不就通過jQuery.ajaxSetup來全局設(shè)定,很少為特定的請求重新設(shè)置timeout選項(xiàng)。

默認(rèn)情況下,請求總會被發(fā)出去,但瀏覽器有可能從他的緩存中調(diào)取數(shù)據(jù)。要禁止使用緩存的結(jié)果,可以設(shè)置cache參數(shù)為false。如果希望判斷數(shù)據(jù)自從上次請求后沒有更改過就報告出錯的話,可以設(shè)置ifModified為true。

scriptCharset允許給<script>標(biāo)簽的請求設(shè)定一個特定的字符集,用于script或者jsonp類似的數(shù)據(jù)。當(dāng)腳本和頁面字符集不同時,這特別好用。

Ajax的第一個字母是asynchronous的開頭字母,這意味著所有的操作都是并行的,完成的順序沒有前后關(guān)系。$.ajax()的async參數(shù)總是設(shè)置成true,這標(biāo)志著在請求開始后,其他代碼依然能夠執(zhí)行。強(qiáng)烈不建議把這個選項(xiàng)設(shè)置成false,這意味著所有的請求都不再是異步的了,這也會導(dǎo)致瀏覽器被鎖死。

$.ajax函數(shù)返回他創(chuàng)建的XMLHttpRequest對象。通常jQuery只在內(nèi)部處理并創(chuàng)建這個對象,但用戶也可以通過xhr選項(xiàng)來傳遞一個自己創(chuàng)建的xhr對象。返回的對象通常已經(jīng)被丟棄了,但依然提供一個底層接口來觀察和操控請求。比如說,調(diào)用對象上的.abort()可以在請求完成前掛起請求。

參數(shù)

url,[settings]ObjectV1.5

url:一個用來包含發(fā)送請求的URL字符串。

settings:AJAX 請求設(shè)置。所有選項(xiàng)都是可選的。

V1.0settings:選項(xiàng)

acceptsMap

默認(rèn): 取決于數(shù)據(jù)類型。

內(nèi)容類型發(fā)送請求頭,告訴服務(wù)器什么樣的響應(yīng)會接受返回。如果accepts設(shè)置需要修改,推薦在$.ajaxSetup()方法中做一次。

asyncBoolean

(默認(rèn): true) 默認(rèn)設(shè)置下,所有請求均為異步請求。如果需要發(fā)送同步請求,請將此選項(xiàng)設(shè)置為 false。注意,同步請求將鎖住瀏覽器,用戶其它操作必須等待請求完成才可以執(zhí)行。

beforeSend(XHR)Function

發(fā)送請求前可修改 XMLHttpRequest 對象的函數(shù),如添加自定義 HTTP 頭。XMLHttpRequest 對象是唯一的參數(shù)。這是一個 Ajax 事件。如果返回false可以取消本次ajax請求。

function (XMLHttpRequest) {
    this; // 調(diào)用本次AJAX請求時傳遞的options參數(shù)
}

cacheBoolean

(默認(rèn): true,dataType為script和jsonp時默認(rèn)為false) jQuery 1.2 新功能,設(shè)置為 false 將不緩存此頁面。

complete(XHR, TS)Function

請求完成后回調(diào)函數(shù) (請求成功或失敗之后均調(diào)用)。參數(shù): XMLHttpRequest 對象和一個描述成功請求類型的字符串。 Ajax 事件

function (XMLHttpRequest, textStatus) {
    this; // 調(diào)用本次AJAX請求時傳遞的options參數(shù)
}

contentsMapV1.5

一個以"{字符串:正則表達(dá)式}"配對的對象,用來確定jQuery將如何解析響應(yīng),給定其內(nèi)容類型。

contentTypeString

(默認(rèn): "application/x-www-form-urlencoded") 發(fā)送信息至服務(wù)器時內(nèi)容編碼類型。默認(rèn)值適合大多數(shù)情況。如果你明確地傳遞了一個content-type給 $.ajax() 那么他必定會發(fā)送給服務(wù)器(即使沒有數(shù)據(jù)要發(fā)送)

contextObject

這個對象用于設(shè)置Ajax相關(guān)回調(diào)函數(shù)的上下文。也就是說,讓回調(diào)函數(shù)內(nèi)this指向這個對象(如果不設(shè)定這個參數(shù),那么this就指向調(diào)用本次AJAX請求時傳遞的options參數(shù))。比如指定一個DOM元素作為context參數(shù),這樣就設(shè)置了success回調(diào)函數(shù)的上下文為這個DOM元素。就像這樣:

$.ajax({ url: "test.html", context: document.body, success: function(){
    $(this).addClass("done");
}});

convertersmapV1.5

默認(rèn): {"* text": window.String, "text html": true, "text json": jQuery.parseJSON, "text xml": jQuery.parseXML}

一個數(shù)據(jù)類型對數(shù)據(jù)類型轉(zhuǎn)換器的對象。每個轉(zhuǎn)換器的值是一個函數(shù),返回響應(yīng)的轉(zhuǎn)化值

crossDomainmapV1.5

默認(rèn): 同域請求為false

跨域請求為true如果你想強(qiáng)制跨域請求(如JSONP形式)同一域,設(shè)置crossDomain為true。這使得例如,服務(wù)器端重定向到另一個域

dataObject,String

發(fā)送到服務(wù)器的數(shù)據(jù)。將自動轉(zhuǎn)換為請求字符串格式。GET 請求中將附加在 URL 后。查看 processData 選項(xiàng)說明以禁止此自動轉(zhuǎn)換。必須為 Key/Value 格式。如果為數(shù)組,jQuery 將自動為不同值對應(yīng)同一個名稱。如 {foo:["bar1", "bar2"]} 轉(zhuǎn)換為 "&foo=bar1&foo=bar2"。

dataFilterFunction

給Ajax返回的原始數(shù)據(jù)的進(jìn)行預(yù)處理的函數(shù)。提供data和type兩個參數(shù):data是Ajax返回的原始數(shù)據(jù),type是調(diào)用jQuery.ajax時提供的dataType參數(shù)。函數(shù)返回的值將由jQuery進(jìn)一步處理。

function (data, type) {
    // 對Ajax返回的原始數(shù)據(jù)進(jìn)行預(yù)處理
    return data  // 返回處理后的數(shù)據(jù)
}

dataTypeString

預(yù)期服務(wù)器返回的數(shù)據(jù)類型。如果不指定,jQuery 將自動根據(jù) HTTP 包 MIME 信息來智能判斷,比如XML MIME類型就被識別為XML。在1.4中,JSON就會生成一個JavaScript對象,而script則會執(zhí)行這個腳本。隨后服務(wù)器端返回的數(shù)據(jù)會根據(jù)這個值解析后,傳遞給回調(diào)函數(shù)。可用值:

"xml": 返回 XML 文檔,可用 jQuery 處理。

"html": 返回純文本 HTML 信息;包含的script標(biāo)簽會在插入dom時執(zhí)行。

"script": 返回純文本 JavaScript 代碼。不會自動緩存結(jié)果。除非設(shè)置了"cache"參數(shù)。'''注意:'''在遠(yuǎn)程請求時(不在同一個域下),所有POST請求都將轉(zhuǎn)為GET請求。(因?yàn)閷⑹褂肈OM的script標(biāo)簽來加載)

"json": 返回 JSON 數(shù)據(jù) 。

"jsonp": JSONP 格式。使用 JSONP 形式調(diào)用函數(shù)時,如 "myurl?callback=?" jQuery 將自動替換 ? 為正確的函數(shù)名,以執(zhí)行回調(diào)函數(shù)。

"text": 返回純文本字符串

errorFunction

(默認(rèn): 自動判斷 (xml 或 html)) 請求失敗時調(diào)用此函數(shù)。有以下三個參數(shù):XMLHttpRequest 對象、錯誤信息、(可選)捕獲的異常對象。如果發(fā)生了錯誤,錯誤信息(第二個參數(shù))除了得到null之外,還可能是"timeout", "error", "notmodified" 和 "parsererror"。Ajax 事件。

function (XMLHttpRequest, textStatus, errorThrown) {
    // 通常 textStatus 和 errorThrown 之中
    // 只有一個會包含信息
    this; // 調(diào)用本次AJAX請求時傳遞的options參數(shù)
}

globalBoolean

(默認(rèn): true) 是否觸發(fā)全局 AJAX 事件。設(shè)置為 false 將不會觸發(fā)全局 AJAX 事件,如 ajaxStart 或 ajaxStop 可用于控制不同的 Ajax 事件。

headersmapV1.5

Default: {}

一個額外的"{鍵:值}"對映射到請求一起發(fā)送。此設(shè)置被設(shè)置之前beforeSend函數(shù)被調(diào)用;因此,消息頭中的值設(shè)置可以在覆蓋beforeSend函數(shù)范圍內(nèi)的任何設(shè)置。

ifModifiedBoolean

(默認(rèn): false) 僅在服務(wù)器數(shù)據(jù)改變時獲取新數(shù)據(jù)。使用 HTTP 包 Last-Modified 頭信息判斷。在jQuery 1.4中,他也會檢查服務(wù)器指定的'etag'來確定數(shù)據(jù)沒有被修改過。

isLocalmapV1.5.1

默認(rèn): 取決于當(dāng)前的位置協(xié)議

允許當(dāng)前環(huán)境被認(rèn)定為“本地”,(如文件系統(tǒng)),即使jQuery默認(rèn)情況下不會承認(rèn)它。以下協(xié)議目前公認(rèn)為本地:file, *-extension, and widget。如果isLocal設(shè)置需要修改,建議在$.ajaxSetup()方法中這樣做一次。

jsonpString

在一個jsonp請求中重寫回調(diào)函數(shù)的名字。這個值用來替代在"callback=?"這種GET或POST請求中URL參數(shù)里的"callback"部分,比如{jsonp:'onJsonPLoad'}會導(dǎo)致將"onJsonPLoad=?"傳給服務(wù)器。

jsonpCallbackString

為jsonp請求指定一個回調(diào)函數(shù)名。這個值將用來取代jQuery自動生成的隨機(jī)函數(shù)名。這主要用來讓jQuery生成度獨(dú)特的函數(shù)名,這樣管理請求更容易,也能方便地提供回調(diào)函數(shù)和錯誤處理。你也可以在想讓瀏覽器緩存GET請求的時候,指定這個回調(diào)函數(shù)名。

mimeTypeStringV1.5.1

一個mime類型用來覆蓋XHR的 MIME類型。

passwordString

用于響應(yīng)HTTP訪問認(rèn)證請求的密碼

processDataBoolean

(默認(rèn): true) 默認(rèn)情況下,通過data選項(xiàng)傳遞進(jìn)來的數(shù)據(jù),如果是一個對象(技術(shù)上講只要不是字符串),都會處理轉(zhuǎn)化成一個查詢字符串,以配合默認(rèn)內(nèi)容類型 "application/x-www-form-urlencoded"。如果要發(fā)送 DOM 樹信息或其它不希望轉(zhuǎn)換的信息,請設(shè)置為 false。

scriptCharsetString

只有當(dāng)請求時dataType為"jsonp"或"script",并且type是"GET"才會用于強(qiáng)制修改charset。通常只在本地和遠(yuǎn)程的內(nèi)容編碼不同時使用。

statusCodemapV1.5

默認(rèn): {}

一組數(shù)值的HTTP代碼和函數(shù)對象,當(dāng)響應(yīng)時調(diào)用了相應(yīng)的代碼。例如,如果響應(yīng)狀態(tài)是404,將觸發(fā)以下警報:

$.ajax({
  statusCode: {404: function() {
    alert('page not found');
  }
});

success(data, textStatus, jqXHR)Function,Array

請求成功后的回調(diào)函數(shù)。參數(shù):由服務(wù)器返回,并根據(jù)dataType參數(shù)進(jìn)行處理后的數(shù)據(jù);描述狀態(tài)的字符串。還有 jqXHR(在jQuery 1.4.x的中,XMLHttpRequest) 對象 。在jQuery 1.5, 成功設(shè)置可以接受一個函數(shù)數(shù)組。每個函數(shù)將被依次調(diào)用。 Ajax 事件。

function (data, textStatus) {
    // data 可能是 xmlDoc, jsonObj, html, text, 等等...
    this; // 調(diào)用本次AJAX請求時傳遞的options參數(shù)
}

traditionalBoolean

如果你想要用傳統(tǒng)的方式來序列化數(shù)據(jù),那么就設(shè)置為true。請參考工具分類下面的jQuery.param 方法。

timeoutNumber

設(shè)置請求超時時間(毫秒)。此設(shè)置將覆蓋全局設(shè)置。

typeString

(默認(rèn): "GET") 請求方式 ("POST" 或 "GET"), 默認(rèn)為 "GET"。注意:其它 HTTP 請求方法,如 PUT 和 DELETE 也可以使用,但僅部分瀏覽器支持。

urlString

(默認(rèn): 當(dāng)前頁地址) 發(fā)送請求的地址。

usernameString

用于響應(yīng)HTTP訪問認(rèn)證請求的用戶名

xhrFunction

需要返回一個XMLHttpRequest 對象。默認(rèn)在IE下是ActiveXObject 而其他情況下是XMLHttpRequest 。用于重寫或者提供一個增強(qiáng)的XMLHttpRequest 對象。這個參數(shù)在jQuery 1.3以前不可用。

xhrFieldsmapV1.5

一對“文件名-文件值”在本機(jī)設(shè)置XHR對象。例如,如果需要的話,你可以用它來設(shè)置withCredentials為true的跨域請求。

示例

描述:

加載并執(zhí)行一個 JS 文件。

jQuery 代碼:
$.ajax({
  type: "GET",
  url: "test.js",
  dataType: "script"
});

描述:

保存數(shù)據(jù)到服務(wù)器,成功時顯示信息。

jQuery 代碼:
$.ajax({
   type: "POST",
   url: "some.php",
   data: "name=John&location=Boston",
   success: function(msg){
     alert( "Data Saved: " + msg );
   }
});

描述:

裝入一個 HTML 網(wǎng)頁最新版本。

jQuery 代碼:
$.ajax({
  url: "test.html",
  cache: false,
  success: function(html){
    $("#results").append(html);
  }
});

描述:

同步加載數(shù)據(jù)。發(fā)送請求時鎖住瀏覽器。需要鎖定用戶交互操作時使用同步方式。

jQuery 代碼:
 var html = $.ajax({
  url: "some.php",
  async: false
 }).responseText;

描述:

發(fā)送 XML 數(shù)據(jù)至服務(wù)器。設(shè)置 processData 選項(xiàng)為 false,防止自動轉(zhuǎn)換數(shù)據(jù)格式。

jQuery 代碼:
 var xmlDocument = [create xml document];
 $.ajax({
   url: "page.php",
   processData: false,
   data: xmlDocument,
   success: handleResponse
 });