jQuery ajax() 方法總結

定義和用法

ajax() 方法通過 HTTP 要求載入遠端資料。

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

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

注意：所有的選項都可以通過 $.ajaxSetup() 函數來全域設定。

文法

jQuery.ajax([settings])

參數	描述
settings	可選。用於配置 Ajax 請求的索引值對集合。 可以通過 $.ajaxSetup() 設定任何選項的預設值。

參數

options

類型：Object

可選。AJAX 請求設定。所有選項都是可選的。

async

類型：Boolean

預設值: true。預設設定下，所有請求均為非同步請求。如果需要發送同步請求，請將此選項設定為 false。

注意，同步請求將鎖住瀏覽器，使用者其它操作必須等待請求完成才可以執行。

beforeSend(XHR)

類型：Function

發送請求前可修改 XMLHttpRequest 對象的函數，如添加自訂 HTTP 頭。

XMLHttpRequest 對象是唯一的參數。

這是一個 Ajax 事件。如果返回 false 可以取消本次 ajax 請求。

cache

類型：Boolean

預設值: true，dataType 為 script 和 jsonp 時預設為 false。設定為 false 將不緩衝此頁面。

jQuery 1.2 新功能。

complete(XHR, TS)

類型：Function

請求完成後回呼函數 (請求成功或失敗之後均調用)。

參數： XMLHttpRequest 對象和一個描述請求類型的字串。

這是一個 Ajax 事件。

contentType

類型：String

預設值: "application/x-www-form-urlencoded"。發送資訊至伺服器時內容編碼類別型。

預設值適合大多數情況。如果你明確地傳遞了一個 content-type 給 $.ajax() 那麼它必定會發送給伺服器（即使沒有資料要發送）。

context

類型：Object

這個對象用於設定 Ajax 相關回呼函數的上下文。也就是說，讓回呼函數內 this 指向這個對象（如果不設定這個參數，那麼 this 就指向調用本次 AJAX 請求時傳遞的 options 參數）。比如指定一個 DOM 元素作為 context 參數，這樣就設定了 success 回呼函數的上下文為這個 DOM 元素。

就像這樣：

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

dataObject

類型：String

發送到伺服器的資料。將自動轉換為請求字串格式。GET 請求中將附加在 URL 後。查看 processData 選項說明以禁止此自動轉換。必須為 Key/Value 格式。如果為數組，jQuery 將自動為不同值對應同一個名稱。如 {foo:["bar1", "bar2"]} 轉換為 '&foo=bar1&foo=bar2'。

樣本：

這裡data後面跟的參數可以用二種表式：一種是普通url傳參的寫法一樣，還有一種就是寫在json數組裡，

上面樣本data部分也可以這樣寫：data: ｛name:"John",location:"Boston"}。這二個用法有什麼區別？

今天在開發中發現二者用法的細微差別。第一種我們用url傳參，參數裡面如果加帶"&"這個符號的話，可能參數接收不到或不完整，如“ data: "name=John&location=Boston",”，

如果name的值是"john&smith"這樣寫可能就會有問題，我們可以用JS裡面的encodeURIComponent()方法進行轉義，

但如果用data: ｛name:"John",location:"Boston"}這種方式寫的話就不需要進行轉義，如果轉義的話，接收的將是轉義後的字串 

dataFilter

類型：Function

給 Ajax 返回的未經處理資料的進行預先處理的函數。提供 data 和 type 兩個參數：data 是 Ajax 返回的未經處理資料，type 是調用 jQuery.ajax 時提供的 dataType 參數。函數返回的值將由 jQuery 進一步處理。

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": 返回純文字字串

error

類型：Function

預設值: 自動判斷 (xml 或 html)。請求失敗時調用此函數。

有以下三個參數：XMLHttpRequest 對象、錯誤資訊、（可選）捕獲的異常對象。

如果發生了錯誤，錯誤資訊（第二個參數）除了得到 null 之外，還可能是 "timeout", "error", "notmodified" 和 "parsererror"。

這是一個 Ajax 事件。

global

類型：Boolean

是否觸發全域 AJAX 事件。預設值: true。設定為 false 將不會觸發全域 AJAX 事件，如 ajaxStart 或 ajaxStop 可用於控制不同的 Ajax 事件。

ifModified

類型：Boolean

僅在伺服器資料改變時擷取新資料。預設值: false。使用 HTTP 包 Last-Modified 頭資訊判斷。在 jQuery 1.4 中，它也會檢查伺服器指定的 'etag' 來確定資料沒有被修改過。

jsonp

類型：String

在一個 jsonp 請求中重寫回呼函數的名字。這個值用來替代在 "callback=?" 這種 GET 或 POST 請求中 URL 參數裡的 "callback" 部分，比如 {jsonp:'onJsonPLoad'} 會導致將 "onJsonPLoad=?" 傳給伺服器。

jsonpCallback

類型：String

為 jsonp 請求指定一個回呼函數名。這個值將用來取代 jQuery 自動產生的隨機函數名。這主要用來讓 jQuery 產生度獨特的函數名，這樣管理請求更容易，也能方便地提供回呼函數和錯誤處理。你也可以在想讓瀏覽器緩衝 GET 請求的時候，指定這個回呼函數名。

password

類型：String

用於響應 HTTP 訪問認證請求的密碼

processData

類型：Boolean

預設值: true。預設情況下，通過data選項傳遞進來的資料，如果是一個對象(技術上講只要不是字串)，都會處理轉化成一個查詢字串，以配合預設內容類型 "application/x-www-form-urlencoded"。如果要發送 DOM 樹資訊或其它不希望轉換的資訊，請設定為 false。

scriptCharset

類型：String

只有當請求時 dataType 為 "jsonp" 或 "script"，並且 type 是 "GET" 才會用於強制修改 charset。通常只在本地和遠端內容編碼不同時使用。

success

類型：Function

請求成功後的回呼函數。

參數：由伺服器返回，並根據 dataType 參數進行處理後的資料；描述狀態的字串。

這是一個 Ajax 事件。

traditional

類型：Boolean

如果你想要用傳統的方式來序列化資料，那麼就設定為 true。請參考工具分類下面的 jQuery.param 方法。

timeout

類型：Number

佈建要求逾時時間（毫秒）。此設定將覆蓋全域設定。

type

類型：String

預設值: "GET")。請求方式 ("POST" 或 "GET")， 預設為 "GET"。注意：其它 HTTP 要求方法，如 PUT 和 DELETE 也可以使用，但僅部分瀏覽器支援。

url

類型：String

預設值: 當前頁地址。發送請求的地址。

username

類型：String

用於響應 HTTP 訪問認證請求的使用者名稱。

xhr

類型：Function

需要返回一個 XMLHttpRequest 對象。預設在 IE 下是 ActiveXObject 而其他情況下是 XMLHttpRequest 。用於重寫或者提供一個增強 XMLHttpRequest 對象。這個參數在 jQuery 1.3 以前不可用。

 

回呼函數

如果要處理 $.ajax() 得到的資料，則需要使用回呼函數：beforeSend、error、dataFilter、success、complete。

beforeSend

在發送請求之前調用，並且傳入一個 XMLHttpRequest 作為參數。

error

在請求出錯時調用。傳入 XMLHttpRequest 對象，描述錯誤類型的字串以及一個異常對象（如果有的話）

dataFilter

在請求成功之後調用。傳入返回的資料以及 "dataType" 參數的值。並且必須返回新的資料（可能是處理過的）傳遞給 success 回呼函數。

success

當請求之後調用。傳入返回後的資料，以及包含成功碼的字串。

complete

當請求完成之後調用這個函數，無論成功或失敗。傳入 XMLHttpRequest 對象，以及一個包含成功或錯誤碼的字串。

資料類型

$.ajax() 函數依賴伺服器提供的資訊來處理返回的資料。如果伺服器報告說返回的資料是 XML，那麼返回的結果就可以用普通的 XML 方法或者 jQuery 的選取器來遍曆。如果見得到其他類型，比如 HTML，則資料就以文本形式來對待。

通過 dataType 選項還可以指定其他不同資料處理方式。除了單純的 XML，還可以指定 html、json、jsonp、script 或者 text。

其中，text 和 xml 類型返回的資料不會經過處理。資料僅僅簡單的將 XMLHttpRequest 的 responseText 或 responseHTML 屬性傳遞給 success 回呼函數。

注意：我們必須確保網頁伺服器報告的 MIME 類型與我們選擇的 dataType 所匹配。比如說，XML的話，伺服器端就必須聲明 text/xml 或者 application/xml 來獲得一致的結果。

如果指定為 html 類型，任何內嵌的 JavaScript 都會在 HTML 作為一個字串返回之前執行。類似地，指定 script 類型的話，也會先執行伺服器端產生 JavaScript，然後再把指令碼作為一個文本資料返回。

如果指定為 json 類型，則會把擷取到的資料作為一個 JavaScript 對象來解析，並且把構建好的對象作為結果返回。為了實現這個目的，它首先嘗試使用 JSON.parse()。如果瀏覽器不支援，則使用一個函數來構建。

JSON 資料是一種能很方便通過 JavaScript 解析的結構化資料。如果擷取的資料檔案存放在遠程伺服器上（網域名稱不同，也就是跨域擷取資料），則需要使用 jsonp 類型。使用這種類型的話，會建立一個查詢字串參數 callback=? ，這個參數會加在請求的 URL 後面。伺服器端應當在 JSON 資料前加上回呼函數名，以便完成一個有效 JSONP 請求。如果要指定回呼函數的參數名來取代預設的 callback，可以通過設定 $.ajax() 的 jsonp 參數。

注意：JSONP 是 JSON 格式的擴充。它要求一些伺服器端的代碼來檢測並處理查詢字串參數。

如果指定了 script 或者 jsonp 類型，那麼當從伺服器接收到資料時，實際上是用了 <script> 標籤而不是 XMLHttpRequest 對象。這種情況下，$.ajax() 不再返回一個 XMLHttpRequest 對象，並且也不會傳遞事件處理函數，比如 beforeSend。

發送資料到伺服器

預設情況下，Ajax 請求使用 GET 方法。如果要使用 POST 方法，可以設定 type 參數值。這個選項也會影響 data 選項中的內容如何發送到伺服器。

data 選項既可以包含一個查詢字串，比如 key1=value1&key2=value2 ，也可以是一個映射，比如 {key1: 'value1', key2: 'value2'} 。如果使用了後者的形式，則資料再發送器會被轉換成查詢字串。這個處理過程也可以通過設定 processData 選項為 false 來迴避。如果我們希望發送一個 XML 對象給伺服器時，這種處理可能並不合適。並且在這種情況下，我們也應當改變 contentType 選項的值，用其他合適的 MIME 類型來取代預設的 application/x-www-form-urlencoded 。

 進階選項

global 選項用於阻止響應註冊的回呼函數，比如 .ajaxSend，或者 ajaxError，以及類似的方法。這在有些時候很有用，比如發送的請求非常頻繁且簡短的時候，就可以在 ajaxSend 裡禁用這個。

如果伺服器需要 HTTP 認證，可以使用使用者名稱和密碼可以通過 username 和 password 選項來設定。

Ajax 請求是限時的，所以錯誤警告被捕獲並處理後，可以用來提升使用者體驗。請求逾時這個參數通常就保留其預設值，要不就通過 jQuery.ajaxSetup 來全域設定，很少為特定的請求重新設定 timeout 選項。

預設情況下，請求總會被發出去，但瀏覽器有可能從它的緩衝中調取資料。要禁止使用緩衝的結果，可以設定 cache 參數為 false。如果希望判斷資料自從上次請求後沒有更改過就報告出錯的話，可以設定 ifModified 為 true。

scriptCharset 允許給 <script> 標籤的請求設定一個特定的字元集，用於 script 或者 jsonp 類似的資料。當指令碼和頁面字元集不同時，這特別好用。

Ajax 的第一個字母是 asynchronous 的開頭字母，這意味著所有的操作都是並行的，完成的順序沒有前後關係。$.ajax() 的 async 參數總是設定成true，這標誌著在請求開始後，其他代碼依然能夠執行。強烈不建議把這個選項設定成 false，這意味著所有的請求都不再是非同步了，這也會導致瀏覽器被鎖死。

$.ajax 函數返回它建立的 XMLHttpRequest 對象。通常 jQuery 只在內部處理並建立這個對象，但使用者也可以通過 xhr 選項來傳遞一個自己建立的 xhr 對象。返回的對象通常已經被丟棄了，但依然提供一個底層介面來觀察和操控請求。比如說，調用對象上的 .abort() 可以在請求完成前掛起請求。