DIV CSS 佈局教程網

jQuery $.ajax() 參數完整解析,每個欄位都講明白
編輯:JavaScript綜合知識     

$.ajax() 是 jQuery 做非同步請求的核心方法,參數多到有點嚇人。但其實常用的就那幾個,剩下的多半在特定情境才需要。以下依用途分類整理。

請求基本設定

  • url(String):請求位址,預設為目前頁面網址。
  • type(String):請求方式,post 或 get,預設 get。put、delete 等方法也可使用,但僅部分瀏覽器支援。
  • async(Boolean):預設 true 為非同步。設為 false 會鎖住瀏覽器,使用者所有操作都得等請求完成,除非有明確必要,不建議使用。
  • timeout(Number):逾時毫秒數,會覆蓋 $.ajaxSetup() 的全域設定。
  • cache(Boolean):預設 true(dataType 為 script 時預設 false)。設為 false 可避免讀取瀏覽器快取。
  • contentType(String):送出資料的編碼類型,預設 application/x-www-form-urlencoded,絕大多數情況都用這個就好。

資料與回傳格式

data 可傳 Object 或 String。傳物件時 jQuery 會自動轉成查詢字串:{foo1:"bar1", foo2:"bar2"} 變成 &foo1=bar1&foo2=bar2;陣列值則會產生同名多值,例如 {foo:["bar1","bar2"]} 轉為 &foo=bar1&foo=bar2。get 請求時會附加在 url 後面。

dataType 是預期伺服器回傳的型別,不指定則由 jQuery 依 HTTP 的 mime 資訊自行判斷:

  • xml:回傳 XML 文件,可直接用 jQuery 查詢。
  • html:純文字 HTML,插入 DOM 時其中的 script 標籤會被執行。
  • script:純文字 JavaScript,結果預設不快取。跨網域時所有 post 都會被轉成 get。
  • json:JSON 資料。
  • jsonp:JSONP 格式,用於跨網域。像 myurl?callback=? 這樣呼叫時,jQuery 會自動把最後那個問號替換成正確的函式名。
  • text:純文字字串。

回呼函式

beforeSend: function(XMLHttpRequest){ /* 可改寫 header,return false 可取消請求 */ },
complete  : function(XMLHttpRequest, textStatus){ /* 成功或失敗都會呼叫 */ },
success   : function(data, textStatus){ /* 僅成功時呼叫 */ },
error     : function(XMLHttpRequest, textStatus, errorThrown){ /* 僅失敗時呼叫 */ }

每個回呼裡的 this 都指向本次 ajax 呼叫時傳入的 options 物件,這個特性在混用多個請求時很好用。

其他進階參數

  • dataFilter:對回傳的原始資料做前處理,接收 data 與 type 兩個參數,回傳值會再交給 jQuery 處理。
  • global:預設 true,是否觸發全域 ajax 事件(ajaxStart、ajaxStop 等)。
  • ifModified:僅在伺服器資料有變動時才取新資料,判斷依據是 Last-Modified 標頭。
  • jsonp:覆寫 jsonp 請求中的回呼函式名稱。
  • username / password:回應 HTTP 驗證時使用。
  • processData:預設 true 會把資料轉成字串。要傳 DOM 樹或其他不想被轉換的內容時設為 false。
  • scriptCharset:僅在 dataType 為 jsonp 或 script 且 type 為 GET 時生效,用於強制指定字元集。

實戰範例

$(function(){
  $('#send').click(function(){
    $.ajax({
      type: "GET",
      url: "test.json",
      data: { username: $("#username").val(), content: $("#content").val() },
      dataType: "json",
      success: function(data){
        $('#resText').empty();
        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 物件,而是以陣列或物件當第一個參數、回呼函式當第二個參數。回呼的兩個參數分別是成員索引(或鍵名)與對應的值。

XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved