Server 端的職責向來單純:接收 Client 的請求、執行邏輯運算、把結果回應出去。而這個回應,通常以 XML 格式呈現,好讓 Client 端的 JavaScript 解析後更新頁面。
<?php
header('Content-Type: text/xml');
echo '<?xml version="1.0" encoding="UTF-8" standalone="yes"?>';
echo '<cities>';
$cityArray = array('Paris', 'London', 'NewYork', 'Beijing', 'Tokyo');
foreach ($cityArray as $city) {
echo '<city>' . $city . '</city>';
}
echo '</cities>';
?>
<?php
header('Content-Type: text/xml');
$cityArray = array('Shanghai', 'Beijing', 'Shanxi', 'Shandong');
$dom = new DOMDocument();
$citiesTag = $dom->createElement('cities');
$dom->appendChild($citiesTag);
foreach ($cityArray as $city) {
$cityTag = $dom->createElement('city');
$cityName = $dom->createTextNode($city);
$cityTag->appendChild($cityName);
$citiesTag->appendChild($cityTag);
}
echo $dom->saveXML();
?>
字串拼接簡單直觀,DOM 則在結構複雜、需要轉義或後續加工時更可靠。
跨瀏覽器建立物件的標準做法,是先嘗試原生實作,失敗再逐一嘗試各版本的 ActiveX:
var xmlHttp = createXMLHttpRequestObject();
function createXMLHttpRequestObject() {
var XMLHttp;
try {
xmlHttp = new XMLHttpRequest();
} catch (e) {
var XmlHttpVersions = new Array(
'MSXML2.XMLHTTP.6.0', 'MSXML2.XMLHTTP.5.0', 'MSXML2.XMLHTTP.4.0',
'MSXML2.XMLHTTP.3.0', 'MSXML2.XMLHTTP', 'Microsoft.XMLHTTP');
for (var i = 0; i < XmlHttpVersions.length && !XMLHttp; i++) {
try {
xmlHttp = new ActiveXObject(XmlHttpVersions[i]);
} catch (e) {}
}
}
if (!XMLHttp) alert("Error creating the XMLHttpRequest object.");
else return XMLHttp;
}
三個事件觸發函式分別對應 onmouseover、onmouseout 與 onclick:
function PHPechoXML() {
if (XMLHttp) {
try {
xmlHttp.open("GET", "PHPechoXML.php", true);
XMLHttp.onreadystatechange = handleRequestStateChange;
XMLHttp.send(null);
} catch (e) {
alert("Can't connect to server: " + e.toString());
}
}
}
function PHPDOMXML() {
// 同上,改呼叫 PHPDOMXML.php
}
function CSparameter() {
if (XMLHttp) {
try {
var firstNumber = document.getElementById("firstNumber").value;
var secondNumber = document.getElementById("secondNumber").value;
var param = "firstNumber=" + firstNumber + "&secondNumber=" + secondNumber;
XMLHttp.open("GET", "CSparameter.php?" + param, true);
XMLHttp.onreadystatechange = handleRequestStateChangePara;
XMLHttp.send(null);
} catch (e) {
alert("Can't connect to server: " + e.toString());
}
}
}
不同瀏覽器在 XML 解析失敗時的表現並不一致,因此回呼中最好明確攔下錯誤,而不是讓後續程式碼靜默失敗:
function handleRequestStateChange() {
if (XMLHttp.readyState == 4) {
if (XMLHttp.status == 200) {
try {
var xmlResponse = xmlHttp.responseXML;
// 攔下 IE / Opera 的潛在錯誤
if (!xmlResponse || !XMLResponse.documentElement) {
throw ("Invalid XML structure: " + XMLHttp.responseText);
}
// 攔下 Firefox 的潛在錯誤
var rootNodeName = XMLResponse.documentElement.nodeName;
if (rootNodeName == "parsererror") {
throw ("Invalid XML structure: " + XMLHttp.responseText);
}
xmlRoot = XMLResponse.documentElement;
cityArray = XMLRoot.getElementsByTagName("city");
var html = "";
for (var i = 0; i < cityArray.length; i++) {
html += cityArray.item(i).firstChild.data + "<br/>";
}
document.getElementById("show").innerHTML = "Server says: <br />" + html;
} catch (e) {
alert("Error reading the response: " + e.toString());
}
} else {
alert("There was a problem retrieving the data: " + XMLHttp.statusText);
}
}
}
<?php
require_once('error_handler.php');
header('Content-Type: text/xml');
$firstNumber = $_GET['firstNumber'];
$secondNumber = $_GET['secondNumber'];
$result = $firstNumber / $secondNumber;
$dom = new DOMDocument();
$resultsTag = $dom->createElement('results');
$dom->appendChild($resultsTag);
$resultTag = $dom->createElement('result');
$resultText = $dom->createTextNode($result);
$resultTag->appendChild($resultText);
$resultsTag->appendChild($resultTag);
echo $dom->saveXML();
?>
順帶一提,除零在 PHP 中會產生警告,而這個警告文字一旦被寫進回應流,就會破壞 XML 結構——這正是下一節要處理的問題。
PHP 預設不將錯誤顯示出來(display_errors 為 off,訊息只寫進伺服器日誌),這讓 AJAX 後端特別難除錯:瀏覽器只看到一個解析失敗或空白,完全無從下手。但反過來,若把 display_errors 打開,警告文字又會混進 XML 回應流,一樣壞事。
務實的解法是自訂錯誤處理函式,把錯誤以明確、可控的形式輸出:
<?php
set_error_handler('error_handler', E_ALL);
function error_handler($errNo, $errStr, $errFile, $errLine) {
// 若輸出緩衝區有內容,先清空,避免污染 XML
if (ob_get_length()) ob_clean();
$error_message = 'ERRNO: ' . $errNo . chr(10)
. 'TEXT: ' . $errStr . chr(10)
. 'LOCATION: ' . $errFile . ', Line ' . $errLine;
echo $error_message;
exit;
}
?>
流程仍是老三步:開啟連線、執行查詢、關閉連線。MySQL、MSSQL、Oracle 皆可,只要後端記得把結果組回 XML。
當邏輯開始變複雜,把程式拆成四個角色會清楚很多:
appname.php:接受 Client 端請求的入口。appname.class.php:把邏輯、資料庫操作、錯誤處理封裝成類別。config.php:存放設定,例如資料庫連線資訊。error_handler.php:自訂的錯誤處理函式,可跨專案複用。以下用一個「關鍵字提示」功能把整個結構串起來。頁面上有兩個事件:onkeyup 在使用者輸入時即時送出請求,onclick 則在按下搜尋鈕時送出。
<input type="text" id="keyWord" onkeyup="keyup()" /> <input type="button" id="search" onclick="search()" value="search" /> <div id="show"></div>
客戶端的事件函式,重點是「伺服器不忙時才送出新請求」,避免連打 asynchronously 造成回應錯亂:
var keyupAddress = "php/suggest.php?action=keyup&keyWord=";
function keyup() {
if (XMLHttp) {
// 只有在空閒狀態才送出,避免請求堆疊
if (xmlHttp.readyState == 0 || XMLHttp.readyState == 4) {
try {
var keyword = document.getElementById("keyWord").value;
XMLHttp.open("GET", keyupAddress + keyWord, true);
XMLHttp.onreadystatechange = handlereadystatechange;
XMLHttp.send(null);
} catch (e) {
displayError(e.toString());
}
}
}
}
function handlereadystatechange() {
if (XMLHttp.readyState == 4) {
if (XMLHttp.status == 200) {
try {
var xmlResponse = xmlHttp.responseXML;
suggestArray = XMLResponse.getElementsByTagName("suggest");
var showText = "";
for (var i = 0; i < suggestArray.length; i++) {
var textNodes = suggestArray[i].getElementsByTagName("text");
var timesNodes = suggestArray[i].getElementsByTagName("times");
for (var j = 0; j < textNodes.length; j++) {
showText += textNodes[j].childNodes[0].nodeValue
+ " (" + timesNodes[j].childNodes[0].nodeValue + ") <br />";
}
}
display(showText);
} catch (e) {
displayError(e.toString());
}
}
}
}
Server 端的入口腳本,這裡有一個重要細節——明確關閉快取:
<?php
require_once('suggest.class.php');
header('Content-Type: text/xml');
// 確保瀏覽器不會快取結果
header('Expires: Wed, 23 Dec 1980 00:30:00 GMT');
header('Last-Modified: ' . gmdate('D, d M Y H:i:s') . ' GMT');
header('Cache-Control: no-cache, must-revalidate');
header('Pragma: no-cache');
$action = $_GET['action'];
$keyword = $_GET['keyWord'];
$oSuggest = new suggest();
if ($action == 'keyup' && $keyword != '') {
$suggestXML = $oSuggest->getSuggests($keyword);
}
if ($action == 'search' && $keyword != '') {
$suggestXML = $oSuggest->submitKeyword($keyword);
}
echo $suggestXML;
?>
類別本身把連線生命週期交給建構子與解構子,兩個公開方法分別負責「提示」與「提交」:
<?php
require_once('error_handler.php');
require_once('config.php');
class suggest {
private $conn;
function __construct() {
$this->conn = new MySQLi(DB_HOST, DB_USER, DB_PASSWORD, DB_DATABASE);
if (MySQLi_connect_errno()) {
printf("Connect failed: %s ", MySQLi_connect_error());
exit();
}
}
function __destruct() {
$this->conn->close();
}
// 回應 action=keyup:找出前綴相符的關鍵字
public function getSuggests($keyWord) {
$suggest_query = "select * from keywords where keyword like '" . $keyWord
. "%' order by times desc limit 5";
$suggest_result = $this->conn->query($suggest_query);
$suggest_num = $suggest_result->num_rows;
$strOUT = '<?xml version="1.0" encoding="UTF-8" standalone="yes"?>';
if ($suggest_num != 0) {
$strOUT .= "<suggests>";
for ($i = 0; $i < $suggest_num; $i++) {
$suggest_row = $suggest_result->fetch_row();
$strOUT .= '<suggest><text>' . $suggest_row[1]
. '</text><times>' . $suggest_row[2]
. '</times></suggest>';
}
$strOUT .= "</suggests>";
}
return $strOUT;
}
// 回應 action=search:新關鍵字就寫入,舊關鍵字就累加次數
public function submitKeyword($keyWord) {
$select_query = "select * from keywords where keyword='" . $keyWord . "'";
$select_result = $this->conn->query($select_query);
$select_num = $select_result->num_rows;
$strOUT = '<?xml version="1.0" encoding="UTF-8" standalone="yes"?>';
if ($select_num != 0) {
$select_row = $select_result->fetch_row();
$times_now = $select_row[2] + 1;
$update_query = "update keywords set times = " . $times_now
. " where keyword='" . $keyWord . "'";
$this->conn->query($update_query);
$strOUT .= '<suggests><suggest><text>' . $keyWord
. '</text><times>' . $times_now . '</times></suggest></suggests>';
} else {
$insert_query = "insert into keywords(keyword, times) values ('" . $keyWord . "',1)";
$this->conn->query($insert_query);
$strOUT .= '<suggests><suggest><text>' . $keyWord
. '</text><times>1</times></suggest></suggests>';
}
return $strOUT;
}
}
?>
設定與錯誤處理各自獨立成檔:
<?php // config.php
define('DB_HOST', 'localhost');
define('DB_USER', 'PHPAjaxuser');
define('DB_PASSWORD', 'PHPAjaxuser');
define('DB_DATABASE', 'PHPAjax');
?>
最後建立資料表:
CREATE TABLE `keywords` ( `id` int(10) unsigned NOT NULL auto_increment, `keyWord` varchar(32) NOT NULL default '', `times` int(10) unsigned NOT NULL default '0', PRIMARY KEY (`id`) ) TYPE=MyISAM AUTO_INCREMENT=1;
關於快取。上面入口腳本那幾行 header 不是裝飾。AJAX 應用中「請求明明成功卻拿到舊資料」的問題,絕大多數都源自瀏覽器快取,這一層防線該有。
關於示範用的 SQL。範例中的字串拼接寫法在教學上很直白,但實際專案請務必改用 Prepared Statement。使用者輸入的關鍵字直接進 SQL,等同把資料庫門戶洞開。
關於從遠端取資料。若需要讀取其他伺服器上的內容(近似簡易爬蟲),PHP 提供 file_get_contents(),或功能更完整的 cURL ']).注意,however — 讓我重新表述:或功能更完整的 cURL 函式庫。