$.ajax()詳解

前端開發難免會用到 $.ajax()，詳細整理下各引數的含義，供以後查詢參考。

文章整合了《https://www.cnblogs.com/tyler...》和《https://www.cnblogs.com/huyue...》。

一、$.ajax( ){ }函式格式如下：


$.ajax({
    url: "test.aspx?r=" + Math.random(),
    type: "GET",
    data: {},
    dataType: "json",
    async: false,  // 預設是true
    success: function (result) {
        var coin = result["coin"];
        var stage = result["stage"];
        document.write("金幣：" + coin + "個，身份：" + stage);
    }
});

二、引數具體含義：

1.url:
要求為String型別的引數，（預設為當前頁地址）傳送請求的地址。

2.type:
要求為String型別的引數，請求方式（post或get）預設為get。注意其他http請求方法，例如put和delete也可以使用，但僅部分瀏覽器支援。

3.timeout:
要求為Number型別的引數，設定請求超時時間（毫秒）。此設定將覆蓋$.ajaxSetup()方法的全域性設定。

4.async:
要求為Boolean型別的引數，預設設定為true，所有請求均為非同步請求。如果需要傳送同步請求，請將此選項設定為false。注意，同步請求將鎖住瀏覽器，使用者其他操作必須等待請求完成才可以執行。

5.cache:
要求為Boolean型別的引數，預設為true（當dataType為script時，預設為false），設定為false將不會從瀏覽器快取中載入請求資訊。

6.data:
要求為Object或String型別的引數，傳送到伺服器的資料。如果已經不是字串，將自動轉換為字串格式。本質上還是String型別。（w3school中只說明瞭這一種型別）
get請求中，data將附加在url後。防止這種自動轉換，可以檢視processData選項。物件必須為key/value格式，例如{foo1:"bar1",foo2:"bar2"}轉換為&foo1=bar1&foo2=bar2。如果是陣列，JQuery將自動為不同值對應同一個名稱。例如{foo:["bar1","bar2"]}轉換為&foo=bar1&foo=bar2。

7.dataType:
要求為String型別的引數，預期伺服器返回的資料型別，將根據該指定型別解析返回資料，如果這裡資料型別不match，比如指定json，但伺服器返回的type是html，即使狀態碼是200 ok，也會走到error裡面。
如果不指定，JQuery將自動根據http包mime資訊返回responseXML或responseText，並作為回撥函式引數傳遞。

可用的型別如下：
xml：返回XML文件，可用JQuery處理。
html：返回純文字HTML資訊；包含的script標籤會在插入DOM時執行。
script：返回純文字JavaScript程式碼。不會自動快取結果。除非設定了cache引數。注意在遠端請求時（不在同一個域下），所有post請求都將轉為get請求。
json：返回JSON資料。
jsonp：JSONP格式。使用SONP形式呼叫函式時，例如myurl?callback=?，JQuery將自動替換後一個“?”為正確的函式名，以執行回撥函式。
text：返回純文字字串。

8.beforeSend：
要求為Function型別的引數，傳送請求前可以修改XMLHttpRequest物件的函式，例如新增自定義HTTP頭。在beforeSend中如果返回false可以取消本次ajax請求。XMLHttpRequest物件是惟一的引數。


function(XMLHttpRequest){
    this;   //呼叫本次ajax請求時傳遞的options引數
}

9.complete：
要求為Function型別的引數，請求完成後呼叫的回撥函式（請求成功或失敗時均呼叫）。引數：XMLHttpRequest物件和一個描述成功請求型別的字串。


function(XMLHttpRequest, textStatus){
    this;    //呼叫本次ajax請求時傳遞的options引數
}

10.success：
要求為Function型別的引數，請求成功後呼叫的回撥函式，有兩個引數:

由伺服器返回，並根據dataType引數進行處理後的資料。
描述狀態的字串。
``` function(data, textStatus){ //data可能是xmlDoc、jsonObj、html、text等等 this; //呼叫本次ajax請求時傳遞的options引數 } ```
觸發條件：
XMLHttpRequest物件的屬性readyState和status
success：readyState==4 && (status>=200 && status < 300 || status === 304)

readyState==4 請求已完成，且響應已就緒
status==200 伺服器響應正常。
本質上是一個if else判斷，若
``` if(readyState==4 && (status>=200 && status < 300 || status === 304)){ success } else { error } ```

在這裡插入圖片描述

11.error:
要求為Function型別的引數，請求失敗時被呼叫的函式。該函式有3個引數，即XMLHttpRequest物件、錯誤資訊、捕獲的錯誤物件(可選)。ajax事件函式如下：


function(XMLHttpRequest, textStatus, errorThrown){
    //通常情況下textStatus和errorThrown只有其中一個包含資訊
    this;   //呼叫本次ajax請求時傳遞的options引數
    // 列印 errorThrown 可以看出錯誤資訊
}

12.contentType：
要求為String型別的引數，當傳送資訊至伺服器時，內容編碼型別預設為"application/x-www-form-urlencoded"。該預設值適合大多數應用場合。

13.dataFilter：
要求為Function型別的引數，給Ajax返回的原始資料進行預處理的函式。提供data和type兩個引數。data是Ajax返回的原始資料，type是呼叫jQuery.ajax時提供的dataType引數。函式返回的值將由jQuery進一步處理。


function(data, type){
     //返回處理後的資料
     return data;
}

14.global：
要求為Boolean型別的引數，預設為true。表示是否觸發全域性ajax事件。設定為false將不會觸發全域性ajax事件，ajaxStart或ajaxStop可用於控制各種ajax事件。

15.ifModified：
要求為Boolean型別的引數，預設為false。僅在伺服器資料改變時獲取新資料。伺服器資料改變判斷的依據是Last-Modified頭資訊。預設值是false，即忽略頭資訊。

16.jsonp：
要求為String型別的引數，在一個jsonp請求中重寫回調函式的名字。該值用來替代在"callback=?"這種GET或POST請求中URL引數裡的"callback"部分，例如{jsonp:'onJsonPLoad'}會導致將"onJsonPLoad=?"傳給伺服器。
jsonp本質上是get，即便指定type為post，也會按照get來發起請求。

17.username：
要求為String型別的引數，用於響應HTTP訪問認證請求的使用者名稱。

18.password：
要求為String型別的引數，用於響應HTTP訪問認證請求的密碼。

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

20.scriptCharset：
要求為String型別的引數，只有當請求時dataType為"jsonp"或者"script"，並且type是GET時才會用於強制修改字符集(charset)。通常在本地和遠端的內容編碼不同時使用。

其他補充：

$.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。

參考：http://www.w3school.com.cn/jq...

來源：https://segmentfault.com/a/1190000017765056

一、$.ajax( ){ }函式格式如下：

二、引數具體含義：

其他補充：

相關推薦