$.ajax()方法參數詳解


$.ajax()方法是jQuery最底層的Ajax實現。它的結構為:

  $.ajax(options)

該方法只有一個參數,但是這個對象里包含了$.ajax()方法所需要的請求設置以及回調函數等信息,參數以key/value的形式存在,所有的參數都是可選的。常用參數見下表:

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包的mine信息返回responseXML或responseText,並作為回調函數參數傳遞。可用的類型如下:

  xml:返回XML文檔,可用jQuery處理。

  html:返回純文本HTML信息;包含的script標簽會在插入DOM時執行。

  script:返回純文本javascript代碼。不會自動緩存結果,除非設置了cache參數。注意在遠程請求時(不在同一個域下),所有post請求都將轉為get請求。

  json:返回JSON數據。

  jsonp:JSON格式。使用JSONP形式調用函數時,例如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.global

要求為Boolean類型的參數,默認為true。表示是否觸發全局ajax事件。設置為false將不會觸發全局ajax事件,ajaxStart和ajaxStop可用於控制各種ajax事件。

15.ifModified

要求為Boolean類型的參數,默認為false。僅在服務器數據改變時獲取新數據。服務器數據改變判斷的依據是Last-Modified頭信息。默認值是false,即忽略頭信息。

16.jsonp

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

17.username

要求為String類型的參數,用於響應HTTP訪問認證請求的用戶。

18.password

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

19.processData

要求為Boolean類型的參數,默認為true。默認情況下,發送的數據將被轉換為對象(從技術角度來講而非字符串)以配合默認內容類型"application/x-www-form-urlencoded"。如果要發送DOM樹信息或者其他不希望轉換的信息,請設置為false。

20.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);
                      }
         });
    });
});

  

知識鏈接:

1、$.each()函數:$.each()函數不同於jQuery對象的each()方法,它是一個全局函數,不操作jQuery對象。該函數接收兩個參數,第1個參數是一個數組或對象,第2個參數是一個回調函數。回調函數擁有兩個參數:第1個參數為數組的索引或對象的成員,第2個參數為對應的變量或內容。

  $.each(data,function(commentIndex,comment){

           //doSomething;

      })

 

2、ajaxStart()與ajaxStop():當Ajax請求開始時,會觸發ajaxStart()方法的回調函數。當Ajax請求結束時,會觸發ajaxStop()方法的回調函數。這些方法都是全局的方法,因此無論創建它們的代碼位於何處,只要有Ajax請求發生時,就會觸發它們。

有時候頁面需要加載一些圖片,可能速度會比較慢,如果在加載過程中,不給用戶提供一些提示和反饋信息,很容易讓用戶誤認為按鈕單擊無用,使用戶對網站失去信息。

此時,我們就需要為網頁添加一個提示信息,常用的提示信息是“加載中...”,代碼如下:

<div id="loading">加載中...</div>

當Ajax請求開始時,將此元素顯示,用來提示用戶Ajax請求正在進行;當Ajax請求結束后,將此元素隱藏。代碼如下:

$("#loading").ajaxStart(function(){
    $(this).show();
  }).ajaxStop(function(){
       $(this).hide();
   })

 

  

 


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM