AJAX(Asynchronous JavaScript and XML)無疑是最受矚目的 Web 技術之一。本文示範如何用 PHP 搭配 Simple AJAX Toolkit(SAJax)做一個線上相簿:先用傳統方式寫出可運作的版本,再用 SAJax 把它變成無刷新的動態應用。兩者對比之下,你會看見 AJAX 開發真正的成本落在哪裡。
功能很單純:讀取某個目錄下的圖片,以縮圖表格呈現;點擊任一縮圖即展開為完整圖像。因為是傳統應用,每次點擊都是一個新的 HTTP 請求,參數放在 URL 上傳遞。
補充背景:2006 年 5 月 JavaOne 大會前,29 家廠商代表在 Adobe 的會議室聚會,試圖為 AJAX 的未來定調,這個組織後來定名為 OpenAjax Alliance。它刻意不把自己組織成正式的標準團體或基金會式的開源組織,形式保持非正式,約每週召開一次電話會議。關注焦點有三:透過確保互通性降低採用 AJAX 的風險、堅持走開放標準與開源技術路線、以及維護 Web 的開放性;第一項任務就是找出維持各工具間互通的方法。成員包含 IBM、Adobe、Eclipse Foundation、Google、Laszlo Systems、Oracle、Red Hat、Zend 等三十一家公司。
準備工作:收集至少 20 張 .jpg 圖片放進一個資料夾,並為每張圖準備一份縮圖(本文假設縮圖已備妥,實務上可用 GD 函式庫動態產生)。以下假設照片位於 /images、縮圖位於 /images/thumbnails,且兩者同名。
分頁器接受兩個參數:start 是起始索引,step 是每頁顯示數量。
function get_table($limit_start = 0, $limit_step = 5) {
$images = get_image_list('images');
// 此處插入導航列,見下文
$output = '<table class="image_table">';
$columns = 5;
foreach ($images as $index => $image) {
if ($index < $limit_start) continue;
if ($index >= $limit_start + $limit_step) continue;
if (($index - $limit_start) % $columns == 0) $output .= '<tr>';
$thumbnail = '<img src="thumbnails/' . $image . '" />';
$output .= '<td>' . get_image_link($thumbnail, $index) . '</td>';
if (($index - $limit_start) % $columns == $columns - 1) $output .= '</tr>';
}
$output .= '</table>';
return $output;
}
表格從 $limit_start 開始走訪圖片清單,每行五張,抵達 $limit_start + $limit_step 時結束。
既然要列出目錄內容,就需要一個列出目錄中所有圖檔的函式:
function get_image_list($image_dir) {
$d = dir($image_dir);
$files = array();
if (!$d) return null;
while (false !== ($file = $d->read())) {
// getimagesize 只在有效圖檔上回傳值
if (@getimagesize($image_dir . '/' . $file)) {
$files[] = $file;
}
}
$d->close();
return $files;
}
這裡有個容易被忽略的隱含契約:後續程式都假設這個函式每次回傳的陣列順序一致,否則分頁索引與圖片會對不上。因此實際部署時應明確排序,別依賴檔案系統的讀取順序。
$output = '<h4>Showing items ' . $limit_start . '-'
. min($limit_start + $limit_step - 1, count($images))
. ' of ' . count($images) . '<br />';
$prev_start = max(0, $limit_start - $limit_step);
if ($limit_start > 0) {
$output .= get_table_link('<<', 0, $limit_step);
$output .= ' | ' . get_table_link('Prev', $prev_start, $limit_step);
} else {
$output .= '<< | Prev';
}
$next_start = min($limit_start + $limit_step, count($images));
if ($limit_start + $limit_step < count($images)) {
$output .= ' | ' . get_table_link('Next', $next_start, $limit_step);
$output .= ' | ' . get_table_link('>>', count($images) - $limit_step, $limit_step);
} else {
$output .= ' | Next | >>';
}
$output .= '</h4>';
最後兩個函式負責產生連結,這是整個設計的關鍵——因為 index.php 與 expand.php 只在這兩個函式中被呼叫,日後要換成 AJAX 呼叫時,只需改這兩處:
function get_table_link($title, $start, $step) {
$link = "index.php?start=$start&step=$step";
return '<a href="' . $link . '">' . $title . '</a>';
}
function get_image_link($title, $index) {
$link = "expand.php?index=$index";
return '<a href="' . $link . '">' . $title . '</a>';
}
function get_image($index) {
$images = get_image_list('images');
$output = '<img src="images/' . $images[$index] . '" />';
// 此處插入導航
return $output;
}
導航邏輯與分頁器類似:「上一張」指向 $index-1、「下一張」指向 $index+1、「返回」回到分頁器。
最後加上一個簡單的 HTML 容器 expand.php,接收 index 參數並呼叫 get_image()。至此相簿完成:使用者能瀏覽所有圖片、自由來回切換,甚至用書籤回到喜歡的那一張。
圖 1. 分頁器提供了一種瀏覽照片的方式
圖 2. 完成的相簿
到目前為止用的是標準 Web 開發模型:兩個主要功能對應兩個 PHP 檔,參數走 HTTP GET,伺服器直接回傳整頁。
圖 3. 傳統模型中,三個不同的請求觸發了兩個頁面
AJAX 允許向伺服器發出非同步的輔助請求,並直接在網頁中顯示結果。不幸的是,即使最簡單的 AJAX 應用也是一項大工程:因為 AJAX 沒有標準化,Internet Explorer 與 Firefox、Safari 的實作各不相同;而且為了完成一個功能,你得至少寫三支東西——發送請求的 JavaScript、回應請求的伺服器腳本、以及處理回應的另一支 JavaScript。
圖 4. AJAX 應用需要自行處理所有的 HTTP 請求
SAjax 建立在 AJAX 之上,用一個簡單的啟發式方法省掉大量樣板程式碼:Web 客戶端要存取的每個 PHP 函式都由 SAJax「導出」。若有一個 PHP 函式 foo_bar(),SAjax 會把它導出成 JavaScript 函式 x_foo_bar();客戶端對 x_foo_bar() 的任何呼叫都會自動轉發到伺服器上的 foo_bar(),輸出再交給另一個 JavaScript 函式。
<?php
require("SAjax.php");
function foo_bar($param) {
return "You typed: $param";
}
$sajax_request_type = "GET";
sajax_init();
sajax_export("foo_bar");
sajax_handle_client_request();
?>
<html>
<head>
<script language="Javascript">
<? sajax_show_javascript(); ?>
</script>
</head>
<body>
<form onSubmit="x_foo_bar(this.input.value, alert); return false;">
<input type="text" name="input" />
</form>
</body>
</html>
在輸入框打字並按 Enter,內容會跳出一個警示框。但這個看似簡單的頁面背後,x_foo_bar() 遠端呼叫了 foo_bar(),並把結果交給 JavaScript 內建的 alert()。每個 SAJax 導出函式的最後一個參數都是回應處理器,負責承接輸出。
這也說明了 SAJax 的另一個優點:不需要為每個函式準備一個獨立檔案,頁面呼叫的是自己,因此呼叫關係容易追蹤。關鍵在 sajax_handle_client_request()——它攔截所有 SAJax 呼叫並自動分派處理。
圖 5. 使用 SAJax,客戶端可透過單一頁面存取伺服器端的多個函式
由於相簿主要有 get_table() 與 get_image() 兩個函式,需要導出的也就這兩個。函式本身幾乎不必修改,只要改動產生的連結:
<?php
require("SAjax.php");
function get_image() { } // 定義在後方
function get_thumbs_table() { } // 定義在後方
$sajax_request_type = "GET";
sajax_init();
sajax_export("get_thumbs_table", "get_image");
sajax_handle_client_request();
?>
文件主體簡化到只剩一個容器:
<body> <h1>SAJax photo album</h1> <div id="window"></div> </body>
再寫一個共用的 JavaScript 回呼函式,把伺服器輸出寫進該容器:
function to_window(output) {
document.getElementById("window").innerHTML = output;
}
window.onload = function() {
x_get_table(0, 5, to_window);
};
最後一步是把所有連結換成 SAJax 呼叫:href="index.php?start=0&step=5" 改成 onclick="x_get_table(0, 5, to_window)",href="expand.php?index=0" 改成 onclick="x_get_image(0, to_window)"。這些修改集中在 get_image_link() 與 get_table_link() 兩個函式中,轉換即完成。
圖 6. 完成的 SAJax 相簿(縮圖)
網址列不再變動,換來的是不閃跳的操作體驗。整個應用收攏在一個頁面裡,其餘函式甚至可以搬到無法從 Web 直接存取的獨立程式庫中。在多數 AJAX 應用裡,每個送出的請求都要由各自的腳本處理,或至少寫一個龐大的分派器來轉發——把這些檔案湊齊往往非常麻煩。SAjax 讓這一切只剩一個檔案,分派的工作由它代勞。
沒有上下文的相簿是不完整的——照片的來源、時間、地點都該有。做法是把這些資訊集中寫進一個 XML 檔,根節點 gallery 下含多個 photo 節點,以 file 屬性對應圖檔:
<?xml version="1.0"?>
<gallery>
<photo file="image01.jpg">
<date>August 6, 2006</date>
<locale>Los Angeles, CA</locale>
<comment>Here's a photo of my favorite celebrity</comment>
</photo>
<photo file="image02.jpg">
<date>August 7, 2006</date>
<locale>San Francisco, CA</locale>
<comment>In SF, we got to ride the street cars</comment>
</photo>
</gallery>
解析方式不限,這裡用 PHP 5 內建的 SimpleXML:
function get_meta_data($file) {
// getimagesize 是核心函式,不需要 GD
list($width, $height) = @getimagesize("images/$file");
$output = "<p>Width: {$width}px, Height: {$height}px</p>";
$xml = simplexml_load_file("gallery.xml");
foreach ($xml as $photo) {
if ($photo['file'] == $file) {
$output .= !empty($photo->date)
? "<p>Date taken: {$photo->date}</p>" : '';
$output .= !empty($photo->locale)
? "<p>Location: {$photo->locale}</p>" : '';
$output .= !empty($photo->comment)
? "<p>Comment: {$photo->comment}</p>" : '';
}
}
return $output;
}
回到 get_image(),把檔名傳進去即可:
function get_image($index) {
$images = get_image_list('images');
$output = '<img src="images/' . $images[$index] . '" />';
$output .= '<div id="meta_data">' . get_meta_data($images[$index]) . '</div>';
return $output;
}
圖 7. 加入後設資料後的相簿
SAjax 抹平了客戶端與伺服器之間的距離:程式設計者能做近乎無縫的遠端函式呼叫,不必操心傳輸層、GET 與 POST 的差別,於是能把時間花在真正該花的地方——提供資料的 PHP 腳本,以及負責呈現與控制的 JavaScript。
但這套相簿和所有 AJAX 應用一樣有個致命弱點:它沒有使用瀏覽器的「歷史紀錄」,因為破壞了後退鍵的功能。使用者按上一頁會直接離開網站,而不是回到相簿的上一步。解法是實作歷史紀錄緩衝與狀態追蹤機制——例如在每次狀態變更時更新 location.hash 並監聽 hashchange 事件,讓瀏覽器的前後頁能在應用內被有意義地攔截。這部分留給有興趣的讀者自行補完。
另外提醒兩點實務差異:範例中的 innerHTML 字串拼接在圖檔名或註解含特殊字元時會破壞 HTML 結構,正式環境應改用 DOM 方法或轉義處理;而 simplexml_load_file 每次請求都重讀一次 XML,圖片多時應加一層快取。