jquery ajax 方法及各參數詳解

時間 2019-11-08

原文原文鏈接

在使用jquery的時候，咱們常常用到jquery中對ajax的封裝，下面對ajax函數的各參數詳細說明和講解，以便更好的理解和使用 $.get(url, data, callback,type) 和 $.post(url, data, callback, type).javascript

一、 jQuery.ajax( options ) : 經過 HTTP 請求加載遠程數據css

這個是jQuery 的底層 AJAX 實現。簡單易用的高層實現見 $.get, $.post 等。html

$.ajax() 返回其建立的 XMLHttpRequest 對象。大多數狀況下你無需直接操做該對象，但特殊狀況下可用於本身控制提交的參數和HTTP Header的設定。java

注意：若是你指定了 dataType 選項，請確保服務器返回正確的 MIME 信息，(如 xml 返回 "text/xml")。錯誤的 MIME 類型可能致使不可預知的錯誤。見 Specifying the Data Type for AJAX Requests 。
當設置 datatype 類型爲 'script' 的時候，全部的遠程(不在同一個域中)POST請求都回轉換爲GET方式。python

$.ajax() 只有一個參數：參數 key/value 對象，包含各配置及回調函數信息。詳細參數選項見下。jquery

jQuery 1.2 中，您能夠跨域加載 JSON 數據，使用時需將數據類型設置爲 JSONP。使用 JSONP 形式調用函數時，如 "myurl?callback=?" jQuery 將自動替換 ? 爲正確的函數名，以執行回調函數。數據類型設置爲 "jsonp" 時，jQuery 將自動調用回調函數。(這個我不是很懂)web

參數列表：ajax

參數名	類型	描述
url	String	(默認: 當前頁地址) 發送請求的地址。
type	String	(默認: "GET") 請求方式 ("POST" 或 "GET")，默認爲 "GET"。注意：其它 HTTP 請求方法，如 PUT 和 DELETE 也能夠使用，但僅部分瀏覽器支持。
timeout	Number	設置請求超時時間（毫秒）。此設置將覆蓋全局設置。
async	Boolean	(默認: true) 默認設置下，全部請求均爲異步請求。若是須要發送同步請求，請將此選項設置爲 false。注意，同步請求將鎖住瀏覽器，用戶其它操做必須等待請求完成才能夠執行。
beforeSend	Function	發送請求前可修改 XMLHttpRequest 對象的函數，如添加自定義 HTTP 頭。XMLHttpRequest 對象是惟一的參數。 function (XMLHttpRequest) { this; // the options for this ajax request }
cache	Boolean	(默認: true) jQuery 1.2 新功能，設置爲 false 將不會從瀏覽器緩存中加載請求信息。
complete	Function	請求完成後回調函數 (請求成功或失敗時均調用)。參數： XMLHttpRequest 對象，成功信息字符串。 function (XMLHttpRequest, textStatus) { this; // the options for this ajax request }
contentType	String	(默認: "application/x-www-form-urlencoded") 發送信息至服務器時內容編碼類型。默認值適合大多數應用場合。告訴服務器從瀏覽器提交過來的數據格式。spring 例如：咱們提交數據時假如使用了 JSON2.js 中方法 JSON.stringify(obj) 格式化爲json字符串後，再默認提交就會報錯。這個時候就須要指定提交的內容格式爲："application/json"。json
data	Object, String	發送到服務器的數據。若data數據類型爲JavaScript對象或數組，Jquery在提交以前自動調用JQuery.param()方法把要發送的數據編碼成爲"application/x-www-form- urlencoded"格式的數據（即 name=value&name1=value1）；JavaScript對象必須爲 Key/Value 格式；若是爲數組，jQuery 將自動爲不一樣值對應同一個名稱。如 {foo:["bar1", "bar2"]} 轉換爲 '&foo=bar1&foo=bar2'；若data數據類型爲String類型，則直接默認該數據已經按照"application/x-www-form-urlencoded"格式編碼完成，再也不轉換。 processData選項能夠控制是否進行轉換。該選項默認爲true。
dataType	String	預期服務器返回的數據類型。設定HttpHeader中「Accept」域的內容，告訴服務器瀏覽器能夠想要返回的數據格式類型，同時JQuery也會根據該類型對返回的數據進行處理。若是不指定，jQuery 將自動根據 HTTP 包 MIME 信息返回 responseXML 或 responseText，並做爲回調函數參數傳遞，可用值: "xml": 返回 XML 文檔，可用 jQuery 處理。 "html": 返回純文本 HTML 信息；包含 script 元素。 "script": 返回純文本 JavaScript 代碼。不會自動緩存結果。 "json": 返回 JSON 數據。JQuery將返回的字符串格式數據自動轉化爲Javascript對象，便於直接使用obj.property格式訪問。若沒有指定該選項，即便返回的是JSON格式的字符串，JQuery也不會自動轉換。 "jsonp": JSONP 格式。使用 JSONP 形式調用函數時，如 "myurl?callback=?" jQuery 將自動替換 ? 爲正確的函數名，以執行回調函數。
error	Function	(默認: 自動判斷 (xml 或 html)) 請求失敗時將調用此方法。這個方法有三個參數：XMLHttpRequest 對象，錯誤信息，（可能）捕獲的錯誤對象。 function (XMLHttpRequest, textStatus, errorThrown) { // 一般狀況下textStatus和errorThown只有其中一個有值 this; // the options for this ajax request }
global	Boolean	(默認: true) 是否觸發全局 AJAX 事件。設置爲 false 將不會觸發全局 AJAX 事件，如 ajaxStart 或 ajaxStop 。可用於控制不一樣的Ajax事件
ifModified	Boolean	(默認: false) 僅在服務器數據改變時獲取新數據。使用 HTTP 包 Last-Modified 頭信息判斷。
processData	Boolean	(默認: true) 默認狀況下，發送的數據將被轉換爲對象(技術上講並不是字符串) 以配合默認內容類型 "application/x-www-form-urlencoded"。若是要發送 DOM 樹信息或其它不但願轉換的信息，請設置爲 false。
success	Function	請求成功後回調函數。這個方法有兩個參數：服務器返回數據，返回狀態 function (data, textStatus) { // data could be xmlDoc, jsonObj, html, text, etc... this; // the options for this ajax request }

這裏有幾個Ajax事件參數：beforeSend ，success ，complete ，error 。咱們能夠定義這些事件來很好的處理咱們的每一次的Ajax請求。注意一下，這些Ajax事件裏面的 this 都是指向Ajax請求的選項信息的(請參考說 get() 方法時的this的圖片)。
請認真閱讀上面的參數列表，若是你要用jQuery來進行Ajax開發，那麼這些參數你都必需熟知的。

示例代碼，獲取博客園首頁的文章題目：

 1 $.ajax({
 2  type: "get",
 3  url: "http://www.cnblogs.com/rss",
 4  beforeSend: function(XMLHttpRequest){
 5  //ShowLoading(); }, success: function(data, textStatus){
 6  $(".ajax.ajaxResult").html("");
 7  $("item",data).each(function(i, domEle){
 8  $(".ajax.ajaxResult").append("<li>"+$(domEle).children("title").text()+"</li>");
 9  });
10  },
11  complete: function(XMLHttpRequest, textStatus){
12  //HideLoading(); }, error: function(){
13  //請求出錯處理 } });

爲了說明 contentType: "application/json" 和 dataType:"JSON"選項，JQuery對返回數據進行了自動轉化，下面舉個例子：

前段頁面： register.jsp

 1 <%@ page language="java" contentType="text/html; charset=UTF-8"%>  
 2 <%@ taglib prefix="sf" uri="http://www.springframework.org/tags/form"%>  
 3 <%  
 4 String webProject = request.getContextPath();  
 5 String basePath = request.getScheme()+"://"+request.getServerName()+":"+request.getServerPort()+request.getContextPath()+"/";  
 6 %>  
 7   
 8 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">  
 9 <html>  
10 <head>  
11 <base href="<%= basePath %>" />  
12 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">  
13 <title>User Register Page</title>  
14 <script type="text/javascript" src="<%=webProject%>/resource/js/jquery-1.7.2.min.js"></script>  
15 <script type="text/javascript" src="<%=webProject%>/resource/js/json2.js"></script><style type="text/css">  
16 .error{  
17     color: red;   
18 }  
19 </style>  
20 <script type="text/javascript">  
21     function register(){  
22         var params={  
23                 "userName": $("#userName").val(),  
24                 "password": $("#password").val(),  
25                 "email"   : $("#email").val()  
26                 };  
27         var url = "<%=webProject%>/register";  
28         var successFun = function(data, textStatus){  
29                     alert("success!");  
30                     alert("responseText="+data.userName);  
31                     alert("statusText="+textStatus);  
32                 };  
33         var errorFun = function (XMLHttpRequest, textStatus, errorThrown) {  
34             alert("error");  
35             alert("XMLHttpRequest="+XMLHttpRequest);  
36             alert("statusText="+textStatus);  
37             alert("errorThrown="+errorThrown);  
38              }  
39         $.ajax({  
40             type: "POST",  
41             url : "<%=webProject%>/register",  
42             data: JSON.stringify(params),  
43             success: successFun,  
44             error: errorFun  
45             //contentType: "application/json",  
46             //dataType: "json"            
47         });  
48     }     
49 </script>  
50 </head>  
51   
52 <body>      
53     <sf:form method="post" modelAttribute="user">  
54         <p>用戶註冊頁面：</p>  
55         <table width="60%" align="center">  
56             <colgroup>  
57                 <col width="10%" align="right" />  
58                 <col />  
59             </colgroup>     
60             <tr>  
61                 <th>用戶名：</th>  
62                 <td>  
63                     <sf:input path="userName" />  
64                     <small>length of userName is not more than 20.</small><br />  
65                     <sf:errors path="userName" cssClass="error"/>  
66                 </td>  
67             </tr>  
68             <tr>  
69                 <th>密碼：</th>  
70                 <td>  
71                     <sf:password path="password" />  
72                     <small>length of password is not less than 6.</small><br />  
73                     <sf:errors path="password" cssClass="error" />  
74                 </td>  
75             </tr>  
76             <tr>  
77                 <th>郵箱：</th>  
78                 <td>  
79                     <sf:input path="email"/>  
80                     <small>format should confirm to general standard.</small><br />  
81                     <sf:errors path="email" cssClass="error" />  
82                 </td>  
83             </tr>               
84             <tr>  
85                 <td colspan="2" align="center">  
86                     <input type="button" value="註冊" onclick="register()"/>  
87                 </td>  
88             </tr>  
89         </table>  
90     </sf:form>  
91 </body>  
92 </html>

服務器端代碼：

 1 package org.study.controller;  
 2   
 3 import java.io.IOException;  
 4   
 5 import javax.servlet.http.HttpServletResponse;  
 6   
 7 import org.springframework.stereotype.Controller;  
 8 import org.springframework.ui.Model;  
 9 import org.springframework.web.bind.annotation.RequestMapping;  
10 import org.springframework.web.bind.annotation.RequestMethod;  
11 import org.study.domain.User;  
12   
13 /**  
14  * 用戶註冊、登錄相關信息的Controller。  
15  * 使用JSON方式處理輸入和輸出數據。  
16  *   
17  * @author CHEN Dezong  
18  * @version 1.0.0  
19  *  
20  */  
21 @Controller  
22 @RequestMapping ("/register")  
23 public class RegisterController {  
24       
25     /**  
26      * 顯示用戶註冊頁面。  
27      * @param model  
28      * @return  
29      */  
30     @RequestMapping (method = RequestMethod.GET)  
31     public String showRegister(Model model){  
32         model.addAttribute(new User());  
33           
34         return "register";  
35     }  
36       
37     /**  
38      * 處理提交的用戶註冊信息。  
39      * @param model  
40      * @return  
41      * @throws IOException   
42      */  
43     @RequestMapping (method = RequestMethod.POST)  
44     public void doRegister(HttpServletResponse response) throws IOException{  
45           
46         String value = "{'userName':'中文', 'password':'123'}";  
47           
48         response.setCharacterEncoding("UTF-8");  
49 //      response.setHeader("content-type", "application/json");  
50           
51         response.getWriter().print(value);  
52         response.getWriter().close();  
53     }  
54       
55 }

POJO 對象 User.java

 1 package org.study.domain;  
 2   
 3 public class User {  
 4     private String userName;  
 5       
 6     private String password;  
 7       
 8     private String email;  
 9       
10     public String getUserName() {  
11         return userName;  
12     }  
13     public void setUserName(String userName) {  
14         this.userName = userName;  
15     }  
16     public String getPassword() {  
17         return password;  
18     }  
19     public void setPassword(String password) {  
20         this.password = password;  
21     }  
22     public String getEmail() {  
23         return email;  
24     }  
25     public void setEmail(String email) {  
26         this.email = email;  
27     }     
28       
29     public boolean equals(Object obj){  
30         if(obj == null){  
31             return false;  
32         }  
33         if(obj == this){  
34             return true;  
35         }         
36         if(obj instanceof User){  
37             if(userName.equals(((User) obj).userName) && password.equals(((User) obj).password) && email.equals(((User) obj).email)){  
38                 return true;  
39             }else{  
40                 return false;  
41             }  
42         }else{  
43             return false;  
44         }  
45     }  
46       
47     public String toString(){  
48         StringBuilder sb = new StringBuilder();  
49           
50         sb.append(getClass()).append("[")  
51         .append("userName=").append(userName).append(", ")  
52         .append("password=").append(password).append(", ")  
53         .append("email=").append(email).append("]");  
54           
55         return sb.toString();  
56     }  
57       
58 }

1) contentType: 設定提交的數據內容格式，告訴服務器提交的數據格式

contentType: 不設置狀況下默認「application/x-www-form-urlencoded」格式提交數據。

A) var params={"userName": $("#userName").val(),"password": $("#password").val(),"email" : $("#email").val()};

要提交的對象爲javascript對象，$.ajax(url, params, callback, "json"); 在提交以前JQuery自動將javascript對象編碼成「application/x-www-form-urlencoded」格式數據。

B) var params="userName="+$("#userName").val()+"&password="+$("#password").val()+"&email="+$("#email").val();

提交以前的數據已經按照「application/x-www-form-urlencoded」格式準備完畢，因此在不設定contentType的狀況下，服務器端也能夠正常解析。

須要設置contentType的狀況：

在尋找ajax提交示例的時候，看到網上有人在提交以前把javascript對象已經用 JSON.stringify(obj)轉換爲json格式的字符串了。

 1 var params={  
 2                 "userName": $("#userName").val(),  
 3                 "password": $("#password").val(),  
 4                 "email"   : $("#email").val()  
 5                 };  
 6         var url = "<%=webProject%>/register";  
 7         var successFun = function(data, textStatus){  
 8                     alert("success!");  
 9                     alert("responseText="+data.userName);  
10                                     };  
11         var errorFun = function (XMLHttpRequest, textStatus, errorThrown) {  
12             alert("error");  
13                     alert("statusText="+textStatus);  
14                          }  
15         $.ajax({  
16             type: "POST",  
17             url : "<%=webProject%>/register",  
18             data: JSON.stringify(params),  
19             success: successFun,  
20             error: errorFun  
21             //contentType: "application/json",  
22             //dataType: "json"            
23         });

服務器代碼：

 1 /** 
 2  * 處理提交的用戶註冊信息。 
 3  * @param model 
 4  * @return 
 5  * @throws IOException  
 6  */  
 7 @RequestMapping (method = RequestMethod.POST)  
 8 public void doRegister(@RequestBody User user, HttpServletResponse response) throws IOException{  
 9       
10     System.out.println(user);  
11       
12     String value = "{'userName':'中文', 'password':'123'}";  
13       
14     response.setCharacterEncoding("UTF-8");  
15 /       response.setHeader("content-type", "application/json");  
16       
17     response.getWriter().print(value);  
18     response.getWriter().close();  
19 }

這個時候發現，不指定contentType狀況下，服務器拋出異常：

org.springframework.web.HttpMediaTypeNotSupportedException: Content type 'application/x-www-form-urlencoded;charset=UTF-8' not supported

緣由很簡單，咱們準備的數據時string格式的，同時ajax默認提交時告訴服務器數據格式是 "'application/x-www-form-urlencoded"，服務器調用相關的Converter解析的時候發現解析不了（由於咱們的數據格式實際上是json格式）。

這個時候加上：contentType: "application/json"，問題就解決了。

二、 dataType 的功能和用法：

dataType的功能：設定HttpHeader中「Accept」域的內容，告訴服務器瀏覽器能夠想要返回的數據格式類型，同時JQuery也會根據該類型對返回的數據進行相應的格式轉換。

測試條件：服務器端採用下面代碼直接返回json格式的字符串。

1 String value = "{'userName':'中文', 'password':'123'}";  
2       
3     response.setCharacterEncoding("UTF-8");  
4   
5     response.getWriter().print(value);  
6     response.getWriter().close();

dataType 設定爲「json」格式時

1 $.ajax({  
2             type: "POST",  
3             url : "<%=webProject%>/register",  
4             data: JSON.stringify(params),  
5             success: successFun,  
6             error: errorFun  
7             //contentType: "application/json",  
8             dataType: "json"              
9         });

能夠正確的打印 alert("userName="+data.userName); data.userName javascript直接訪問屬性的方式。說明JQuery自動把返回的字符串轉化爲javascript對象了。

dataType 不設定的狀況下：

1 $.ajax({  
2             type: "POST",  
3             url : "<%=webProject%>/register",  
4             data: JSON.stringify(params),  
5             success: successFun,  
6             error: errorFun  
7             //contentType: "application/json",  
8             //dataType: "json"            
9         });

打印出來的 alert("userName="+undefined) 說明JQuery沒有對返回的數據進行轉換。

二、jQuery Ajax 事件

Ajax請求會產生若干不一樣的事件，咱們能夠訂閱這些事件並在其中處理咱們的邏輯。在jQuery這裏有兩種Ajax事件：局部事件和全局事件。

局部事件就是在每次的Ajax請求時在方法內定義的，例如：

1 $.ajax({
2  beforeSend: function(){
3  // Handle the beforeSend event }, complete: function(){
4  // Handle the complete event } // ... });

全局事件是每次的Ajax請求都會觸發的，它會向DOM中的全部元素廣播，在上面 getScript() 示例中加載的腳本就是全局Ajax事件。全局事件能夠以下定義：

1 $("#loading").bind("ajaxSend", function(){
2  $(this).show();
3  }).bind("ajaxComplete", function(){
4  $(this).hide();
5  });

或者：

1  $("#loading").ajaxStart(function(){
2  $(this).show();
3  });

咱們能夠在特定的請求將全局事件禁用，只要設置下 global 選項就能夠了：

1 $.ajax({
2  url: "test.html",
3  global: false,// 禁用全局Ajax事件. // ... });

下面是jQuery官方給出的完整的Ajax事件列表：

ajaxStart (Global Event)
This event is broadcast if an Ajax request is started and no other Ajax requests are currently running.
- beforeSend (Local Event)
  This event, which is triggered before an Ajax request is started, allows you to modify the XMLHttpRequest object (setting additional headers, if need be.)
- ajaxSend (Global Event)
  This global event is also triggered before the request is run.
- success (Local Event)
  This event is only called if the request was successful (no errors from the server, no errors with the data).
- ajaxSuccess (Global Event)
  This event is also only called if the request was successful.
- error (Local Event)
  This event is only called if an error occurred with the request (you can never have both an error and a success callback with a request).
- ajaxError (Global Event)
  This global event behaves the same as the local error event.
- complete (Local Event)
  This event is called regardless of if the request was successful, or not. You will always receive a complete callback, even for synchronous requests.
- ajaxComplete (Global Event)
  This event behaves the same as the complete event and will be triggered every time an Ajax request finishes.

3. jQuery.get(url, [data], [callback], [type])：使用GET方式來進行異步請求

參數：

url (String) : 發送請求的URL地址.

data (Map) : (可選) 要發送給服務器的數據，以 Key/value 的鍵值對形式表示。

callback (Function) : (可選) 載入成功時回調函數(只有當Response的返回狀態是success纔是調用該方法)。

type (String) : (可選)官方的說明是：Type of data to be sent。其實應該爲客戶端請求的類型(JSON,XML,等等)

這是一個簡單的 GET 請求功能以取代複雜 $.ajax 。請求成功時可調用回調函數。若是須要在出錯時執行函數，請使用 $.ajax。示例代碼：

1  $.get("./Ajax.aspx", {Action:"get",Name:"lulu"}, function (data, textStatus){
2  //返回的 data 能夠是 xmlDoc, jsonObj, html, text, 等等. this; // 在這裏this指向的是Ajax請求的選項配置信息，請參考下圖 alert(data);
3  //alert(textStatus);//請求狀態：success，error等等。
4  固然這裏捕捉不到error，由於error的時候根本不會運行該回調函數 //alert(this); });

點擊發送請求：

jQuery.get()回調函數裏面的 this ，指向的是Ajax請求的選項配置信息：

4. jQuery.post( url, [data], [callback], [type] ) ：使用POST方式來進行異步請求

參數：

url (String) : 發送請求的URL地址.

data (Map) : (可選) 要發送給服務器的數據，以 Key/value 的鍵值對形式表示。

callback (Function) : (可選) 載入成功時回調函數(只有當Response的返回狀態是success纔是調用該方法)。

type (String) : (可選)官方的說明是：Type of data to be sent。其實應該爲客戶端請求的類型(JSON,XML,等等)

這是一個簡單的 POST 請求功能以取代複雜 $.ajax 。請求成功時可調用回調函數。若是須要在出錯時執行函數，請使用 $.ajax。示例代碼：

Ajax.aspx：

1 Response.ContentType = "application/json";
2  Response.Write("{result: '" + Request["Name"] + ",你好！(這消息來自服務器)'}");
3 jQuery 代碼：
4 $.post("Ajax.aspx", { Action: "post", Name: "lulu" },
5  function (data, textStatus){
6  // data 能夠是 xmlDoc, jsonObj, html, text, 等等. //this; // 這個Ajax請求的選項配置信息，請參考jQuery.get()說到的this alert(data.result);
7  }, "json");

點擊提交：

這裏設置了請求的格式爲"json"：

若是你設置了請求的格式爲"json"，此時你沒有設置Response回來的ContentType 爲：Response.ContentType = "application/json"; 那麼你將沒法捕捉到返回的數據。

注意一下，alert(data.result); 因爲設置了Accept報頭爲「json」，這裏返回的data就是一個對象，並不須要用eval()來轉換爲對象。

其中很大一部分是第一篇文章做者的貢獻，在此對你的辛勤勞動表示感謝。

參考文獻：

一、http://www.cnblogs.com/yeer/archive/2009/07/23/1529460.html

二、http://code.jquery.com/jquery-1.7.2.js
ajaxStop (Global Event)
This global event is triggered if there are no more Ajax requests being processed.
具體的全局事件請參考API文檔。