$.ajax()方法引數詳解

李路平發表於2014-07-03

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);

                      }

         });

    });

});

 

 

 

 

相關文章