ajax 引數詳解

呂敬瑛發表於2021-04-05

ajax請求引數解析

1、url [Object]

一個用來包含傳送請求的URL字串

2、accepts [Map]

預設:取決於資料型別

內容型別傳送請求頭,告訴伺服器什麼樣的響應會被接收返回。如果accepts設定需要修改,推薦在$.ajaxSetup()方法中做一次

3、async [Boolean]

預設:true

預設設定下,所有請求均為非同步請求,如果需要傳送同步請求,請將此選項設定為false。注意,如果需要傳送同步請求。將此選項設定為false。注意,同步請求將鎖住瀏覽器,使用者其它操作必須等待請求完成後才可以執行

4、beforeSend(XHR) [Function]

傳送請求前可修改 XMLHttpRequest 物件的函式,如新增自定義 HTTP 頭。XMLHttpRequest 物件是唯一的引數。這是一個 Ajax 事件。如果返回false可以取消本次ajax請求。

5、cache [Boolean]

(預設: true,dataType為script和jsonp時預設為false) jQuery 1.2 新功能,設定為 false 將不快取此頁面。

6、complete(XHR, TS) [Function]

請求完成後回撥函式 (請求成功或失敗之後均呼叫)。引數: XMLHttpRequest 物件和一個描述成功請求型別的字串

7、contents [Map]

一個以"{字串:正規表示式}"配對的物件,用來確定jQuery將如何解析響應,給定其內容型別。

8、contentType [String]

(預設: "application/x-www-form-urlencoded") 傳送資訊至伺服器時內容編碼型別。預設值適合大多數情況。如果你明確地傳遞了一個content-type給 $.ajax() 那麼他必定會傳送給伺服器(即使沒有資料要傳送)

9、context [Object]

這個物件用於設定Ajax相關回撥函式的上下文。也就是說,讓回撥函式內this指向這個物件(如果不設定這個引數,那麼this就指向呼叫本次AJAX請求時傳遞的options引數)。比如指定一個DOM元素作為context引數,這樣就設定了success回撥函式的上下文為這個DOM元素。

10、crossDomain [map]

預設: 同域請求為false

跨域請求為true如果你想強制跨域請求(如JSONP形式)同一域,設定crossDomain為true。這使得例如,伺服器端重定向到另一個域

11、data [Object,String]

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

12、dataFilter [Function]

給Ajax返回的原始資料的進行預處理的函式。提供data和type兩個引數:data是Ajax返回的原始資料,type是呼叫jQuery.ajax時提供的dataType引數。函式返回的值將由jQuery進一步處理。

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

14、error [Function]

(預設: 自動判斷 (xml 或 html)) 請求失敗時呼叫此函式。有以下三個引數:XMLHttpRequest 物件、錯誤資訊、(可選)捕獲的異常物件。如果發生了錯誤,錯誤資訊(第二個引數)除了得到null之外,還可能是"timeout", "error", "notmodified" 和 "parsererror"。

15、headers [map]

Default: {}

一個額外的"{鍵:值}"對對映到請求一起傳送。此設定被設定之前beforeSend函式被呼叫;因此,訊息頭中的值設定可以在覆蓋beforeSend函式範圍內的任何設定。

16、jsonp [String]

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

17、jsonpCallback [String]

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

18、mimeType [String]

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

19、password [String]

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

20、processData [Boolean]

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

21、scriptCharset [String]

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

22、statusCode [map]

預設: {}

一組數值的HTTP程式碼和函式物件,當響應時呼叫了相應的程式碼。例如,如果響應狀態是404,將觸發以下警報:

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

23、success(data, textStatus, jqXHR) [Function,Array]

請求成功後的回撥函式。引數:由伺服器返回,並根據dataType引數進行處理後的資料;描述狀態的字串。還有 jqXHR(在jQuery 1.4.x的中,XMLHttpRequest) 物件 。在jQuery 1.5, 成功設定可以接受一個函式陣列。每個函式將被依次呼叫。

24、traditional [Boolean]

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

25、timeout [Number]

設定請求超時時間(毫秒)。此設定將覆蓋全域性設定。

26、type [String]

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

27、username [String]

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

案例

描述:

載入並執行一個 JS 檔案。

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

描述:

儲存資料到伺服器,成功時顯示資訊。

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

描述:

裝入一個 HTML 網頁最新版本。

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

描述:

同步載入資料。傳送請求時鎖住瀏覽器。需要鎖定使用者互動操作時使用同步方式。

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

描述:

傳送 XML 資料至伺服器。設定 processData 選項為 false,防止自動轉換資料格式。

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