DIV CSS 佈局教程網

從零開始學 jQuery(六):Ajax 使用的完整圖解
編輯:JQuery特效代碼     

一、摘要

本系列文章帶你進入 jQuery 的世界,其中有許多具體的實務經驗與解法,即使你已熟悉 jQuery,閱讀時仍可能發現一些眉角。本篇講解如何用 jQuery 便利地實作 Ajax,並統一團隊中所有開發者的呼叫方式。

二、前言

Ajax 讓頁面更豐富、使用者體驗更好,是所有 Web 開發的必修課。Ajax 技術本身不複雜,但每個人的實作方式往往各異。jQuery 提供了一整套 Ajax 函式來抹平這些差異,也讓呼叫變得簡單。

三、原生 Ajax 與 jQuery 的 Ajax

先看一個使用原生 Ajax 的例子:


<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="https://www.w3.org/1999/xhtml">
<head>
<title>jQuery Ajax</title>
<script type="text/javascript">
$(function() {
$("#btnAjaxOld").click(function(event) {
var xhr = new AjaxXmlHttpRequest();
xhr.onreadystatechange = function() {
if (xhr.readyState == 4) {
document.getElementById("divResult").innerHTML = xhr.responseText;
}
}
xhr.open("GET", "data/AjaxGetCityInfo.aspx?resultType=html", true);
xhr.send(null); })
//跨瀏覽器獲取XmlHttpRequest物件
function AjaxXmlHttpRequest() {
var xmlHttp;
try {
xmlHttp = new XMLHttpRequest();
} catch (e) {
try {
xmlHttp = new ActiveXObject("Msxml2.XMLHTTP");
} catch (e) {
try {
xmlHttp = new ActiveXObject("Microsoft.XMLHTTP");
} catch (e) {
alert("您的瀏覽器不支持AJAX!");
return false;
}
}
}
return xmlHttp;
}
</script>
</head>
<body>
<button id="btnAjaxOld">原始Ajax調用</button><br />
<div id="divResult"></div>
</body>
</html>

用原生 Ajax,我們得做不少事:建立 XmlHttpRequest 物件、判斷請求狀態、撰寫回呼函式。而用 jQuery 的 load 方法,只需要一句:


$("#divResult").load("data/AjaxGetCityInfo.aspx", { "resultType": "html" });

我曾經是原生 Ajax 的絕對擁護者,甚至屏棄微軟的 ASP.NET Ajax,因為我想要最高的程式碼靈活度。但當我去翻閱並修改別人的 Ajax 程式碼時,我改變了看法——我們的程式碼到處分布著建立 XmlHttpRequest 的函式,某些 Ajax 程式的結構性很差,很難看懂。

我們可以把通用方法集中到一個 js 檔,然後告訴大家「都來用這個」。但有時新加入的人員并不知道這個檔案的存在。何況這個通用檔本質上就是一個公共腳本類庫——我相信沒有人會覺得自己開發的類庫會比 jQuery 更好。

於是我放棄了自製輪子的計畫。大家都用 jQuery 撰寫 Ajax,差異問題自然消失,效率也更高。現在我的頁面變得簡潔:


$(function() {
$("#btnAjaxJquery").click(function(event) {
$("#divResult").load("data/AjaxGetCityInfo.aspx", { "resultType": "html" });
});
})

四、jQuery Ajax 詳解

jQuery 提供數個發送 Ajax 請求的函式。其中最核心也最複雜的是 jQuery.ajax( options ),其他所有 Ajax 函式都是它的簡化呼叫。需要完全控制時用它,否則用 get、post、load 等簡化方法更方便。以下由簡入繁。

1. load( url, [data], [callback] )

load 能載入遠端 HTML 並插入 DOM。預設使用 GET,若傳遞了 data 參數則自動改為 POST。jQuery 1.2 起可指定選擇器來過濾載入的 HTML,語法形如 "url #some > selector",預設選擇器是 "body>*"。

使用限制有兩點:主要用於直接回傳 HTML 的介面;它是 jQuery 包裝集方法,必須在包裝集上呼叫,且會把回傳的 HTML 載入到該物件中,即使設了回呼也一樣會載入。


$(function() {
$("#btnAjaxGet").click(function(event) {
$("#divResult").load("../data/AjaxGetMethod.aspx?param=btnAjaxGet_click" + "×tamp=" + (new Date()).getTime());
});
$("#btnAjaxPost").click(function(event) {
$("#divResult").load("../data/AjaxGetMethod.aspx", { "param": "btnAjaxPost_click" });
});
$("#btnAjaxCallBack").click(function(event) {
$("#divResult").load("../data/AjaxGetMethod.aspx", { "param": "btnAjaxCallBack_click" }, function(responseText, textStatus, XMLHttpRequest) {
responseText = " Add in the CallBack Function! <br/>" + responseText
$("#divResult").html(responseText);
});
});
$("#btnAjaxFiltHtml").click(function(event) {
$("#divResult").load("../data/AjaxGetCityInfo.aspx?resultType=html" + "×tamp=" + (new Date()).getTime() + " ul>li:not(:contains('鞍山'))");
});
})

提示:使用 GET 時務必加上時間戳參數 (new Date()).getTime(),讓每次發送的 URL 都不同,可避免瀏覽器快取。

提示:若在 url 參數後多了一個空格,會出現「無法識別符號」的錯誤——請求仍能送出,但 HTML 無法載入到 DOM。刪掉空格即可。

2. jQuery.get( url, [data], [callback], [type] )

透過 HTTP GET 載入資訊。請求成功時可呼叫回呼;若需要在出錯時執行函式,請直接用 $.ajax。

參數可以直接拼在 url 上:


$.get("../data/AjaxGetMethod.aspx?param=btnAjaxGet_click");

或透過 data 參數傳遞,jQuery 會自動附加到 url:


$.get("../data/AjaxGetMethod.aspx", { "param": "btnAjaxGet2_click" });

兩者效果相同;但若 url 與 data 中有同名參數,不會自動合併。

回呼函式的簽名如下:


function (data, textStatus) {
// data 可能是 xmlDoc、jsonObj、html、text 等
// this 指向本次請求的 options 物件
}

textStatus 可能是 "timeout"、"error"、"notmodified"、"success"、"parsererror"。type 則可能是 "xml"、"html"、"script"、"json"、"jsonp"、"text",預設為 "html"。

jQuery.getJSON 就等同於 jQuery.get(url, [data], [callback], "json")。

3. jQuery.getJSON( url, [data], [callback] )

透過 HTTP GET 載入 JSON 資料。jQuery 1.2 起可用 JSONP 形式的回呼函式載入其他網域的 JSON 資料,寫成 "myurl?callback=?",jQuery 會自動把 ? 替換為正確的函式名。

getJSON 僅是把 type 設為 JSON,因此在回呼中拿到的已經是解析後的物件:


$.getJSON("../data/AjaxGetCityInfo.aspx", { "resultType": "json" }, function(data, textStatus) {
alert(data.length);
alert(data[0].CityName);
});

伺服器端回傳的字串形如:


[{"pkid":"0997","ProvinceId":"XJ","CityName":"阿克苏","CityNameEn":"Akesu","PostCode":"843000","isHotCity":false},
{"pkid":"0412","ProvinceId":"LN","CityName":"鞍山","CityNameEn":"Anshan","PostCode":"114000","isHotCity":false}]

於是 data.length 是元素個數、data[0] 是第一項、data[0].CityName 是第一項的城市名稱。

4. jQuery.getScript( url, [callback] )

透過 HTTP GET 載入並執行一個 JavaScript 檔,等同 jQuery.get(url, null, [callback], "script")。

jQuery 1.2 之前,getScript 只能呼叫同域 JS 檔;1.2 之後可以跨域呼叫。它的內部實作並不使用 XHR,而是動態建立 script 標籤:


var head = document.getElementsByTagName("head")[0];
var script = document.createElement("script");
script.src = s.url;
head.appendChild(script);

腳本載入完畢後再從 head 中移除:


if ( !jsonp ) {
var done = false;
script.onload = script.onreadystatechange = function(){
if ( !done && (!this.readyState || this.readyState == "loaded" || this.readyState == "complete") ) {
done = true;
success();
complete();
script.onload = script.onreadystatechange = null;
head.removeChild( script );
}
};
}

我特別測試了跨域存取與多瀏覽器支援,結果如下:

  • 非跨域引用 js:IE6 與 Firefox 皆通過,回呼中的 data 與 textStatus 均可用。
  • 跨域引用 js:IE6 與 Firefox 皆通過,但回呼中的 data 與 textStatus 均為 undefined。

這也合理——用 script 標籤載入本來就拿不到內容主體,只能執行。測試語句如下:


$("#btnAjaxGetScript").click(function(event) {
$.getScript("../scripts/getScript.js", function(data, textStatus) {
alert(data);
alert(textStatus);
alert(this.url);
});
});
$("#btnAjaxGetScriptCross").click(function(event) {
$.getScript("https://resource.elong.com/getScript.js", function(data, textStatus) {
alert(data);
alert(textStatus);
alert(this.url);
});
});

5. jQuery.post( url, [data], [callback], [type] )

透過 HTTP POST 載入資訊,用法與 get 相同,只是提交方式改為 POST。同樣地,出錯時若要處理,請用 $.ajax。

6. jQuery.ajax( options )

這是 jQuery 的底層 AJAX 實作,前述所有方法最後都會呼叫它。$.ajax() 會回傳它建立的 XMLHttpRequest 物件,特殊情況下可用於手動中止請求。

它只有一個參數:包含各設定與回呼的 key/value 物件。幾個重要注意事項:

  • 若指定了 dataType,請確保伺服器回傳正確的 MIME 資訊(例如 xml 要回 "text/xml"),錯誤的 MIME 可能導致不可預期的錯誤。
  • 若 dataType 設為 "script",所有遠端(不在同一網域)的 POST 請求都會轉為 GET——因為它是用 DOM 的 script 標籤載入。
  • 跨域載入 JSON 時需將 dataType 設為 "jsonp",jQuery 會自動呼叫回呼函式。

五、Ajax 相關函式

1. jQuery.ajaxSetup( options )

設定全域的 AJAX 預設 options。此後所有 Ajax 請求的預設值都會被改變。


$.ajaxSetup({
url: "../data/AjaxGetMethod.aspx",
data: { "param": "ziqiu.zhang" },
global: false,
type: "POST",
success: function(data, textStatus) {
$("#divResult").html(data);
}
});

設定之後,可以用無參數的 get()、post() 或 ajax() 發送請求。注意:使用 get() 或 post() 時,除了 type 會被改寫為 GET/POST,其他未傳遞的選項都會沿用全域設定;若傳了某個選項(如 url 與參數),本次呼叫以傳入者為準,沒傳的(如回呼函式)仍使用全域值。

這個方法在團隊專案中特別有用——把統一的 url 前綴、錯誤處理、loading 遮罩都設在 ajaxSetup 裡,全站行為就一致了。但要留意它是全域生效,同一頁面若引入多個第三方套件,可能被互相影響;這種情況下改用 $.ajaxPrefilter 或自行包裝一個 request 函式會更安全。

2. serialize( )

序列化表單內容為字串,用於 Ajax 請求。序列化後的資料是標準格式,幾乎所有伺服器端語言都能解析。

要正常運作,被序列化的表單欄位必須有 name 屬性,只有 id 是無效的:


<input id="email" name="email" type="text" />

它的效果相當於讓表單以 GET 方式提交時,自動把欄位的名/值拼到 url 上。

產生的字串為:


single=Single&param=Multiple&param=Multiple3&check=check2&radio=radio1

3. serializeArray( )

序列化表單元素,回傳 JSON 資料結構。注意此方法回傳的是JSON 物件而非字串,需要額外做字串化。

jQuery 本身沒有提供 JSON 序列化方法,可以搭配 jquery-json 這類插件:


var thing = {plugin: 'jquery-json', version: 1.3};
var encoded = $.toJSON(thing);
//'{"plugin": "jquery-json", "version": 1.3}'
var name = $.evalJSON(encoded).plugin;
//"jquery-json"

兩者搭配使用,就能把表單物件轉為 JSON 字串:


$("#results").html( $.toJSON( $("form").serializeArray() ));

結果為:


[{"name": "single", "value": "Single"},
{"name": "param", "value": "Multiple"},
{"name": "param", "value": "Multiple3"},
{"name": "check", "value": "check2"},
{"name": "radio", "value": "radio1"}]

(編按:現代瀏覽器已內建 JSON.stringify(),不需要外加插件;序列化表單也可直接用 new FormData(form),並搭配 fetch 送出,程式碼更少。)

六、全域 Ajax 事件

在 ajaxSetup 的 options 中有一個 global 屬性(布林值,預設 true),用來設定是否觸發全域的 Ajax 事件。這了一系列伴隨 Ajax 請求的生命週期事件:

  • ajaxSend( callback )——請求發送前
  • ajaxStart( callback )——請求開始時
  • ajaxSuccess( callback )——請求成功時
  • ajaxError( callback )——請求發生錯誤時
  • ajaxComplete( callback )——請求完成時
  • ajaxStop( callback )——所有請求結束時

用一個範例觀察觸發順序:


$(document).ready(function() {
$("#btnAjax").bind("click", function(event) {
$.get("../data/AjaxGetMethod.aspx");
})
$("#divResult").ajaxComplete(function(evt, request, settings) {
$(this).append('<div>ajaxComplete</div>');
})
$("#divResult").ajaxError(function(evt, request, settings) {
$(this).append('<div>ajaxError</div>');
})
$("#divResult").ajaxSend(function(evt, request, settings) {
$(this).append('<div>ajaxSend</div>');
})
$("#divResult").ajaxStart(function() {
$(this).append('<div>ajaxStart</div>');
})
$("#divResult").ajaxStop(function() {
$(this).append('<div>ajaxStop</div>');
})
$("#divResult").ajaxSuccess(function(evt, request, settings) {
$(this).append('<div>ajaxSuccess</div>');
)
});

順序為:ajaxStart → ajaxSend → ajaxSuccess → ajaxComplete → ajaxStop。把 global 設為 false 即可關閉這些全域事件的觸發。

全域事件最適合用來做「與具體請求無關」的通用處理,例如全站的 loading 遮罩、請求計數、統一錯誤提示。但要記住它們會攔到頁面上所有的 Ajax 請求,包含第三方套件發出的那些——若不希望被影響,記得關掉 global 或改用 ajaxPrefilter 過濾。

七、注意事項

若 GET 請求的 url 中有兩個同名參數:


https://localhost/AjaxGetMethod.aspx?param=Multiple&param=Multiple3

伺服器端以 Request["Param"] 取值時,會得到一個以逗號分隔多個值的字串:


Multiple,Multiple3

這點在設計參數名稱時要留意——若語意上需要多值,建議明確約定格式(例如 param=1,2,3 或 param[]=1&param[]=2),而不是依賴這種隱含行為。

八、總結

本文介紹如何用 jQuery 實作 Ajax:load、get、getJSON、getScript、post 這些簡化方法覆蓋了大多數情境;核心的 ajax 方法則透過 options 提供完全控制。輔助方法方面,serialize() 把表單序列化為字串、serializeArray() 序列化為 JSON 結構,在需要以腳本收集資料與伺服器互動時非常有用——JSON 讓我們從混亂的屬性字串拼接中解脫出來。

最後是全域 Ajax 事件:它是一組伴隨請求生命週期觸發的特殊事件,透過 options 的 global 屬性可以整體開關。

本章程式碼下載(含以前未整理的範例,請看 chapter6 資料夾):https://xiazai.jb51.net/201101/yuanma/Code-jQueryStudy.rar

(編按:本文寫於 jQuery 1.3 時期。實作新專案時,bind() 請改用 on();$.ajax 仍持續維護,但可考慮 fetch 搭配 async/await,並善用 AbortController 取消請求。另 $.ajax() 回傳的 jqXHR 為 Promise-like 物件,可用 .done()/.fail()/.always() 取代 success/error 回呼,錯誤處理會更清晰。)

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