前面幾篇談完了 Prototype 的基礎物件與字串處理,這一篇進入正題:怎麼用它發出 AJAX 請求。Prototype 把 XMLHttpRequest 的細節包成三個主要類別,各自負責不同情境。
客戶端:
<script src="prototype.js"></script>
<script>
function test(){
var myAjax = new Ajax.Request('data.html', {
method: 'get',
onComplete: showResponse
});
}
function showResponse(response){
$('myDiv').innerHTML = response.responseText;
}
</script>
<input type="button" value="click" onclick="test()" />
<div id="myDiv"></div>
服務端就是一個普通的 HTML 檔,內容會被整段取回。
method:HTTP 方法(post/get/head)
parameters:URL 參數,即問號後面的那串
asynchronous:是否非同步
postBody:POST 時放在請求本文中的內容
requestHeaders:一併送出的 HTTP 標頭,項目必須成對
onXXX:請求狀態變化時的回呼,共五個階段——onUninitialized、onLoading、onLoaded、onInteractive、onComplete
onSuccess:成功完成時呼叫
onFailure:完成但發生錯誤時呼叫
onException:發生例外時呼叫,接收 XMLHttpRequest 物件與例外物件兩個參數
Request 需要你寫回呼去更新 DOM,Updater 把這步也包了——只要告訴它要更新哪個元素:
function test(){
var myAjax = new Ajax.Updater('myDiv', 'data.html', {
method: 'get'
});
}
如果載入的內容裡含有 script,加上 evalScripts: true 就會執行:
var myAjax = new Ajax.Updater('myDiv', 'data.html', {
method: 'get',
evalScripts: true
});
被載入的片段:
<script>
sayHi = function(){
alert("Hello, " + $F('name') + "!");
};
</script>
<input type="text" id="name" value="Ajax.Updater DEMO" />
<input type="button" value="Click Me" onclick="sayHi()" />
這裡有個很值得注意的細節:如果把 sayHi 改成 function sayHi(){...} 或 var sayHi = function(){...},程式就會失效。原因是 Updater 用 eval 執行腳本,而不是把內容併入當前頁面;用 var 宣告的函式作用域只在那段腳本內部,外部拿不到。只有像範例那樣直接對 window 做指派(不帶 var),外部才能呼叫。這正是 evalScripts 這類機制容易被誤用的地方。
天氣、新聞這類需要週期性刷新的元件,用 setTimeout 自己排會很囉嗦。PeriodicalUpdater 只需要三個參數:要更新的元素 id、請求的 URL、以及選項。
var myAjax = new Ajax.PeriodicalUpdater('myDiv', 'data.html', {
method: 'get',
evalScripts: true,
frequency: 1, // 兩次請求的間隔(秒),預設 2
decay: 2 // 連續失敗時,間隔的放大倍率
});
decay 是個很貼心的設計:如果後端連續回應相同的內容,就把下次請求的間隔乘上 decay,避免在資料沒變動時還一直空轉打伺服器。
需要「所有 AJAX 請求都套用同一套行為」時用它——最典型的例子就是全域的 loading 提示:
var handle = {
onCreate: function(){
Element.show('loading'); // 請求建立時顯示 loading
},
onComplete: function(){
// 全部請求都結束後才隱藏
if (Ajax.activeRequestCount == 0){
Element.hide('loading');
}
}
};
Ajax.Responders.register(handle);
頁面中只要放一個 loading 區塊即可:
<div id="loading" style="display:none"> <img src="loading.gif" />Loading... </div>
定義好 handle 物件並註冊之後,頁面裡任何一個 AJAX 請求都會觸發 onCreate,完成時都會觸發 onComplete。Ajax.activeRequestCount 的判斷很關鍵——如果同時有多個請求在跑,第一個完成的時候不該急著把 loading 收起來。
只要資料、自己決定怎麼放進頁面,用 Request;直接把回應塞進某個元素,用 Updater;需要反覆刷新同一塊區域,用 PeriodicalUpdater。而 Responders 是橫切关注点,跟前三者搭配使用。
對照 jQuery 的話:$.ajax() 對應 Request、.load() 對應 Updater、setInterval + .load() 對應 PeriodicalUpdater,而 $(document).ajaxStart() / .ajaxStop() 就是 Responders 的 equivalents。