jQuery Ajax 參考手冊(cè)

實(shí)例

通過(guò) AJAX 加載一段文本：

jQuery 代碼：

$(document).ready(function(){  $("#b01").click(function(){  htmlobj=$.ajax({url:"/jquery/test1.txt",async:false});  $("#myDiv").html(htmlobj.responseText);  });});

HTML 代碼：

<div id="myDiv"><h2>Let AJAX change this text</h2></div><button id="b01" type="button">Change Content</button>

親自試一試

定義和用法

ajax() 方法通過(guò) HTTP 請(qǐng)求加載遠(yuǎn)程數(shù)據(jù)。

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

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

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

語(yǔ)法

jQuery.ajax([settings])

參數(shù)

options

類型：Object

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

async

類型：Boolean

默認(rèn)值: true。默認(rèn)設(shè)置下，所有請(qǐng)求均為異步請(qǐng)求。如果需要發(fā)送同步請(qǐng)求，請(qǐng)將此選項(xiàng)設(shè)置為 false。

注意，同步請(qǐng)求將鎖住瀏覽器，用戶其它操作必須等待請(qǐng)求完成才可以執(zhí)行。

beforeSend(XHR)

類型：Function

發(fā)送請(qǐng)求前可修改 XMLHttpRequest 對(duì)象的函數(shù)，如添加自定義 HTTP 頭。

XMLHttpRequest 對(duì)象是唯一的參數(shù)。

這是一個(gè) Ajax 事件。如果返回 false 可以取消本次 ajax 請(qǐng)求。

cache

類型：Boolean

默認(rèn)值: true，dataType 為 script 和 jsonp 時(shí)默認(rèn)為 false。設(shè)置為 false 將不緩存此頁(yè)面。

jQuery 1.2 新功能。

complete(XHR, TS)

類型：Function

請(qǐng)求完成后回調(diào)函數(shù) (請(qǐng)求成功或失敗之后均調(diào)用)。

參數(shù)： XMLHttpRequest 對(duì)象和一個(gè)描述請(qǐng)求類型的字符串。

這是一個(gè) Ajax 事件。

contentType

類型：String

默認(rèn)值: "application/x-www-form-urlencoded"。發(fā)送信息至服務(wù)器時(shí)內(nèi)容編碼類型。

默認(rèn)值適合大多數(shù)情況。如果你明確地傳遞了一個(gè) content-type 給 $.ajax() 那么它必定會(huì)發(fā)送給服務(wù)器（即使沒(méi)有數(shù)據(jù)要發(fā)送）。

context

類型：Object

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

就像這樣：

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

data

類型：String

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

dataFilter

類型：Function

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

dataType

類型：String

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

• "xml": 返回 XML 文檔，可用 jQuery 處理。
• "html": 返回純文本 HTML 信息；包含的 script 標(biāo)簽會(huì)在插入 dom 時(shí)執(zhí)行。
• "script": 返回純文本 JavaScript 代碼。不會(huì)自動(dòng)緩存結(jié)果。除非設(shè)置了 "cache" 參數(shù)。注意：在遠(yuǎn)程請(qǐng)求時(shí)(不在同一個(gè)域下)，所有 POST 請(qǐng)求都將轉(zhuǎn)為 GET 請(qǐng)求。（因?yàn)閷⑹褂?DOM 的 script標(biāo)簽來(lái)加載）
• "json": 返回 JSON 數(shù)據(jù) 。
• "jsonp": JSONP 格式。使用 JSONP 形式調(diào)用函數(shù)時(shí)，如 "myurl?callback=?" jQuery 將自動(dòng)替換 ? 為正確的函數(shù)名，以執(zhí)行回調(diào)函數(shù)。
• "text": 返回純文本字符串

error

類型：Function

默認(rèn)值: 自動(dòng)判斷 (xml 或 html)。請(qǐng)求失敗時(shí)調(diào)用此函數(shù)。

有以下三個(gè)參數(shù)：XMLHttpRequest 對(duì)象、錯(cuò)誤信息、（可選）捕獲的異常對(duì)象。

如果發(fā)生了錯(cuò)誤，錯(cuò)誤信息（第二個(gè)參數(shù)）除了得到 null 之外，還可能是 "timeout", "error", "notmodified" 和 "parsererror"。

這是一個(gè) Ajax 事件。

global

類型：Boolean

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

ifModified

類型：Boolean

僅在服務(wù)器數(shù)據(jù)改變時(shí)獲取新數(shù)據(jù)。默認(rèn)值: false。使用 HTTP 包 Last-Modified 頭信息判斷。在 jQuery 1.4 中，它也會(huì)檢查服務(wù)器指定的 'etag' 來(lái)確定數(shù)據(jù)沒(méi)有被修改過(guò)。

jsonp

類型：String

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

jsonpCallback

類型：String

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

password

類型：String

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

processData

類型：Boolean

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

scriptCharset

類型：String

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

success

類型：Function

請(qǐng)求成功后的回調(diào)函數(shù)。

參數(shù)：由服務(wù)器返回，并根據(jù) dataType 參數(shù)進(jìn)行處理后的數(shù)據(jù)；描述狀態(tài)的字符串。

這是一個(gè) Ajax 事件。

traditional

類型：Boolean

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

timeout

類型：Number

設(shè)置請(qǐng)求超時(shí)時(shí)間（毫秒）。此設(shè)置將覆蓋全局設(shè)置。

type

類型：String

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

url

類型：String

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

username

類型：String

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

xhr

類型：Function

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

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

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

beforeSend

在發(fā)送請(qǐng)求之前調(diào)用，并且傳入一個(gè) XMLHttpRequest 作為參數(shù)。

error

在請(qǐng)求出錯(cuò)時(shí)調(diào)用。傳入 XMLHttpRequest 對(duì)象，描述錯(cuò)誤類型的字符串以及一個(gè)異常對(duì)象（如果有的話）

dataFilter

在請(qǐng)求成功之后調(diào)用。傳入返回的數(shù)據(jù)以及 "dataType" 參數(shù)的值。并且必須返回新的數(shù)據(jù)（可能是處理過(guò)的）傳遞給 success 回調(diào)函數(shù)。

success

當(dāng)請(qǐng)求之后調(diào)用。傳入返回后的數(shù)據(jù)，以及包含成功代碼的字符串。

complete

當(dāng)請(qǐng)求完成之后調(diào)用這個(gè)函數(shù)，無(wú)論成功或失敗。傳入 XMLHttpRequest 對(duì)象，以及一個(gè)包含成功或錯(cuò)誤代碼的字符串。

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

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

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

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

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

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

如果指定為 json 類型，則會(huì)把獲取到的數(shù)據(jù)作為一個(gè) JavaScript 對(duì)象來(lái)解析，并且把構(gòu)建好的對(duì)象作為結(jié)果返回。為了實(shí)現(xiàn)這個(gè)目的，它首先嘗試使用 JSON.parse()。如果瀏覽器不支持，則使用一個(gè)函數(shù)來(lái)構(gòu)建。

JSON 數(shù)據(jù)是一種能很方便通過(guò) JavaScript 解析的結(jié)構(gòu)化數(shù)據(jù)。如果獲取的數(shù)據(jù)文件存放在遠(yuǎn)程服務(wù)器上（域名不同，也就是跨域獲取數(shù)據(jù)），則需要使用 jsonp 類型。使用這種類型的話，會(huì)創(chuàng)建一個(gè)查詢字符串參數(shù) callback=? ，這個(gè)參數(shù)會(huì)加在請(qǐng)求的 URL 后面。服務(wù)器端應(yīng)當(dāng)在 JSON 數(shù)據(jù)前加上回調(diào)函數(shù)名，以便完成一個(gè)有效的 JSONP 請(qǐng)求。如果要指定回調(diào)函數(shù)的參數(shù)名來(lái)取代默認(rèn)的 callback，可以通過(guò)設(shè)置 $.ajax() 的 jsonp 參數(shù)。

注意：JSONP 是 JSON 格式的擴(kuò)展。它要求一些服務(wù)器端的代碼來(lái)檢測(cè)并處理查詢字符串參數(shù)。

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

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

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

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

高級(jí)選項(xiàng)

global 選項(xiàng)用于阻止響應(yīng)注冊(cè)的回調(diào)函數(shù)，比如 .ajaxSend，或者 ajaxError，以及類似的方法。這在有些時(shí)候很有用，比如發(fā)送的請(qǐng)求非常頻繁且簡(jiǎn)短的時(shí)候，就可以在 ajaxSend 里禁用這個(gè)。

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

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

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

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

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

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

jQuery Ajax 參考手冊(cè)