JQuery中$.ajax()方法參數詳解

標籤：判斷   app   urlencode   tin   response   content   將不   text   get請求   

原文地址：http://blog.sina.com.cn/s/blog_4f925fc30100la36.html

 

url: 要求為String類型的參數，（預設為當前頁地址）發送請求的地址。

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

timeout: 要求為Number類型的參數，佈建要求逾時時間（毫秒）。此設定將覆蓋$.ajaxSetup()方法的全域設置。

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

cache：要求為Boolean類型的參數，預設為true（當dataType為script時，預設為false）。設定為false將不會從瀏覽器緩衝中載入請求資訊。

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

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：返回純文字字串。

beforeSend：要求為Function類型的參數，發送請求前可以修改XMLHttpRequest對象的函數，例如添加自訂HTTP頭。在beforeSend中如果返回false可以取消本次ajax請求。XMLHttpRequest對象是惟一的參數。

           function(XMLHttpRequest){

              this;   //調用本次ajax請求時傳遞的options參數

           }

complete：要求為Function類型的參數，請求完成後調用的回呼函數（請求成功或失敗時均調用）。參數：XMLHttpRequest對象和一個描述成功請求類型的字串。

         function(XMLHttpRequest, textStatus){

            this;    //調用本次ajax請求時傳遞的options參數

         }

success：要求為Function類型的參數，請求成功後調用的回呼函數，有兩個參數。

        (1)由伺服器返回，並根據dataType參數進行處理後的資料。

        (2)描述狀態的字串。

        function(data, textStatus){

           //data可能是xmlDoc、jsonObj、html、text等等

           this;  //調用本次ajax請求時傳遞的options參數

error：要求為Function類型的參數，請求失敗時被調用的函數。該函數有3個參數，即XMLHttpRequest對象、錯誤資訊、捕獲的錯誤對象(可選)。

      ajax事件函數如下：

      function(XMLHttpRequest, textStatus, errorThrown){

         //通常情況下textStatus和errorThrown只有其中一個包含資訊

         this;   //調用本次ajax請求時傳遞的options參數

      }

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

dataFilter：要求為Function類型的參數，給Ajax返回的未經處理資料進行預先處理的函數。提供data和type兩個參數。data是Ajax返回的未經處理資料，type是調用jQuery.ajax時提供的dataType參數。函數返回的值將由jQuery進一步處理。

           function(data, type){

               //返回處理後的資料

               return data;

           }

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

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

jsonp：要求為String類型的參數，在一個jsonp請求中重寫回呼函數的名字。該值用來替代在"callback=?"這種GET或POST請求中URL參數裡的"callback"部分，例如 {jsonp:‘onJsonPLoad‘}會導致將"onJsonPLoad=?"傳給伺服器。

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

password：要求為String類型的參數，用於響應HTTP訪問認證請求的密碼。

processData：要求為Boolean類型的參數，預設為true。預設情況下，發送的資料將被轉換為對象（從技術角度來講並非字串）以配合預設內容類型"application/x-www-form-urlencoded"。如果要發送DOM樹資訊或者其他不希望轉換的資訊，請設定為false。

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

 

案例代碼：

$(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 += ‘<div class="comment"><h6>‘ + comment[‘username‘]

                                        + ‘:</h6><p class="para"‘ + comment[‘content‘]

                                        + ‘</p></div>‘;

                        });

                        $(‘#resText‘).html(html);

                     }

        });

   });

});

 

順便說一下$.each()函數:

$.each()函數不同於JQuery對象的each()方法，它是一個全域函數，不操作JQuery對象，而是以一個數組或者對象作為第1個參數，以一個回呼函數作為第2個參數。回呼函數擁有兩個參數：第1個為對象的成員或數組的索引，第2個為對應變數或內容。

 

 

 

JQuery中$.ajax()方法參數詳解