前面幾篇我們用原生 XMLHttpRequest 手工打造了一個 Ajax 應用。這一階段的問題是:當頁面上的動態區域變多、每個區域都要各自請求與更新時,那些重複的物件建立、狀態判斷、回呼處理會迅速把程式碼淹沒。Sajax 就是為了解這個問題而出現的。
本文為 Tyler Anderson 於 2006 年發表的系列之三,作者為自由撰稿人,Stexar 公司。
Simple Ajax Toolkit 是「同步的」非同步 JavaScript 和 XML。之所以說「同步」,是因為原本應用中必須親手處理的 XMLHTTP 物件細節,被 Sajax.php 這個函式庫完全抽象掉了。
這帶來兩個直接好處:出錯機會降低,以及連結/呼叫的語法變乾淨——頁面裡只剩下函式呼叫,看不見任何 open、send、onreadystatechange。基本上,Sajax 提供的是一種模組化撰寫 Ajax 的方式:以預先宣告的動態函式呼叫,讓開發流程變得平滑。
sajax_init():初始化 Sajax 函式庫。sajax_export():對外宣告一個「面板」內容區。稍後會為它自動產生對應的 JavaScript 函式;需要幾個動態區域就呼叫幾次,次數不限。sajax_handle_client_request():初始化 Sajax 的內部資料結構,讓應用準備好處理客戶端請求。sajax_show_javascript():把 Sajax 所需的 JavaScript 輸出到頁面中。此外還要設定 $sajax_remote_uri,也就是請求要送去的目標 URL——相當於原生 Ajax 應用中寫死在連結裡的那個位址。
幕後發生的事其實和手工版一模一樣,差別只在於 Sajax 替你建好 XMLHTTP 物件、替你產生代理函式。同樣的功能,但開發效率完全不同。
複製 ajax-app.php 為 sajax-app.php,放在同一個目錄,在檔案開頭加入:
<?php
require("Sajax.php");
$sajax_remote_uri =
"https://localhost.localdomain/ajax-sajax/panels-sajax.php";
sajax_init();
sajax_export("panels");
sajax_handle_client_request();
?>
順序很重要:先設定遠端 URL,再初始化並導出「panels」,最後才交給 sajax_handle_client_request() 接手。導出「panels」的意思是——「請幫我產生一組能處理 panels 內容的 JavaScript 函式」。
原本每個導覽連結都是一次頁面跳轉。現在改成呼叫函式,並把面板 ID 當參數傳進去:
<?php require('content/header.html'); ?>
<span onclick="getPanel(0)">Managing content</span>
<?php require('content/between-link.html'); ?>
<span onclick="getPanel(1)">Adding content</span>
<?php require('content/between-link.html'); ?>
<span onclick="getPanel(2)">Saving new content</span>
<?php require('content/between-link.html'); ?>
<span onclick="getPanel(3)">Editing content</span>
<?php require('content/between-link.html'); ?>
<span onclick="getPanel(4)">Saving edited content</span>
<?php require('content/between-link.html'); ?>
<span onclick="getPanel(5)">Avoid adding duplicates</span>
<?php require('content/between-link.html'); ?>
<span onclick="getPanel(6)">Avoid editing a page that doesn't exist</span>
<?php require('content/between-link.html'); ?>
<span onclick="getPanel(7)">Deleting content</span>
<?php require('content/between-link.html'); ?>
<span onclick="getPanel(8)">Serving a page</span>
<?php require('content/between-link.html'); ?>
<span onclick="getPanel(9)">Pulling it together: The CMS control page</span>
<?php require('content/pre-content.html'); ?>
先把原本那堆與 XMLHTTP 有關的 JavaScript 全部刪掉——這正是重點所在。取而代之的是:
<script type="text/Javascript">
<?php sajax_show_javascript(); ?>
function getPanel_cb(content) {
document.getElementById('content').innerHTML = content;
}
function getPanel(panel_id) {
x_panels(panel_id, getPanel_cb); // Sajax 自動產生的代理函式
}
</script>
第一行呼叫 sajax_show_javascript(),把 Sajax 需要的函式輸出到頁面。而 x_panels 這個函式我們從頭到尾都沒寫過——它是 Sajax 依 sajax_export("panels") 自動生成的,命名規則是 x_ 加上導出的名稱。
這個細節說明了 Sajax 的核心價值:頁面第一次載入之後,PHP 就不再參與互動了。所有後續的資料取得,都由這些生成的 JavaScript 函式接手。
複製 panels-ajax.php 為 panels-sajax.php,並依 Sajax 的約定調整:
<?php
if ($_GET['rs'] == 'panels') {
switch ($_GET['rsargs'][0]) {
case 0:
print("##"); // Sajax 函式庫要求的前置輸出
require('content/panel-' . $_GET['rsargs'][0] . '.html');
$panel_id_next = $_GET['rsargs'][0] + 1;
$panel_id_prev = $_GET['rsargs'][0] - 1;
if ($panel_id_prev >= 0) {
print("<span onclick=\"getPanel($panel_id_prev)\">Previous Panel</span> ");
}
print("<span onclick=\"getPanel($panel_id_next)\">Next Panel</span>");
break;
// ... case 1 到 case 9 依此類推
}
}
?>
幾個實作上的注意點:
panels 會送給 sajax_import,也就是 GET 陣列中 rs 變數的值。$_GET['rsargs'][0] 裡——它是呼叫 x_panels 時的第一個參數,由 Sajax 函式庫自動產生。因此程式裡所有原本用 $_GET['panel_id'] 的地方都要換成它。print("##"))。這看起來像是 Sajax 函式庫的一個 bug,但既然約定如此就得配合。這兩個字元不會出現在最終畫面上。sajax-app.php 一致的形式:把 loadHtml 換成 getPanel,一樣傳 ID。完成後的瀏覽器輸出如下,行為與外觀和原生 Ajax 版本完全相同:

你已經用 PHP 建好一個 Ajax 應用,並成功與 Sajax 整合。這個應用(以及日後所有非同步 JavaScript 應用)為使用者省下大量頻寬與等候整頁重載的時間:不必每次點擊都重新載入整頁,只載入必要內容。這讓「互動豐富的應用」變得更普遍。
原始碼下載:FTP://www6.software.ibm.com/software/developer/library/os-PHPajax.sajax.source.zip
原文出自 IBM developerWorks,版權屬 IBM 所有,此處僅作技術學習引用。
Sajax 這個名字現在幾乎聽不到了,但它代表的概念一點都沒過時——把伺服器端函式自動產生為客戶端可呼叫的代理。從各家 RPC 框架到 GraphQL 的 codegen,這個模式一路活到今天。
不過這份範例中有幾個地方,以現代標準看必須修正:
innerHTML 帶入未淨化的伺服器輸出,是 XSS 的直接來源。若面板內容含任何使用者輸入,必須先轉義。$_GET['rsargs'][0] 直接進 switch 雖然還算安全,但沒有型別與範圍驗證。請用 (int) 轉型並檢查邊界,預設分支要給出合理回應。print("##") 這種「靠輸出垃圾字元來對表協定」的做法,正是為什麼我們需要正式的序列化格式。今天用 JSON 就不會有這個問題。onclick 寫在 <span> 上,鍵盤使用者完全無法操作。請改用 <a> 或 <button>,以保住基本的無障礙可用性。值得帶走的那個想法是:當頁面上有多個需要獨立更新的區域時,與其為每個區域手寫一套請求與回呼,不如把「區域」抽象成一個可宣告、可參數化的概念。這正是 Sajax 的 sajax_export 在做的事,也是今天每個前端框架的元件化在做的同一件事。