ajax poller 是一套來自 DHTMLGoodies.com 的投票元件(作者 Alf Magne Kalleland,2006 年),以 GNU Lesser General Public License 2.1 或更新版本釋出。它的特色是投票動作與結果呈現全部走 Ajax,頁面不必重整,結果條還會以逐格增長的動畫方式滑出。
var serverSideFile = 'ajax-poller-cast-vote-php.php';
var voteLeftImage = 'images/graph_left_1.gif';
var voteRightImage = 'images/graph_right_1.gif';
var voteCenterImage = 'images/graph_middle_1.gif';
var graphMaxWidth = 130; // 實際會略寬,因為左右各有一段圓角圖
var graphMinWidth = 15; // 結果條的最小寬度
var pollScrollSpeed = 5; // 數值越小,動畫越快
var useCookiesToRememberCastedVotes = false; // 是否以 cookie 記住已投票狀態
var txt_totalVotes = 'Total number of votes: ';
三張小圖分別負責結果條的左端、中段與右端,中段以背景圖方式鋪排並承載百分比文字,這種「三片式」做法讓長條圖在任意寬度下都能保持圓角外觀。
1. 預先載入圖片。投票才臨時抓圖容易出現閃白,因此元件在初始化時就用 new Image() 把三張圖預載完畢。
var preloadedImages = new Array();
preloadedImages[0] = new Image(); preloadedImages[0].src = voteLeftImage;
preloadedImages[1] = new Image(); preloadedImages[1].src = voteRightImage;
preloadedImages[2] = new Image(); preloadedImages[2].src = voteCenterImage;
2. 送出選票。先從表單中找出被勾選的選項,寫入 cookie(若啟用),接著建立一個 sack 物件發出請求。
function castMyVote(pollId, formObj) {
var elements = formObj.elements['vote[' + pollId + ']'];
var optionId = false;
for (var no = 0; no < elements.length; no++) {
if (elements[no].checked) optionId = elements[no].value;
}
Poller_Set_Cookie('dhtmlgoodies_poller_' + pollId, '1', 6000000);
if (optionId) {
var ajaxIndex = ajaxObjects.length;
ajaxObjects[ajaxIndex] = new sack();
ajaxObjects[ajaxIndex].requestFile =
serverSideFile + '?pollId=' + pollId + '&optionId=' + optionId;
prepareForPollResults(pollId);
ajaxObjects[ajaxIndex].onCompletion = function(){
showVoteResults(pollId, ajaxIndex);
};
ajaxObjects[ajaxIndex].runAJAX();
}
}
3. 解析 XML 並繪製結果。回呼函式會清除換行、以正則取出投票標題,再把 <option> 節點切開,逐一讀出選項文字、選項 ID 與票數,動態組出 DOM。由於是純手動建構節點,樣式完全交由 CSS 掌控。
var xml = ajaxObjects[ajaxIndex].response.replace(/\n/gi, '');
var reg = new RegExp("^.*?<pollerTitle>(.*?)<.*$","gi");
var pollerTitle = xml.replace(reg, '$1');
var options = xml.split(/<option>/gi);
// 之後逐一取出 optionText、optionId、votes 並 appendChild 到結果容器
4. 計算百分比並播放動畫。先把各選項票數換算成百分比,並把四捨五入造成的誤差補回最後一項,確保總和剛好是 100%;接著用 setTimeout 每秒遞增一級,讓長條看起來像慢慢長出來。
function slideVotes(pollId, currentPercent) {
currentPercent = currentPercent / 1 + 1;
for (var prop in pollVotes[pollId]) {
if (pollVotes[pollId][prop] >= currentPercent) {
var obj = document.getElementById('result_voteTxt' + prop);
obj.innerHTML = currentPercent + '%';
obj.style.width = Math.max(graphMinWidth,
Math.round(currentPercent / 100 * graphMaxWidth)) + 'px';
}
}
if (currentPercent < 100)
setTimeout('slideVotes("' + pollId + '","' + currentPercent + '")', pollScrollSpeed);
}
ajax poller 並未直接操作 XMLHttpRequest,而是墊了一層由 Gregory Wild-Smith(2005)撰寫、以修改版 X11 授權釋出的 SACK 函式庫。它提供幾個實用的設計:
XMLHttpRequest,全部失敗則設 failed = true。onLoading、onLoaded、onInteractive、onCompletion,另有 onError、onFail。rndval 時間戳記,這一招省掉了不少「資料沒更新」的困擾。element,完成後會依元素型別自動把 responseText 寫進 value(input/select/textarea)或 innerHTML。this.xmlhttp.onreadystatechange = function() {
switch (self.xmlhttp.readyState) {
case 1: self.onLoading(); break;
case 2: self.onLoaded(); break;
case 3: self.onInteractive(); break;
case 4:
self.response = self.xmlhttp.responseText;
self.responseXML = self.xmlhttp.responseXML;
self.responseStatus[0] = self.xmlhttp.status;
self.responseStatus[1] = self.xmlhttp.statusText;
if (self.elementObj) { /* 依元素型別寫入 value 或 innerHTML */ }
if (self.responseStatus[0] == "200") { self.onCompletion(); }
else { self.onError(); }
self.URLString = "";
break;
}
};
整體來說,這套元件的示範價值大於實用價值:它把「三片式長條圖 + XML 解析 + 動畫遞增 + 階段化回呼」這幾個常見技巧整合在同一個案例中,即使今天要改用 fetch 或現代框架重寫,這些思路仍然完全適用。需要注意的是,元件內部的 eval(this.response) 與字串拼接組出的 setTimeout 寫法,在現代專案中應避免沿用,改用 JSON 解析與正規的函式參考會安全得多。