Ajax中的 $.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");
      }});

data

類型：String

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

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() 能夠在請求完成前掛起請求。