在 AJAX 開發裡,最基礎也最關鍵的一環,就是如何把數據從瀏覽器送到服務器,再把結果取回來。本文從最簡單的「名/值對」查詢串講起,逐步深入到以 XML 作為數據載體的進階做法,並附上完整的客戶端與服務器端代碼。
當我們只需要傳遞少量鍵值對參數(例如 name=LiLin&age=23)時,XMLHttpRequest 既可以用 GET,也可以用 POST。兩者的差別主要在於參數放置的位置與是否需要設置請求頭。
function doRequestUsingGET() {
createXMLHttpRequest();
var queryString = "GetAndPostExample?";
queryString = queryString + createQueryString() + "&timeStamp=" + new Date().getTime();
XMLHttp.onreadystatechange = handleStateChange;
XMLHttp.open("GET", queryString, true);
XMLHttp.send(null);
}
function doRequestUsingPOST() {
createXMLHttpRequest();
var url = "GetAndPostExample?timeStamp=" + new Date().getTime();
var queryString = createQueryString();
XMLHttp.open("POST", url, true);
XMLHttp.onreadystatechange = handleStateChange;
XMLHttp.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
XMLHttp.send(queryString);
}
值得注意的是,採用 POST 時,為了讓服務器明白請求體裡帶有參數,必須調用 setRequestHeader,把 Content-Type 設為 application/x-www-form-urlencoded。如果不打算把參數放進請求體,那麼改用 GET 會更合適。此外,在 URL 後附加一個時間戳,可以有效避免瀏覽器讀取到緩存中的舊響應。
下面的 Servlet 用同一個 processRequest 方法統一處理 GET 與 POST 兩種請求,避免代碼重複:
import java.io.*;
import java.net.*;
import javax.servlet.*;
import javax.servlet.http.*;
public class GetAndPostExample extends HttpServlet {
protected void processRequest(HttpServletRequest request, HttpServletResponse response, String method)
throws ServletException, IOException {
// 將響應類型設為 text/XML
response.setContentType("text/xml");
// 取得使用者輸入
String firstName = request.getParameter("firstName");
String middleName = request.getParameter("middleName");
String birthday = request.getParameter("birthday");
// 組裝響應內容
String responseText = "Hello " + firstName + " " + middleName
+ ". Your birthday is " + birthday + ". "
+ "[Method: " + method + "]";
// 寫回瀏覽器
PrintWriter out = response.getWriter();
out.println(responseText);
out.close();
}
protected void doGet(HttpServletRequest request, HttpServletResponse response)
throws ServletException, IOException {
processRequest(request, response, "GET");
}
protected void doPost(HttpServletRequest request, HttpServletResponse response)
throws ServletException, IOException {
processRequest(request, response, "POST");
}
}
當參數結構變得複雜,用名/值對已經難以表達時,可以把數據組織成 XML 再送到服務器。客戶端先動態組裝一段 XML 字符串:
function createXML() {
var xml = "<pets>";
var options = document.getElementById("petTypes").childNodes;
var option = null;
for (var i = 0; i < options.length; i++) {
option = options[i];
if (option.selected) {
xml = xml + "<type>" + option.value + "</type>";
}
}
xml = xml + "</pets>";
return xml;
}
function sendPetTypes() {
createXMLHttpRequest();
var xml = createXML();
var url = "PostingXMLExample?timeStamp=" + new Date().getTime();
XMLHttp.open("POST", url, true);
XMLHttp.onreadystatechange = handleStateChange;
XMLHttp.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
XMLHttp.send(xml);
}
createXML 的作用,就是把選中的項目以 DOM 的風格拼裝進 xml 變量裡。有些時候,客戶端也可能直接把本地的一份 XML 文件以 DOM 形式送出(此時 Content-Type 應改為 text/xml),這時往往會用到 ActiveXObject("MSXML2.DOMDocument.3.0") 這樣的解析器控件。
為了在各種瀏覽器下都能取得合適的 XML 解析器,可以寫一段通用的兼容代碼:
// 創建一個新的 XML DOM
function CreateXMLDOM() {
var oXML = new ActiveXObject(GetXMLParserProgID());
try {
oXML.setProperty("AllowXsltScript", true);
} catch (err) {}
oXML.async = false;
oXML.validateOnParse = false;
oXML.resolveExternals = false;
oXML.setProperty("SelectionLanguage", "XPath");
try { oXML.setProperty("NewParser", true); } catch (e) {}
return oXML;
}
// 取得目前可用的最高版本 Microsoft XML 解析器的 ProgID
function GetXMLParserProgID() {
var MAX_MAJOR_PARSER_VERSION = 10;
var MIN_MAJOR_PARSER_VERSION = 0;
var MAX_MINOR_PARSER_VERSION = 9;
var MIN_MINOR_PARSER_VERSION = 0;
var sProgID = g_sXMLParserProgID;
var bFound = false;
if (!sProgID) {
for (var nMajor = MAX_MAJOR_PARSER_VERSION; nMajor >= MIN_MAJOR_PARSER_VERSION; nMajor--) {
for (var nMinor = MAX_MINOR_PARSER_VERSION; nMinor >= MIN_MINOR_PARSER_VERSION; nMinor--) {
sProgID = "MsXML2.DOMDocument." + nMajor + "." + nMinor;
try {
if (new ActiveXObject(sProgID)) {
bFound = true;
break;
}
} catch (e) {}
}
if (bFound) {
g_sXMLParserProgID = sProgID;
break;
}
}
}
return sProgID;
}
拿到 DOM 之後,可以直接用 load 方法加載本地文件:
var xmlDoc = new ActiveXObject("MSXML2.DOMDocument.3.0");
xmlDoc.load(local_XML_FileName);
也可以從服務器取得 XML,再透過 responseText 載入到內存中的 DOM:
xmlht.open("GET", server_XML_FileName, true);
xmlht.onreadystatechange = stateChange;
xmlht.send(null);
function handleStateChange() {
if (XMLHttp.readyState == 4) {
if (XMLHttp.status == 200) {
xmlDoc.loadXML(xmlht.responseText);
}
}
}
需要留意的是,loadXML(xmlht.responseText) 得到的是一份存在於內存中的 DOM;而直接使用 responseXML 則可以一步得到解析好的 DOM。請注意 load(文件) 與 loadXML(DOM 字符串) 兩者並不相同。
服務器端收到 XML 後,用 W3C DOM 進行解析,取出感興趣的節點:
import java.io.*;
import javax.servlet.*;
import javax.servlet.http.*;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import org.w3c.dom.Document;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
public class PostingXMLExample extends HttpServlet {
protected void doPost(HttpServletRequest request, HttpServletResponse response)
throws ServletException, IOException {
String xml = readXMLFromRequestBody(request);
Document xmlDoc = null;
try {
xmlDoc = DocumentBuilderFactory.newInstance().newDocumentBuilder()
.parse(new ByteArrayInputStream(xml.getBytes()));
} catch (ParserConfigurationException e) {
System.out.println("ParserConfigurationException: " + e);
} catch (SAXException e) {
System.out.println("SAXException: " + e);
}
// Java 版 W3C DOM 與 JavaScript 版擁有相同的方法,例如 getElementsByTagName
NodeList selectedPetTypes = xmlDoc.getElementsByTagName("type");
String type = null;
String responseText = "Selected Pets: ";
for (int i = 0; i < selectedPetTypes.getLength(); i++) {
type = selectedPetTypes.item(i).getFirstChild().getNodeValue();
responseText = responseText + " " + type;
}
response.setContentType("text/xml");
response.getWriter().print(responseText);
}
private String readXMLFromRequestBody(HttpServletRequest request) {
StringBuffer xml = new StringBuffer();
String line = null;
try {
BufferedReader reader = request.getReader();
while ((line = reader.readLine()) != null) {
xml.append(line);
}
} catch (Exception e) {
System.out.println("Error reading XML: " + e.toString());
}
return xml.toString();
}
}
至於要在服務器端用哪一套 DOM 實現,無論是 DOM、JDOM 還是 JAXP,都可以依團隊習慣自由選擇。