跟伺服器交換資料,最簡單的情況是送出一組「名稱/值」配對的查詢字串。這種規模下 XHR 用 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);
}
queryString 就是 name=LiLin&age=23 這種形式。用 POST 時務必呼叫 setRequestHeader 把 Content-Type 設為 application/x-www-form-urlencoded,伺服器才知道請求本文裡帶了參數。附帶一提,兩段程式都加上了時間戳記,目的是繞過瀏覽器快取,避免拿到舊回應。
public class GetAndPostExample extends HttpServlet {
protected void processRequest(HttpServletRequest request, HttpServletResponse response, String method)
throws ServletException, IOException {
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");
}
}
GET 與 POST 都交給同一個 processRequest 處理,只是帶入的 method 名稱不同,這樣在回應裡就能看出客戶端實際用了哪一種。
當要送的資料不是幾組簡單的鍵值,而是一份有層次的結構時,把模型序列化成 XML 再送出去會清楚得多。
function createXML() {
var xml = "<pets>";
var options = document.getElementById("petTypes").childNodes;
for (var i = 0; i < options.length; i++) {
var 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", "text/xml");
XMLHttp.send(xml);
}
createXML 只是把內容組裝成 XML 字串。若客戶端要送的是本地檔案,且 Content-Type 改為 text/xml,就會需要 ActiveXObject("MSXML2.DOMDocument.3.0") 這類 XML DOM 物件。跨瀏覽器建立 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;
}
// 取得可用的最高版本 MSXML 解析器 ProgID
function GetXMLParserProgID() {
var MAX_MAJOR_PARSER_VERSION = 10, MIN_MAJOR_PARSER_VERSION = 0;
var MAX_MINOR_PARSER_VERSION = 9, 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,再塞進 DOM:
xmlht.open("GET", server_XML_FileName, true);
xmlht.onreadystatechange = stateChange;
xmlht.send(null);
function handleStateChange() {
if (XMLHttp.readyState == 4 && XMLHttp.status == 200) {
xmlDoc.loadXML(XMLht.responseText);
}
}
請注意 load(檔案) 與 loadXML(字串) 是兩回事,不要混用。而如果你用的是 responseXML,拿到的已經是一個可直接查詢的 DOM,不必再自己解析一次。
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 與 getNodeValue
NodeList selectedPetTypes = XMLDoc.getElementsByTagName("type");
String responseText = "Selected Pets: ";
for (int i = 0; i < selectedPetTypes.getLength(); i++) {
String 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();
}
}
要在 Java 端操作 XML,DOM、JDOM、JAXP 任君挑選,API 風格相近,差別主要在記憶體佔用與 API 友善度。
實務上還有一點值得牢記:無論走 GET、POST 還是 XML,收到 XML 回應後都應先檢查 status == 200 再解析,並用 try/catch 包住解析動作。格式不合法的回應若直接丟進 DOM,例外訊息通常很難讀。