三種型別的處理方式,整體結構幾乎一樣,差別只在「如何解析回應」。以下逐一說明,最後再把它們合併成一個通用函式。
這是最簡單的一種,直接把回應字串拿來用即可。封裝如下:
/**
* 以 Ajax 交換資料(Text/HTML 格式)
* @param url 請求頁面
* @param jsonData 以 Json 傳遞的待送資料
* @param getMsg 取得處理後資料的回呼
*/
function ajaxText(url, jsonData, getMsg) {
// 建立 Ajax 物件,ActiveXObject 用於相容舊版 IE
var oAjax = window.XMLHttpRequest ? new XMLHttpRequest() : new ActiveXObject("Microsoft.XMLHTTP");
oAjax.open('POST', url, true); // 方法、網址、非同步
// 把物件拼成查詢字串
var data = '';
for (var d in jsonData) {
data += (d + '=' + jsonData[d] + '&');
}
oAjax.setRequestHeader("Content-type", "application/x-www-form-urlencoded");
oAjax.send(data);
oAjax.onreadystatechange = function () {
if (oAjax.readyState == 4 && oAjax.status == 200) {
if (getMsg) getMsg(oAjax.responseText);
}
};
}
伺服器端:
// 若為 XML 請改成 header("Content-Type:text/xml;charset=utf-8");
header("Content-Type:text/html;charset=utf-8");
header("Cache-Control:no-cache"); // 避免資料相同時被快取
$username = $_POST['username'];
if (empty($username)) echo '請輸入用戶名';
else if ($username == 'acme') echo '用戶名已被注冊';
else echo '用戶名可用';
呼叫方式:
var url = 'abc.php';
var jsonData = { username: 'acme', passw: 'acme' };
ajaxText(url, jsonData, getMsg);
function getMsg(msg) {
// 在這裡處理 msg
}
此時回應是一個 XML DOM 物件,取值方式與 HTML DOM 操作類似:先用標籤名稱取得節點集合,再從中取出需要的節點,最後讀取其文字節點的值。
/**
* 以 Ajax 交換資料(XML 格式)
* @param tagName 要取值的標籤名稱
*/
function ajaxXML(url, jsonData, tagName, getMsg) {
var oAjax = window.XMLHttpRequest ? new XMLHttpRequest() : new ActiveXObject("Microsoft.XMLHTTP");
oAjax.open('POST', url, true);
var data = '';
for (var d in jsonData) {
data += (d + '=' + jsonData[d] + '&');
}
oAjax.setRequestHeader("Content-type", "application/x-www-form-urlencoded");
oAjax.send(data);
oAjax.onreadystatechange = function () {
if (oAjax.readyState == 4 && oAjax.status == 200) {
var oXml = oAjax.responseXML; // XML DOM 物件
var oTag = oXml.getElementsByTagName(tagName);
var tagValue = oTag[0].childNodes[0].nodeValue;
if (getMsg) getMsg(tagValue);
}
};
}
伺服器端輸出 XML:
header("Content-Type:text/xml;charset=utf-8");
header("Cache-Control:no-cache");
$username = $_POST['username'];
if (empty($username)) echo '<user><mes>請輸入用戶名</mes></user>';
else if ($username == 'acme') echo '<user><mes>用戶名已被注冊</mes></user>';
else echo '<user><mes>用戶名可用</mes></user>';
呼叫方式:
var url = 'abc.php';
var jsonData = { username: 'acme' };
ajaxXML(url, jsonData, 'mes', getMsg);
function getMsg(msg) {
// 在這裡處理 msg
}
/**
* 以 Ajax 交換資料,回應為 JSON 格式的文字
*/
function ajaxJson(url, jsonData, getMsg) {
var oAjax = window.XMLHttpRequest ? new XMLHttpRequest() : new ActiveXObject("Microsoft.XMLHTTP");
oAjax.open('POST', url, true);
var data = '';
for (var d in jsonData) {
data += (d + '=' + jsonData[d] + '&');
}
oAjax.setRequestHeader("Content-type", "application/x-www-form-urlencoded");
oAjax.send(data);
oAjax.onreadystatechange = function () {
if (oAjax.readyState == 4 && oAjax.status == 200) {
// 把字串解析成 JSON 物件
var json = eval('(' + oAjax.responseText + ')');
if (getMsg) getMsg(json);
}
};
}
伺服器端:
header("Content-Type:text/html;charset=utf-8");
header("Cache-Control:no-cache");
$username = $_POST['username'];
if (empty($username)) echo '{"mes":"請輸入用戶名"}';
else if ($username == 'acme') echo '{"mes":"用戶名已被注冊"}';
else echo '{"mes":"用戶名可用"}';
/**
* 以 Ajax 交換資料
* @param url 請求頁面
* @param jsonData 以 Json 傳遞的待送資料
* @param getMsg 取得處理後資料的回呼
* @param type 接受的資料型別:text / xml / json
* @param tagName type 為 xml 時,要取值的標籤名稱
*/
function ajax(url, jsonData, getMsg, type, tagName) {
var oAjax = window.XMLHttpRequest ? new XMLHttpRequest() : new ActiveXObject("Microsoft.XMLHTTP");
oAjax.open('POST', url, true);
var data = '';
for (var d in jsonData) {
data += (d + '=' + jsonData[d] + '&');
}
oAjax.setRequestHeader("Content-type", "application/x-www-form-urlencoded");
oAjax.send(data);
oAjax.onreadystatechange = function () {
if (oAjax.readyState == 4 && oAjax.status == 200) {
if (type == 'text') {
if (getMsg) getMsg(oAjax.responseText);
} else if (type == 'json') {
var json = eval('(' + oAjax.responseText + ')');
if (getMsg) getMsg(json);
} else if (type == 'xml') {
var oXml = oAjax.responseXML;
var oTag = oXml.getElementsByTagName(tagName);
if (getMsg) getMsg(oTag[0].childNodes[0].nodeValue);
}
}
};
}
這份程式碼的精神是正確的,但放到今天有三處值得更新。
用 JSON.parse 取代 eval。eval 會執行字串中的任意程式碼,若回應內容遭到竄改就是一個攻擊入口;JSON.parse 只解析資料、不執行程式。
用 encodeURIComponent 編碼。目前直接把值拼進查詢字串,遇到 &、=、空白或中文就會出錯。更好的做法是用 URLSearchParams 或 FormData 讓瀏覽器代劳編碼。
改用 fetch 或 Promise 封裝。原生 fetch() 天生回傳 Promise,語意比 onreadystatechange 清楚得多,錯誤處理也更容易寫對。
另外要提醒:三種型別中,XML 在今日的公開 API 已相對少見,新專案除非要對接舊系統,否則直接採用 JSON 會省下不少力氣。