首頁 >web前端 >js教程 >關於$.ajax()方法參數詳解

關於$.ajax()方法參數詳解

jacklove原創: 2018-06-11 17:44:282050瀏覽

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類型的參數，傳送到伺服器的資料。如果已經不是字串，將自動轉換為字串格式。 get請求中將附加在url後。防止這種自動轉換，可以查看　　processData選項。物件必須為key/value格式，例如{foo1:"bar1",foo2:"bar2"}轉換為&foo1=bar1&foo2=bar2。如果是數組，JQuery將自動為不同值對應同一個名稱。例如{foo:["bar1","bar2"]}轉換為&foo=bar1&foo=bar2。

7.dataType:
要求為String類型的參數，預期伺服器傳回的資料類型。如果不指定，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類型的參數，請求成功後呼叫的回呼函數，有兩個參數。
(1)由伺服器傳回，並依據dataType參數處理後的資料。
(2)描述狀態的字串。

         function(data, textStatus){
            //data可能是xmlDoc、jsonObj、html、text等等
            this;  //调用本次ajax请求时传递的options参数
         }

11.error:
要求為Function類型的參數，請求失敗時被呼叫的函數。此函數有3個參數，分別是XMLHttpRequest物件、錯誤訊息、捕獲的錯誤物件(可選)。 ajax事件函數如下：

       function(XMLHttpRequest, textStatus, errorThrown){
          //通常情况下textStatus和errorThrown只有其中一个包含信息
          this;   //调用本次ajax请求时传递的options参数
       }

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.dataFilter：
要求為Function類型的參數，給Ajax傳回的原始資料進行預處理的函數。提供data和type兩個參數。 data是Ajax傳回的原始數據，type是呼叫jQuery.ajax時提供的dataType參數。函數傳回的值將由jQuery進一步處理。

            function(data, type){
                //返回处理后的数据
                return data;
            }

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

16.ifModified：
要求为Boolean类型的参数，默认为false。仅在服务器数据改变时获取新数据。服务器数据改变判断的依据是Last-Modified头信息。默认值是false，即忽略头信息。

17.jsonp：
要求为String类型的参数，在一个jsonp请求中重写回调函数的名字。该值用来替代在"callback=?"这种GET或POST请求中URL参数里的"callback"部分，例如{jsonp:'onJsonPLoad'}会导致将"onJsonPLoad=?"传给服务器。

18.username：
要求为String类型的参数，用于响应HTTP访问认证请求的用户名。

19.password：
要求为String类型的参数，用于响应HTTP访问认证请求的密码。

20.processData：
要求为Boolean类型的参数，默认为true。默认情况下，发送的数据将被转换为对象（从技术角度来讲并非字符串）以配合默认内容类型"application/x-www-form-urlencoded"。如果要发送DOM树信息或者其他不希望转换的信息，请设置为false。

21.scriptCharset：
要求为String类型的参数，只有当请求时dataType为"jsonp"或者"script"，并且type是GET时才会用于强制修改字符集(charset)。通常在本地和远程的内容编码不同时使用。

案例代码：

關於$.ajax()方法參數詳解

$(function(){
    $('#send').click(function(){
         $.ajax({
             type: "GET",
             url: "test.json",
             data: {username:$("#username").val(), content:$("#content").val()},
             dataType: "json",
             success: function(data){
                         $('#resText').empty();   //清空resText里面的所有内容
                         var html = ''; 
                         $.each(data, function(commentIndex, comment){
                               html += '<p></p><h6>' + comment['username']                                         + ':</h6><p></p>';
                         });
                         $('#resText').html(html);
                      }
         });
    });
});

22.顺便说一下$.each()函数:
$.each()函数不同于JQuery对象的each()方法，它是一个全局函数，不操作JQuery对象，而是以一个数组或者对象作为第1个参数，以一个回调函数作为第2个参数。回调函数拥有两个参数：第1个为对象的成员或数组的索引，第2个为对应变量或内容。

本文介绍了$.ajax()方法参数，更多相关内容请关注php中文网。

關於$.ajax()方法參數詳解

相關文章