DIV CSS 佈局教程網

jQuery 的 $.post 與 $.ajax 用法對照:參數、回呼與型別設定
編輯:JavaScript綜合知識     

jQuery 提供多種 Ajax 呼叫方式,其中 $.ajax 是底層實作,$.post 與 $.get 則是包好的高階捷徑。本文把兩者的參數與適用時機整理成對照說明。若你對 JavaScript 與 Ajax 概念還不熟,建議先打好基礎再往下讀。

$.ajax(options):完整控制

這是 jQuery 的底層 Ajax 實作,回傳它建立的 XMLHttpRequest 物件。在大多數情況下你不需要直接操作這個物件,但特殊情境下可以用它手動中止請求。

一個要特別注意的點:如果指定了 dataType,請確認伺服器回傳正確的 MIME 型別(例如 XML 要回 text/xml),錯誤的 MIME 會導致難以預料的錯誤。另外,當 dataType 設為 'script' 時,所有跨域的 POST 請求都會被轉成 GET。

自 jQuery 1.2 起可以跨域載入 JSON 資料,做法是使用 JSONP:把型別設為 jsonp,並在網址中寫成 "myurl?callback=?",jQuery 會自動把 ? 換成正確的函式名。

參數清單

  • url(String):請求位址,預設為目前頁面網址。
  • type(String):請求方式,可用 "POST" 或 "GET",預設 GET。PUT、DELETE 也可使用,但僅部分瀏覽器支援。
  • timeout(Number):逾時毫秒數,會覆蓋全域設定。
  • async(Boolean):預設 true(非同步)。設為 false 會鎖住瀏覽器,使用者的其他操作必須等請求完成,一般不建議。
  • beforeSend(Function):送出前可修改 XHR 物件,例如加上自訂 HTTP 標頭。此函式回傳 false 可取消請求。
  • cache(Boolean):是否使用瀏覽器快取,預設 true。開發階段建議設為 false,否則除錯時常會拿到舊資料。
  • complete(Function):請求完成後(不論成功或失敗)呼叫。
  • contentType(String):送出內容的編碼型別,預設 application/x-www-form-urlencoded,適合大多數情況。
  • data(Object/String):要送出的資料,會自動轉成 query string 格式。GET 時附加在網址後。若為陣列,jQuery 會自動用多組同名參數表示,例如 {foo:["bar1","bar2"]} 轉為 &foo=bar1&foo=bar2。
  • dataType(String):伺服器回傳的資料型別,不指定則由 jQuery 依 MIME 自動判斷。可選值:xml、html(可含 script)、script(不會被快取)、json、jsonp。
  • error(Function):請求失敗時呼叫,有三個參數:XHR 物件、錯誤訊息、(可能的)錯誤物件。
  • global(Boolean):是否觸發全域 Ajax 事件(如 ajaxStart、ajaxStop),預設 true。
  • ifModified(Boolean):僅在資料有變動時才取新資料,依賴 Last-Modified 標頭,預設 false。
  • processData(Boolean):預設 true,會把 data 轉成 query string。若要送出 DOM 樹或其他不該被轉換的內容,設為 false。
  • success(Function):成功後呼叫,參數為伺服器回傳資料與狀態字串。

回呼函式簽名

// beforeSend
function (XMLHttpRequest) {
    this; // 此次請求的 options
}

// complete
function (XMLHttpRequest, textStatus) {
    this; // 此次請求的 options
}

// error
function (XMLHttpRequest, textStatus, errorThrown) {
    // 通常 textStatus 與 errorThrown 只有一個有值
    this; // 此次請求的 options
}

// success
function (data, textStatus) {
    // data 可能是 xmlDoc、jsonObj、html、text...
    this; // 此次請求的 options
}

$.ajax 實際範例

$.ajax({
    type: 'get',
    url: 'https://www.example.com/rss',
    beforeSend: function (XMLHttpRequest) {
        // ShowLoading();
    },
    success: function (data, textStatus) {
        $('.ajax.ajaxResult').html('');
        $('item', data).each(function (i, domEle) {
            $('.ajax.ajaxResult').append('<li>' + $(domEle).children('title').text() + '</li>');
        });
    },
    complete: function (XMLHttpRequest, textStatus) {
        // HideLoading();
    },
    error: function () {
        // 請求出錯處理
    }
});

$.post(url, [data], [callback], [type])

用 POST 方式發送非同步請求,是 $.ajax 的簡化版:

  • url (String):請求的 URL。
  • data (Map):可選。要送出的資料,key/value 形式,也可以直接放進網址。
  • callback (Function):可選。只有在 Response 狀態為 success 時才會呼叫。
  • type (String):可選。指定回傳資料的型別(JSON、XML 等)。
$.post('ajax.php', { Action: "post", Name: "lulu" }, function (data, textStatus) {
    // data 可能是 xmlDoc、jsonObj、html、text
    alert(data.result);
}, "json");

如果需要在出錯時做處理,就得改用 $.ajax,因為 $.post 沒有 error 參數。

一個容易踩的坑

當你把請求格式設為 json,伺服器端就必須把 Content-Type 設為 application/json,否則前端拿不到資料。另外因為已經宣告 Accept 為 json,jQuery 會自動把回應解析成物件,不需要再用 eval()——用 eval 解析 JSON 除了多餘,還有安全性風險,應一律改用 JSON.parse() 或直接依賴 jQuery 的自動解析。

最後補充:jQuery 3.x 已把 success / error / complete 這些選項標記為 deprecated,建議改用 $.ajax().done().fail().always() 或 await 搭配 Promise 的寫法。

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