DIV CSS 佈局教程網

jQuery Ajax 全解析:從簡便方法到 $.ajax 完整參數
編輯:JQuery特效代碼     

jQuery 確實是個很不錯的輕量級 JS 框架,能幫助我們快速開發 JS 應用,也在一定程度上改變了我們寫 JavaScript 的習慣。

廢話少說,先來看幾個對 jQuery.ajax() 做封裝以便使用的方法;若要處理複雜邏輯,还是得回到 jQuery.ajax()(後面會說明)。

1. load( url, [data], [callback] ):載入遠端 HTML 並插入 DOM

參數:

  • url (String):請求的 HTML 頁 URL 位址。
  • data (Map):可選,發送到伺服器的 key/value 資料。
  • callback (Callback):可選,請求完成時的回呼函式(不一定要成功)。

這個方法預設用 GET 傳遞,一旦傳入了 data 就會自動轉為 POST。jQuery 1.2 起可以指定選擇器來篩選載入的 HTML,DOM 中只插入篩選出的部分,語法形如 "url #some > selector"。用它動態載入表單等 HTML 片段非常方便。

$(".ajax.load").load("https://www.cnblogs.com/QLeelulu/archive/2008/03/30/1130270.html .post",
function (responseText, textStatus, XMLHttpRequest){
    this;   // 這裡 this 指向目前的 DOM 物件,即 $(".ajax.load")[0]
    // alert(responseText);   // 請求返回的內容
    // alert(textStatus);     // 請求狀態:success、error
    // alert(XMLHttpRequest); // XMLHttpRequest 物件
});

註:URL 寫絕對路徑在 Firefox 下會出錯。下面的 get() 與 post() 範例使用絕對路徑且屬跨域呼叫,因此貼到線上後抓不到結果,故移除了執行按鈕。

2. jQuery.get( url, [data], [callback] ):以 GET 方式非同步請求

參數:

  • url (String):發送請求的 URL。
  • data (Map):可選,要送給伺服器的資料,以 key/value 表示,會作為 QueryString 附加到 URL 後。
  • callback (Function):可選,載入成功時的回呼函式(只有 Response 狀態為 success 才會呼叫)。

這是取代繁複 $.ajax 的簡便 GET 請求;若需要在出錯時處理,請改用 $.ajax。

$.get("./Ajax.aspx", {Action:"get", Name:"lulu"}, function (data, textStatus){
    // 返回的 data 可以是 xmlDoc、jsonObj、html、text 等
    this;   // 這裡 this 指向 Ajax 請求的選項設定資訊
    alert(data);
    // alert(textStatus);   // 請求狀態:success、error 等
    // 這裡捕捉不到 error,因為出錯時根本不會執行該回呼函式
});

jQuery.get() 回呼函式裡的 this 指向 Ajax 請求的選項設定資訊:

3. jQuery.post( url, [data], [callback], [type] ):以 POST 方式非同步請求

參數:

  • url (String):發送請求的 URL。
  • data (Map):可選,要送給伺服器的 key/value 資料。
  • callback (Function):可選,載入成功時的回呼函式。
  • type (String):可選,官方說明是「Type of data to be sent」,實際上應指用戶端期望的資料類型(JSON、XML 等)。

伺服器端(Ajax.aspx):

Response.ContentType = "application/json";
Response.Write("{result: '" + Request["Name"] + ",你好!(這消息來自伺服器)'}");

jQuery 端:

$.post("Ajax.aspx", { Action: "post", Name: "lulu" },
    function (data, textStatus){
        // data 可以是 xmlDoc、jsonObj、html、text 等
        alert(data.result);
    }, "json");

這裡把請求格式設為 "json":

重要提醒:設定了 "json" 卻沒有在伺服器端設定 Response.ContentType = "application/json",你將無法接收到返回的資料。另外因為設了 Accept 報頭為 json,這裡的 data 已經是物件,不需要再用 eval() 轉換。

4. jQuery.getScript( url, [callback] ):載入並執行 JavaScript 檔

參數:

  • url (String):待載入的 JS 檔位址。
  • callback (Function):可選,成功載入後的回呼函式。

jQuery 1.2 之前,getScript 只能呼叫同域 JS 檔;1.2 起可以跨域呼叫。注意 Safari 2 或更早版本無法在全域作用域中同步執行腳本,若用 getScript 加入腳本請加上延時函式。

這個方法可以用在「只有編輯器 focus() 時才去載入所需的 JS 檔」這類延遲載入情境:

// 載入並執行 test.js
$.getScript("test.js");

// 載入並執行 AjaxEvent.js,成功後顯示訊息
$.getScript("AjaxEvent.js", function(){
    alert("AjaxEvent.js 載入完成並執行完成。你再點擊上面的 Get 或 Post 按鈕看看有什麼不同?");
});

jQuery Ajax 事件

Ajax 請求會產生若干事件,我們可以訂閱這些事件在其中處理邏輯。jQuery 有兩種 Ajax 事件:局部事件與全域事件。

局部事件在每次請求的方法內定義:

$.ajax({
    beforeSend: function(){
        // Handle the beforeSend event
    },
    complete: function(){
        // Handle the complete event
    }
    // ...
});

全域事件則每次 Ajax 請求都會觸發,並向 DOM 中的所有元素廣播:

$("#loading").bind("ajaxSend", function(){
    $(this).show();
}).bind("ajaxComplete", function(){
    $(this).hide();
});

// 或者
$("#loading").ajaxStart(function(){
    $(this).show();
});

可以在特定請求中停用全域事件,只要設定 global 選項:

$.ajax({
    url: "test.html",
    global: false,   // 停用全域 Ajax 事件
    // ...
});

jQuery 官方完整的 Ajax 事件列表:

  • ajaxStart(全域):當 Ajax 請求啟動且沒有其他請求正在執行時廣播。
  • beforeSend(局部):請求啟動前觸發,可修改 XMLHttpRequest 物件(例如加上自訂 HTTP 標頭)。
  • ajaxSend(全域):同樣在請求執行前觸發。
  • success(局部):僅在請求成功(伺服器無錯誤、資料無錯誤)時呼叫。
  • ajaxSuccess(全域):同樣僅在請求成功時呼叫。
  • error(局部):僅在請求發生錯誤時呼叫(一次請求不可能同時有 error 與 success)。
  • ajaxError(全域):行為等同局部 error 事件。
  • complete(局部):不論成功或失敗都會呼叫,即使是同步請求也一樣。
  • ajaxComplete(全域):等同 complete 事件,每次請求結束都觸發。
  • ajaxStop(全域):當沒有更多 Ajax 請求正在處理時觸發。

jQuery.ajax( options ):最底層也最強大的請求方法

這是 jQuery 的底層 AJAX 實作,簡單易用的高層實作則是 $.get、$.post 等。$.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,預設:"GET")請求方式,"POST" 或 "GET"。其他 HTTP 方法如 PUT、DELETE 也可用,但僅部分瀏覽器支援。
  • timeout(Number)請求逾時時間(毫秒),此設定會覆蓋全域設定。
  • async(Boolean,預設:true)預設所有請求皆為非同步。若要發送同步請求請設為 false。注意同步請求會鎖住瀏覽器,使用者其他操作必須等請求完成才能執行。
  • beforeSend(Function)發送前可修改 XMLHttpRequest 物件的函式,如加上自訂 HTTP 標頭。XMLHttpRequest 是唯一參數。
    function (XMLHttpRequest) { this; // the options for this ajax request }
  • cache(Boolean,預設:true)jQuery 1.2 新功能,設為 false 將不會從瀏覽器快取載入請求資訊。
  • complete(Function)請求完成後的回呼函式(成功或失敗都會呼叫)。參數為 XMLHttpRequest 物件與成功資訊字串。
    function (XMLHttpRequest, textStatus) { this; // the options for this ajax request }
  • contentType(String,預設:"application/x-www-form-urlencoded")發送資訊至伺服器時的內容編碼類型,預設值適合大多數場合。
  • data(Object 或 String)發送到伺服器的資料,會自動轉為請求字串格式,GET 請求時附加在 URL 後。必須為 key/value 格式;若是陣列,jQuery 會自動為不同值對應同一名稱,如 {foo:["bar1", "bar2"]} 轉為 '&foo=bar1&foo=bar2'。若要禁止自動轉換,請看 processData 選項。
  • dataType(String)預期伺服器回傳的資料類型。不指定時 jQuery 會依 HTTP 回應的 MIME 自動判斷傳入 responseXML 或 responseText。可用值:
    • "xml":回傳 XML 文件,可用 jQuery 處理。
    • "html":回傳純文字 HTML 資訊,包含 script 元素。
    • "script":回傳純文字 JavaScript 程式碼,不會自動快取結果。
    • "json":回傳 JSON 資料。
    • "jsonp":JSONP 格式,jQuery 會自動替換 ? 為正確的函式名以執行回呼。
  • error(Function)請求失敗時呼叫。三個參數:XMLHttpRequest 物件、錯誤資訊、(可能的)捕獲的錯誤物件。
    function (XMLHttpRequest, textStatus, errorThrown) {
        // 通常情況下 textStatus 和 errorThrown 只有其中一個有值
        this; // the options for this ajax request
    }
  • global(Boolean,預設:true)是否觸發全域 AJAX 事件。設為 false 則不觸發 ajaxStart、ajaxStop 等,可用於控制不同 Ajax 事件。
  • ifModified(Boolean,預設:false)僅在伺服器資料改變時才取得新資料,透過 HTTP 的 Last-Modified 標頭判斷。
  • processData(Boolean,預設:true)預設會把送出的資料轉為物件以配合預設內容類型。若要發送 DOM 樹或不希望被轉換的資訊,請設為 false。
  • success(Function)請求成功後的回呼函式,兩個參數:伺服器回傳資料與回傳狀態。
    function (data, textStatus) {
        // data could be xmlDoc, jsonObj, html, text, etc...
        this; // the options for this ajax request
    }

這裡的四個事件參數——beforeSend、success、complete、error——讓我們能完善地處理每一次請求。請注意這些回呼裡的 this 都指向該次 Ajax 請求的選項設定資訊。若要用 jQuery 做 Ajax 開發,上面這些參數都必須熟悉。

完整範例:抓取某網站的文章標題

$.ajax({
    type: "get",
    url: "https://www.cnblogs.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(){
        // 請求出錯處理
    }
});

其他工具方法

jQuery.ajaxSetup( options ):設定全域 Ajax 預設選項

把預設請求位址設為 "/xmlhttp/"、停用全域事件、並用 POST 取代預設 GET,之後的請求就不必再重複設定:

$.ajaxSetup({
    url: "/xmlhttp/",
    global: false,
    type: "POST"
});
$.ajax({ data: myData });

serialize() 與 serializeArray()

  • serialize():把表單內容序列化為字串。
  • serializeArray():序列化表單元素,回傳 JSON 資料結構。
<p id="results"><b>Results: </b> </p>
<form>
<select name="single">
<option>Single</option>
<option>Single2</option>
</select>
<select name="multiple" multiple="multiple">
<option selected="selected">Multiple</option>
<option>Multiple2</option>
<option selected="selected">Multiple3</option>
</select><br/>
<input type="checkbox" name="check" value="check1"/> check1
<input type="checkbox" name="check" value="check2" checked="checked"/> check2
<input type="radio" name="radio" value="radio1" checked="checked"/> radio1
<input type="radio" name="radio" value="radio2"/> radio2
</form>

serializeArray() 的結果為:

一些資源

  • jQuery 的 Ajax Form 表單外掛:https://www.malsup.com/jquery/form/
  • 專門產生 Loading 動畫圖的網站:https://ajaxload.info/
XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved