過去幾年,JavaScript 從一個「事後才想起來」的角色,一路走到 Web 開發的核心位置。若要指出哪項因素推動了這場蛻變,以 Ajax 為基礎的應用程式開發絕對是關鍵之一。
這是一套開發技術
簡單說,Ajax 讓網站或應用程式能用即時資料更新介面,而不必刷新頁面。這帶來一種更流暢、更接近桌面軟體的使用體驗。
Ajax 簡史
Ajax 的發展軌跡,和許多「一夜爆紅」的技術相似。它看似憑空出現,實際上已經存在多年。在 DHTML 的那個網路泡沫時代,以及泡沫破裂後的低潮期,世界各地的開發者陸續解開 JavaScript 的能力,把這個嶄新且令人振奮的應用模式帶進 Web。
XMLHttpRequest
最早也最关键的一塊拼圖,是 XMLHttpRequest(XHR)API。它是用於在瀏覽器與伺服器之間傳輸訊息的 JavaScript API,支援以 HTTP POST 把資料送到伺服器,或以 GET 從後端取回資料。大多數 Ajax 互動都以它為核心,它也是現代 Web 開發的基礎技術。
有趣的是,這項技術其實是 Microsoft Internet Explorer 團隊送給網路的禮物。早在 2000 年,XHR 就出現在 IE 5 之中。它最初是由 Alex Hopmann 撰寫的 ActiveX 控制項,目的是處理 Microsoft Outlook Web Access 與 Exchange Server 之間的互動。
雖然出身並非什麼草根項目,XHR 的發展卻遠遠超出原本產品的範圍,後來被各大瀏覽器相繼實作,甚至成為 W3C 標準。
先驅們
除了 Microsoft,還有其他公司投入這個原型階段。其中兩家特別值得一提:一家因為留下了一則常被引用的軼聞,另一家則是真正把這些技術推向主流的網路巨頭。
Oddpost
Oddpost 是 2002 年推出的網頁版進階郵件客戶端,用了許多今日為人熟知的模式。無論是設計還是互動,都會讓人聯想到桌面郵件軟體。系統內部,Oddpost 以稱為 DataPacks 的概念把小塊資料從伺服器送到瀏覽器,帶來截然不同的體驗。
Oddpost 後來被 Yahoo! 收購,成為改版 Yahoo! Mail 的基礎。
Google Maps、Google Suggest、Gmail 與一篇關鍵文章
真正的轉折出現在幾年後的 Gmail、Google Suggest 與 Google Maps。這三項服務對 Ajax 的運用點燃了整个開發社群,其反應速度與互動性對當時的社會大眾而言相當新奇。
雖然真正理解其中原理的人不多,開發界的迴響卻非常熱烈。大家都知道 Web 應用開發出現了某種新東西,但在很長一段時間裡,這個「東西」始終面目模糊。
人們需要一篇文章把它講清楚。
2005 年 2 月 18 日,Adaptive Path 的共同創辦人兼總裁 Jesse James Garrett 發表了〈Ajax: A New Approach to Web Applications〉。文中他梳理了 Gmail、Google Maps 這類應用的設計趨勢,並稱之為「可能引發 Web 開發根本變革」的方向。
更重要的是,他為這個模式命名了。從那一刻起,人們開始聚焦這股趨勢,就連非專業人士談起 Web 開發的近期變化時也會提到它。他是這樣定義的:
定義 Ajax
Ajax 不是單一技術,而是多種技術各具特色地融合在一起。它包含:
這個說明今日看來略有年代感,但基本模式依然成立:HTML 與 CSS 負責資料與樣式,DOM 及相關方法支撐頁面即時更新,XHR 負責與伺服器通訊,JavaScript 則統籌全局。
這篇文章的影響力相當大。密集的媒體曝光,遇上亟需出口的創意與能量,掀起了一場難得一見的革命。Ajax 迅速被新創公司採用,一躍來到 Web 開發典範的最前線,從模糊的趨勢變成現代 Web 設計不可或缺的環節。
函式庫的推波助瀾
另一個關鍵推手,是幾套功能完整的 JavaScript 函式庫的成熟。除了資深的 JavaScript 開發者,很少有人真正理解 Ajax 底層的細節。即使在 DHTML 時代,具備處理繁瑣跨瀏覽器差異能力的工程師數量有限,導致需求與人才之間落差擴大。Prototype、Dojo、jQuery 這類函式庫提供了現成的互動與動畫效果、抹平了跨瀏覽器差異、也補強了核心 API 的不足,正好填上了這道缺口。
JSON:JavaScript 物件表示法
從早期的 post 時代到今日,Ajax 領域最大的變化是 JSON 的出現。相較於 XML 那套繁瑣的 DOM 操作,JSON 檔案更小,且能用原生 JavaScript 直接存取,很快就被開發者採用作為資料傳輸格式。如今 JSON 已被列入 ECMAScript 第 5 版的規範。
JSONP
JSON 之後一個顯著的增強是 JSONP(JSON with Padding)。如你所見,XMLHttpRequest 有嚴格的安全模型,只允許與請求頁面相同的網域與協議通訊。JSONP 在這個限制上開了一道更靈活的門:把 JSON 回應包進使用者定義或系統提供的回調函式中,將該 script 加入文件後即可取得資料。這個模式後來相當普遍,許多大型網路服務都用它來支援混搭應用與內容聚合。
但 JSONP 有個明顯的弱點:由於它允許第三方 script 在主機頁面中執行,一旦資料提供者被入侵,或頁面未留意插入的資源來源,風險難以估量。
有了歷史背景,接著看技術細節。
XMLHttpRequest API 與特性
雖然取回資料的方式不只有一種,XHR 仍是多數 Ajax 互動的核心。一次 XHR 互動由請求與回應兩部分組成。
安全模型
前面提過,原始的 XMLHttpRequest 有嚴格的同源策略:只允許與請求頁面相同的主機、協議與埠號通訊。也就是說,不同網域(example.com 與 example2.com)、不同主機(my.example.com 與 www.example.com)、不同協議(https://example.com 與 https://example.com)之間的通訊都被禁止,並會產生錯誤訊息。
隨著第二版 XHR 的開發,跨域請求機制在 W3C 完成標準化,各家瀏覽器也陸續實作,目前 IE8+、Firefox 3.5+、Safari 4+ 與 Chrome 皆已支援。請求中會帶一個特定的 Origin 標頭:
Origin: https://example.com
伺服器則回應一個相符的 Access-Control-Allow-Origin 標頭:
Access-Control-Allow-Origin: https://example.com
如此一來,就能用 XHR 進行跨域的雙向通訊。
請求
請求端有四種方法:
回應
回應端則有以下屬性與方法:
readyState
物件建立後,XMLHttpRequest 有五種狀態:
原生 JavaScript 範例
在介紹各家函式庫之前,先看幾個原生範例,理解底層在跑什麼。
範例 HTML 文件:
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Simple Ajax Example</title>
<meta name="author" content="Rob Larsen">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<link rel="stylesheet" href="_assets/css/style.css" rel="external nofollow" >
</head>
<body>
<div id="main">
<h1>Simple Ajax Example</h1>
<p><strong id="activate">Click here</strong> and content will be appended after this paragraph</p>
</div>
<script src="_assets/js/ajax.js"></script>
</body>
</html>
以下是一個簡單的 GET 請求,處理 responseXML。這是該技術早期的典型互動形式,可在所有現代瀏覽器以及 IE7、IE8 上運行。
一個基本的 Ajax 函式
/* Here's a basic Ajax function */
var ajax = function (opts) {
/* We have an options argument. In addition, we want to have some smart defaults. */
opts = {
//Is it a Get or Post type:
type: opts.type || "POST",
//What URL are we going to hit?
url: opts.url || "",
//What do we do with the data
onSuccess: opts.onSuccess || function () {},
//what kind of data do we expect?
data: opts.data || "xml"
};
//create a new XMLHttpRequest
var xhr = new XMLHttpRequest();
//Open the connection to the server
xhr.open(opts.type, opts.url, true);
/* When the ready state changes fire this function */
xhr.onreadystatechange = function () {
//readyState 4 is "done"
if (xhr.readyState == 4) {
/* do some simple data processing
There are two components to the returned object- responseXML and responseText.
Depending on what we're doing we'll need one or the other. */
switch (opts.data) {
case "json":
//json is text
opts.onSuccess(xhr.responseText);
break;
case "xml":
//XML retains the structure/DOM
//It's passed in whole.
opts.onSuccess(xhr.responseXML);
break;
default:
//Everything else will get TXT
opts.onSuccess(xhr.responseText);;
}
}
};
//close the connection
xhr.send(null);
};
//here's our simple function
var ajaxSample = function (e) {
//Simple callback adds some text to the page
var callback = function (data) {
document.getElementById("main").innerHTML += "<p>" +
data.getElementsByTagName("data")[0].getAttribute("value") + "</p>";
}
//And here's our Ajax call
ajax({
type: "GET",
url: "_assets/data/ajax-1.xml",
onSuccess: callback,
data: "xml"
})
//prevent the default action
e.preventDefault();
}
//Wire everything up
document.getElementById("activate").addEventListener("click", ajaxSample, false);
下一個例子可以看到依然活躍的 ActiveX 物件。若沒有原生實作,可用 try...catch 逐一嘗試不同版本的 Internet Explorer。這個完整的跨瀏覽器版本甚至能與古老的 IE5 相容。
跨瀏覽器的 Ajax 腳本
var ajax = function (opts) {
opts = {
type: opts.type || "POST",
url: opts.url || "",
onSuccess: opts.onSuccess || function () {},
data: opts.data || "xml"
};
/* Support for the original ActiveX object in older versions of Internet Explorer
This works all the way back to IE5. */
if (typeof XMLHttpRequest == "undefined") {
XMLHttpRequest = function () {
try {
return new ActiveXObject("Msxml2.XMLHTTP.6.0");
} catch (e) {}
try {
return new ActiveXObject("Msxml2.XMLHTTP.3.0");
} catch (e) {}
try {
return new ActiveXObject("Msxml2.XMLHTTP");
} catch (e) {}
throw new Error("No XMLHttpRequest.");
};
}
var xhr = new XMLHttpRequest();
xhr.open(opts.type, opts.url, true);
xhr.onreadystatechange = function () {
if (xhr.readyState == 4) {
switch (opts.data) {
case "json":
opts.onSuccess(xhr.responseText);
break;
case "xml":
opts.onSuccess(xhr.responseXML);
break;
default:
opts.onSuccess(xhr.responseText);;
}
}
};
xhr.send(null);
}
var ajaxSample = function (e) {
var callback = function (data) {
document.getElementById("main").innerHTML += "<p>" +
data.getElementsByTagName("data")[0].getAttribute("value") + "</p>";
}
ajax({
type: "GET",
url: "_assets/data/ajax-1.xml",
onSuccess: callback,
data: "xml"
})
e.preventDefault();
}
document.getElementById("activate").addEventListener("click", ajaxSample, false);
再來是今日更常見的模式:回應以 JSON 格式傳回,並解析成原生 JavaScript 物件。把這段程式與操作 XML 時那種繁瑣迂迴的寫法相比,為何大家都選 JSON,答案不言而喻。
使用 JSON
var ajax = function (opts) {
opts = {
type: opts.type || "POST",
url: opts.url || "",
onSuccess: opts.onSuccess || function () {},
data: opts.data || "xml"
};
var xhr = new XMLHttpRequest();
xhr.open(opts.type, opts.url, true);
xhr.onreadystatechange = function () {
if (xhr.readyState == 4) {
switch (opt.sdata) {
case "json":
opt.onSuccess(xhr.responseText);
break;
case "xml":
opt.onSuccess(xhr.responseXML);
break;
default:
opt.onSuccess(xhr.responseText);;
}
}
};
xhr.send(null);
}
var jsonSample = function (e) {
var callback = function (data) {
//here, the data is actually a string
//we use JSON.parse to turn it into an object
data = JSON.parse(data);
/* we can then use regular JavaScript object references to get at our data. */
document.getElementById("main").innerHTML += "<p>" + data.sample.txt + "</p>";
}
ajax({
type: "GET",
url: "_assets/data/json-1.json",
onSuccess: callback,
data: "json"
})
e.preventDefault();
}
document.getElementById("activate").addEventListener("click", jsonSample, false);
最後是一個簡單的 JSONP 範例。如你所見,透過一個回調參數,就能把資料以 script 附加的方式取回,再交給回調處理——返回的內容會被包成可執行的 JavaScript。
JSONP 資料
var callback = function (data) {
document.getElementById("main").innerHTML += "<p>" + data.sample.txt + "</p>";
}
var jsonpSample = function (e) {
//create a script element
var jsonp = document.createElement("script");
//give it a source with the callback name appended in the query string
jsonp.src = "_assets/data/jsonp.do?callback=callback";
//add it to the doc
document.body.appendChild(jsonp);
e.preventDefault();
}
//wire up the event
document.getElementById("activate").addEventListener("click", jsonpSample, false);
函式庫範例
對大多數開發者而言,只有做學術研究的人才會想探究請求的本質,實際工作多半是在某個或多個 JavaScript 函式庫中完成。除了抹平跨瀏覽器的相容問題,這些函式庫還在基礎 API 之上提供了不少特性。以下用三套熱門函式庫的 GET 與 POST 範例,對照它們各自的 API 風格。
jQuery
先從最普及的 jQuery 開始。jQuery 的 Ajax 函式近期做了改寫,納入若干進階功能,這不在本文討論範圍內,但所有 jQuery Ajax 請求的共通設定都是以傳入函式的設定物件參數形式存在。另外別忘了 jQuery 還提供了 $.post 與 $.get 這類捷徑,對應最常見的請求配置。
以下是使用 jQuery 取回資料的簡要程式:
一個 jQuery GET 請求
/* callback is a simple function that will be run when the data is returned from the server */
var callback = function (data) {
/* it just adds a little bit of text to the document
data is the JSON object returned by the server. */
$("#main").append($("<p />").text(data.sample.txt));
}
/* Wire up the ajax call to this click event */
$("#activate").click(function () {
//call $.ajax with a configuration object
$.ajax({
//it's just a get request
type: 'get',
//we're looking for this URL
url: '_assets/data/json-1.json',
//Our cool callback function
success: callback,
//it's going to be JSON
dataType: "json"
})
})
下一個例子示範如何送出並取回簡單的 JSON 物件。這裡使用原生 JSON 物件解析資料,jQuery 文件明確提到,在不支援的瀏覽器中需另外引入 JSON2.js。
同時提供明確的錯誤處理函式,可讓成功與失敗兩種情況都得到妥善照應。jQuery 的錯誤狀態帶有三個參數,包含 XHR 物件本身,足以支撐穩健的錯誤處理。
一個 jQuery POST
/* this is the object we're going to post */
var myMessages = {
positive: "Today is a good day",
negative: "Today stinks",
meh: "meh"
}
var callback = function (data) {
$("#main").append($("<p />").text(data.positive));
}
/* Setting up a simple error handler. It doesn't do much. It's just nice to illustrate error handling. */
var errorHandler = function (xhr, textStatus, errorThrown) {
throw new Error("There was an error. The error status was " + textStatus);
}
/* Here's where the action happens. Attach an event to out simple button. */
$("#activate").click(function () {
//call $.ajax with a configuration object
$.ajax({
//we're sending data to the server
type: 'POST',
//this is our URL
url: '_assets/data/post-responder.do',
/* This is our data, JSON stringified
jQuery expects to use native JSON or JSON2.js in unsupported browsers */
data: JSON.stringify(myMessages),
//Here's where we set up our callback function
success: callback,
//The data expected from the server
dataType: "json",
//And our simple error handler
error: errorHandler
})
});
Dojo
Dojo 的野心遠大於以下範例所示的簡單請求與 DOM 操作,它是為重度應用開發而生的。即便如此,從這個角度觀察它的 API 仍有參考價值。
注意兩個獨立的函式:xhrGet 與 xhrPost。另外這裡使用 Dojo 的 JSON 工具函式來解析資料。以下是一個 GET 範例。
一個 Dojo GET 請求
var callback = function (data) {
//note the document.getelementById alias
dojo.byId("main").innerHTML += "<p>" + data.sample.txt + "</p>";
}
var getData = function () {
//xhrGet is for get requests
dojo.xhrGet({
//the URL of the request
url: "_assets/data/json-1.json",
//Handle the result as JSON data
handleAs: "json",
//The success handler
load: callback
});
}
// Use connect to attach events
dojo.connect(dojo.byId("activate"), "onclick", getData);
以下是帶有錯誤處理設定的 Dojo POST。
Dojo POST
var myMessages = {
positive: "Today is a good day",
negative: "Today stinks",
meh: "meh"
}
var callback = function (data) {
dojo.byId("main").innerHTML += "<p>" + data.positive + "</p>";
}
var errorHandler = function () {
throw new Error("We dun goofed.")
}
var postData = function () {
//not surprisingly xhrPost is for POST
dojo.xhrPost({
// The URL of the request
url: "_assets/data/post-responder.do",
//This will be JSON
handleAs: "json",
//Set the headers properly
headers: {
"Content-Type": "application/json; charset=uft-8"
},
//Use Dojo's JSON utility
postData: dojo.toJson(myMessages),
// The success handler
load: callback,
// The error handler
error: errorHandler
});
}
// Use connect to attach events
dojo.connect(dojo.byId("activate"), "onclick", postData);
Yahoo! 使用者介面(YUI)
YUI 的模式與前兩者略有不同。首先,YUI 回傳整個 XHR 物件,而不只是解析後的資料,這讓開發者能更精確地操作回應內容、掌握整個請求的細節——代價是必須理解 XHR 物件本身。另外這裡展示了 YUI 的模組載入器 use():即使與 Ajax 沒有直接關聯(除了載入 io 模組之外),模組清單與作為參數的回調函式仍是 YUI 的典型寫法。執行時,所需模組會從 Yahoo! CDN 的單一下載包中取得。
一個 YUI GET 請求
// Create a new YUI instance and populate it with the required modules.
YUI().use('node', 'event', 'json', 'io', function (Y) {
var callback = function (id, xhr) {
var data = Y.JSON.parse(xhr.responseText);
Y.one('#main').append("<p>" + data.sample.txt + "</p>");
}
Y.one("#activate").on('click', function () {
Y.io('_assets/data/json-1.json', {
//This is actually the default method:
method: 'get',
on: { success: callback }
})
})
});
下面的 POST 範例有一個有趣的風格:所有回應函式被進一步收攏到 on 物件裡。
YUI POST
YUI().use('node', 'event', 'json', 'io', function (Y) {
var myMessages = {
positive: "Today is a good day",
negative: "Today stinks",
meh: "meh"
}
var callback = function (id, xhr) {
var data = Y.JSON.parse(xhr.responseText);
Y.one('#main').append("<p>" + data.positive + "</p>");
}
var errorHandler = function (id, xhr) {
throw new Error("There was an error. The error status was " + xhr.statusText + ".")
}
Y.one("#activate").on('click', function () {
Y.io('_assets/data/post-responder.do', {
method: 'post',
//Use the Y.JSON utility to convert messages to a string
data: Y.JSON.stringify(myMessages),
//All response methods are encapsulated in the on object
on: { success: callback, failure: errorHandler }
})
})
});
如你所見,除了 ActiveX 相容處理與 JSONP 範例之外,這些寫法背後的原理基本一致,差別只在核心互動之上各自包裝了不同的 API。
當然,各家函式庫提供的能力遠不止這些基本互動。雖然大多數 Ajax 工作靠 GET 與 POST 就能解決,但花點時間熟悉所用函式庫的進階特性,往往能在關鍵時刻省下不少力氣。