AJAX 核心 API(也就是 XMLHttpRequest)唯一的用途就是送出 HTTP 請求,在瀏覽器與伺服器之間交換資料。頁面中的 JavaScript 可以用它把參數送到伺服器端的 Servlet 或 JSP,對方回傳的資料則用來更新畫面的一部分,而不必刷新整頁。這種做法在效能與可用性上都有明顯優勢:網路流量下降,Web UI 的使用感受接近桌面 GUI。
但代價是複雜度:你必須在客戶端用 JavaScript、在伺服器端用 Java(或等效語言)實作資料交換、驗證與處理。以下說明一套完整的做法。
把資料送到伺服器最簡單的方式是編碼成查詢字串,依 HTTP 方法附加在 URL 之後或放進請求本文;若結構複雜,更好的方案是把資訊編碼成 XML 文件。
傳統 Web 應用不必操心表單編碼,瀏覽器會自動處理;但在 AJAX 應用中,你必須自己編碼。JavaScript 的 escape() 會把無法作為 URL 一部分的字元換成 %HH 形式(例如空白變成 %20)。以下工具函式把參數陣列串成查詢字串:
function buildQueryString(params) {
var query = "";
for (var i = 0; i < params.length; i++) {
query += (i > 0 ? "&" : "")
+ escape(params[i].name) + "="
+ escape(params[i].value);
}
return query;
}
若要編碼這組參數:
var someParams = [
{ name: "name", value: "John Smith" },
{ name: "email", value: "john@company.com" },
{ name: "phone", value: "(123) 456 7890" }
];
呼叫結果為:
name=John%20Smith&email=john@company.com&phone=%28123%29%20456%207890
用 GET 時,把查詢字串接在 URL 的 ? 之後;用 POST 時,必須先透過 setRequestHeader() 把 Content-Type 設為 application/x-www-form-urlencoded,再把字串傳給 XMLHttpRequest 的 send()。
用 JavaScript 組 XML 最簡單的方式就是以字串拼接,此時需要一個轉義工具:
function escapeXML(content) {
if (content == undefined) return "";
if (!content.length || !content.charAt) content = new String(content);
var result = "";
var length = content.length;
for (var i = 0; i < length; i++) {
var ch = content.charAt(i);
switch (ch) {
case '&': result += "&"; break;
case '<': result += "<"; break;
case '>': result += ">"; break;
case '"': result += """; break;
case "'": result += "'"; break;
default: result += ch;
}
}
return result;
}
function attribute(name, value) {
return " " + name + "=\"" + escapeXML(value) + "\"";
}
function buildPortfolioDoc(stocks) {
var xml = "<portfolio>";
for (var i = 0; i < stocks.length; i++) {
var stock = stocks[i];
xml += "<stock ";
xml += attribute("symbol", stock.symbol);
xml += attribute("shares", stock.shares);
xml += attribute("paidPrice", stock.paidPrice);
xml += "/>";
}
xml += "</portfolio>";
return xml;
}
若偏好 DOM,可用瀏覽器 API 分析與序列化。IE 用 new ActiveXObject("Microsoft.XMLDOM") 建立空文件,再以 loadXML() 或 load() 從字串或 URL 載入;每個節點都有 xml 屬性可取得含子節點的 XML 表示。Firefox 與 Netscape 則用 document.implementation.createDocument(...) 建立文件,配合 createElement()、createTextNode()、createCDATASection() 建構節點,並以 DOMParser 與 XMLSerializer 完成分析與序列化。
function parse(xml) {
var dom;
try {
dom = new ActiveXObject("Microsoft.XMLDOM");
dom.async = false;
dom.loadXML(xml);
} catch (error) {
try {
var parser = new DOMParser();
dom = parser.parseFromString(xml, "text/xml");
delete parser;
} catch (error2) {
if (debug) alert("XML parsing is not supported.");
}
}
return dom;
}
function serialize(dom) {
var xml = dom.xml;
if (xml == undefined) {
try {
var serializer = new XMLSerializer();
xml = serializer.serializeToString(dom);
delete serializer;
} catch (error) {
if (debug) alert("DOM serialization is not supported.");
}
}
return xml;
}
此外,XMLHttpRequest 本身也能充當分析器與序列化器:回應會被自動分析,可透過 responseText 與 responseXML 分別取得文字與 DOM;把 DOM 樹傳給 send() 時則會自動序列化。
以下範例的情境是:從資料饋送取得股價,並定期自動刷新,不需要使用者介入。因此應異步送出請求以免阻塞介面;參數只是股票代號陣列,用 URL 編碼即可,不必為頻繁請求傳 XML 文件;由於只關心最新價格,任何未完成的舊請求都該中止:
var ctrlURL = "AjaxCtrl.jsp";
var feedRequest = null;
function sendInfoRequest(symbols, callback) {
if (feedRequest) abortRequest(feedRequest);
var params = new Array();
for (var i = 0; i < symbols.length; i++)
params[i] = { name: "symbol", value: symbols[i] };
feedRequest = sendHttpRequest("GET", ctrlURL, params, callback);
}
function abortRequest(request) {
function doNothing() {}
request.onreadystatechange = doNothing;
request.abort();
delete feedRequest;
}
中止前先把 onreadystatechange 換成空回呼,避免中止動作又觸發一次處理;而 delete 掉請求物件是避免 IE 記憶體洩流的關鍵步驟。
另一種情境:要傳送整份需存入資料庫的使用者資料。此時應同步送出,以免使用者在儲存過程中又改了內容;格式首選 XML,因為在文件中編碼物件模型通常比塞一大堆字串參數簡單,且這類請求不頻繁,伺服器負載不成問題:
function sendSaveRequest(xml) {
var params = [ { name: "xml", value: xml } ];
var saveRequest = sendHttpRequest("POST", ctrlURL, params);
if (saveRequest) delete saveRequest;
}
而從伺服器取回物件模型時,也可以同步送出,並讓伺服器回傳 JSON,前端用 eval() 就能還原成 JavaScript 物件樹:
function sendLoadRequest() {
var model = null;
var loadRequest = sendHttpRequest("GET", ctrlURL);
if (loadRequest) {
model = eval(loadRequest.responseText);
delete loadRequest;
}
return model;
}
Servlet/JSP 容器會分析每個 HTTP 請求並建立 ServletRequest 執行個體,可透過 getParameter() / getParameterValues() 取得參數,或用 getInputStream() 取得請求本文;JSP 中也可用 EL 語法(${param...})。請注意:只有當客戶端用 application/x-www-form-urlencoded 編碼時,才能用 getParameter() 取得;若客戶端傳的是 XML 文件或 DOM 樹,就必須用 getInputStream()。
典型 Web 應用會做大量驗證,多數錯誤很單純:缺少參數、數字格式錯誤等,通常由使用者漏填或填錯造成。AJAX 應用可以在客戶端用 JavaScript 先攔一次,例如以 isNaN(new Number(value)) 檢查數字。但基於安全與可靠性,伺服器端必須重新驗證,不能預設 XML 格式正確。XML 結構描述(Schema)是驗證複雜請求的有用工具。
以下以標準 JAXP 說明。先初始化 SchemaFactory:
import javax.xml.*;
import javax.xml.validation.*;
protected static SchemaFactory schemaFactory;
static {
schemaFactory = SchemaFactory.newInstance(
XMLConstants.W3C_XML_SCHEMA_NS_URI);
schemaFactory.setErrorHandler(new ErrorHandler());
}
錯誤處理器:
import org.xml.sax.*;
public static ErrorHandler newErrorHandler() {
return new ErrorHandler() {
public void warning(SAXParseException e) throws SAXException {
Logger.global.warning(e.getMessage());
}
public void error(SAXParseException e) throws SAXException { throw e; }
public void fatalError(SAXParseException e) throws SAXException { throw e; }
};
}
從 classpath 載入 XSD:
public static InputStream getResourceAsStream(String name)
throws IOException {
InputStream in = XMLUtil.class.getResourceAsStream(name);
if (in == null) throw new FileNotFoundException(name);
return in;
}
public static Schema newSchema(String name)
throws IOException, SAXException {
Schema schema;
InputStream in = getResourceAsStream(name);
try {
schema = schemaFactory.newSchema(new StreamSource(in));
} finally {
in.close();
}
return schema;
}
接著建立解析器工廠與解析器:
public static DocumentBuilderFactory newParserFactory(String schemaName)
throws IOException, SAXException {
DocumentBuilderFactory parserFactory = DocumentBuilderFactory.newInstance();
try {
parserFactory.setSchema(newSchema(schemaName));
} catch (UnsupportedOperationException e) {
// 若 classpath 中是 JAXP 1.1 實作,setSchema() 可能不支援
}
return parserFactory;
}
public static DocumentBuilder newParser(DocumentBuilderFactory parserFactory)
throws ParserConfigurationException {
DocumentBuilder parser = parserFactory.newDocumentBuilder();
parser.setErrorHandler(new ErrorHandler());
return parser;
}
假設要用以下 portfolio.xsd 驗證文件:
<xsd:schema xmlns:xsd="https://www.w3.org/2001/XMLSchema">
<xsd:element name="portfolio" type="portfolioType"/>
<xsd:complexType name="portfolioType">
<xsd:sequence>
<xsd:element name="stock" minOccurs="0" maxOccurs="unbounded">
<xsd:complexType>
<xsd:attribute name="symbol" type="xsd:string" use="required"/>
<xsd:attribute name="shares" type="xsd:positiveInteger" use="required"/>
<xsd:attribute name="paidPrice" type="xsd:decimal" use="required"/>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:schema>
DataModel 的 parsePortfolioDoc() 便用它驗證並分析 XML 參數:
private static final String SCHEMA_NAME = "/ajaxapp/model/portfolio.xsd";
private static DocumentBuilderFactory parserFactory;
private static Document parsePortfolioDoc(String xml)
throws IOException, SAXException, ParserConfigurationException {
synchronized (DataModel.class) {
if (parserFactory == null)
parserFactory = XMLUtil.newParserFactory(SCHEMA_NAME);
}
DocumentBuilder parser = XMLUtil.newParser(parserFactory);
InputSource in = new InputSource(new StringReader(xml));
return parser.parse(in);
}
可以用 DOM API 逐層走訪,也可以用 XPath 這類查詢語言。Java 為 XPath 提供了標準 API:
import javax.xml.xpath.*;
protected static XPathFactory xpathFactory;
static { xpathFactory = XPathFactory.newInstance(); }
public static XPath newXPath() { return xpathFactory.newXPath(); }
public static String evalToString(String expression, Object context)
throws XPathExpressionException {
return (String) newXPath().evaluate(expression, context, XPathConstants.STRING);
}
public static boolean evalToBoolean(String expression, Object context)
throws XPathExpressionException {
return ((Boolean) newXPath().evaluate(
expression, context, XPathConstants.BOOLEAN)).booleanValue();
}
public static double evalToNumber(String expression, Object context)
throws XPathExpressionException {
return ((Double) newXPath().evaluate(
expression, context, XPathConstants.NUMBER)).doubleValue();
}
public static Node evalToNode(String expression, Object context)
throws XPathExpressionException {
return (Node) newXPath().evaluate(expression, context, XPathConstants.NODE);
}
public static NodeList evalToNodeList(String expression, Object context)
throws XPathExpressionException {
return (NodeList) newXPath().evaluate(expression, context, XPathConstants.NODESET);
}
DataModel 用這些方法從文件取出資料:
public synchronized void setData(String xml)
throws IOException, SAXException, ParserConfigurationException,
XPathExpressionException {
try {
ArrayList stockList = new ArrayList();
Document doc = parsePortfolioDoc(xml);
NodeList nodeList = XMLUtil.evalToNodeList("/portfolio/stock", doc);
for (int i = 0; i < nodeList.getLength(); i++) {
Node node = nodeList.item(i);
StockBean stock = new StockBean();
stock.setSymbol(XMLUtil.evalToString("@symbol", node));
stock.setShares((int) XMLUtil.evalToNumber("@shares", node));
stock.setPaidPrice(XMLUtil.evalToNumber("@paidPrice", node));
stockList.add(stock);
}
this.stockList = stockList;
} catch (Exception e) {
Logger.global.logp(Level.SEVERE, "DataModel", "setData",
e.getMessage(), e);
}
}
最省事的方案是直接回傳 HTML,客戶端用 innerHTML 塞進頁面的 div 或 span。但只回傳不含呈現標記的資料更有效率,XML 與 JSON 都是好選擇。
產生 XML。Java EE 提供多種途徑:用 JSP 產生、用 JAXB 從物件樹產生,或用 javax.xml.transform 序列化 DOM:
import javax.xml.transform.*;
import javax.xml.transform.dom.*;
import javax.xml.transform.stream.*;
public static TransformerFactory serializerFactory;
static { serializerFactory = TransformerFactory.newInstance(); }
public static void serialize(Node node, OutputStream out)
throws TransformerException {
Transformer serializer = serializerFactory.newTransformer();
Properties props = new Properties();
props.put(OutputKeys.METHOD, "xml");
serializer.setOutputProperties(props);
Source source = new DOMSource(node);
Result result = new StreamResult(out);
serializer.transform(source, result);
}
伺服器端選項很多,客戶端卻受限——只能用 DOM 分析 XML,部分瀏覽器另支援 XPath 與 XSLT。
改用 JSON。JSON 字串可用 eval() 直接變成 JavaScript 物件樹,比從 DOM 逐節點取值簡單得多,關鍵是伺服器端要有一個好用的編碼器:
package ajaxapp.util;
public class JSONEncoder {
private StringBuilder buf;
public JSONEncoder() { buf = new StringBuilder(); }
public void character(char ch) {
switch (ch) {
case '"':
case '\\':
buf.append('\\'); buf.append(ch); break;
case '\n': buf.append('\\'); buf.append('n'); break;
case '\r': buf.append('\\'); buf.append('r'); break;
default:
if (ch >= 32 && ch < 128) {
buf.append(ch);
} else {
buf.append('\\'); buf.append('u');
for (int j = 12; j >= 0; j -= 4) {
int k = (((int) ch) >> j) & 0x0f;
int c = k < 10 ? '0' + k : 'a' + k - 10;
buf.append((char) c);
}
}
}
}
public void string(String str) {
int length = str.length();
for (int i = 0; i < length; i++) character(str.charAt(i));
}
public void literal(Object value) {
if (value instanceof String) {
buf.append('"'); string((String) value); buf.append('"');
} else if (value instanceof Character) {
buf.append('\''); character(((Character) value).charValue()); buf.append('\'');
} else {
buf.append(value.toString());
}
}
private void comma() { buf.append(','); }
private void deleteLastComma() {
if (buf.length() > 0 && buf.charAt(buf.length() - 1) == ',')
buf.deleteCharAt(buf.length() - 1);
}
public void startObject() { buf.append('{'); }
public void property(String name, Object value) {
buf.append(name); buf.append(':'); literal(value); comma();
}
public void endObject() { deleteLastComma(); buf.append('}'); comma(); }
public void startArray() { buf.append('['); }
public void element(Object value) { literal(value); comma(); }
public void endArray() { deleteLastComma(); buf.append(']'); comma(); }
public String toString() { deleteLastComma(); return buf.toString(); }
public void clear() { buf.setLength(0); }
}
DataModel 用它編碼自己維護的資料:
public synchronized String getData() {
JSONEncoder json = new JSONEncoder();
json.startArray();
for (int i = 0; i < stockList.size(); i++) {
StockBean stock = stockList.get(i);
json.startObject();
json.property("symbol", stock.getSymbol());
json.property("shares", stock.getShares());
json.property("paidPrice", stock.getPaidPrice());
json.endObject();
}
json.endArray();
return json.toString();
}
AjaxCtrl.jsp 收到 XML 參數時設定模型資料,否則用 EL 輸出 JSON:
<%@ taglib prefix="c" uri="https://java.sun.com/jsp/jstl/core" %>
<jsp:useBean id="dataModel" scope="session" class="ajaxapp.model.DataModel" />
<c:choose>
<c:when test="${!empty param.xml}">
<c:set target="${dataModel}" property="data" value="${param.xml}" />
</c:when>
<c:otherwise>${dataModel.data}</c:otherwise>
</c:choose>
傳統 Web 應用由伺服器端(JSP、Web 框架、標記庫)產生內容;AJAX 應用則需要你用 JavaScript 在客戶端動態產生內容。Web 框架(如 JavaServer Faces、Oracle ADF Faces)在這類場景同樣有用,但 AJAX 與非 AJAX 之間仍有明顯差異。
若採用 JSON,用 eval() 轉成物件樹非常輕鬆;若採用 XML,步驟較多,但XML有它的優勢:許多類型的客戶端都能處理 XML,而 JSON 只在 JavaScript 環境中易於分析;此外 XML 的錯誤較容易定位,除錯時間更短。
以 JavaScript 存取 DOM。JavaScript 的 DOM API 與 Java 的 org.w3c.dom 極為相似,主要差別在屬性存取:JavaScript 可直接讀寫屬性,Java 則視屬性為私有,須透過 getter/setter。例如 dom.documentElement 即可取得根元素。
DOM 是低階 API,多數時候你會想略過註解、也不想處理相鄰的文字節點。看個例子:
var xml = "<element>da<!--comment-->ta&" +
"<![CDATA[cdata</element>";
var dom = parse(xml);
此時根元素下會有一個文字節點、一則註解、另一個文字節點,以及一個 CDATA 節點。若想取得不含註解的純文字,必須遍歷子節點並串接類型為 3(Text)與 4(CDATA)的值:
var element = dom.documentElement;
var childNodes = element.childNodes;
var text = "";
for (var i = 0; i < childNodes.length; i++) {
if (childNodes[i].nodeValue) {
var type = childNodes[i].nodeType;
if (type == 3 || type == 4) text += childNodes[i].nodeValue;
}
}
實務上應把這些低階細節包成一小組工具函式,避免在商業邏輯裡到處寫節點走訪。
用 JavaScript 動態產生內容。瀏覽器讓你透過 document 物件存取頁面的 DOM,用 document.getElementById() 找元素、用 createElement() 建節點。不過以字串拼接 HTML 往往更簡單:
function updateInfo(request) {
var shares = eval(request.responseText);
var table = "<table border=1 cellpadding=5>";
table += "<tr><th>Symbol</th><th>Trend</th><th>Last Price</th></tr>";
for (var i = 0; i < shares.length; i++) {
var share = shares[i];
var symbol = escapeXML(share.symbol);
var trend = share.trend > 0 ? "+" : "-";
var lastPrice = new Number(share.lastPrice).toFixed(2);
table += "<tr><td>" + symbol + "</td><td>" + trend
+ "</td><td>" + lastPrice + "</td></tr>";
}
table += "</table>";
document.getElementById("table").innerHTML = table;
}
把產生的 HTML 塞進一個空的容器元素即可:
<div id="table"></div>
若要每 5 秒更新一次,用 setInterval():
var symbols = [ /* ... */ ];
setInterval("sendInfoRequest(symbols, updateInfo)", 5000);
伺服器端由名為 DataFeed 的類別模擬資料饋送,AjaxCtrl.jsp 呼叫它的 getData() 並以 JSON 字串回應;客戶端的 updateInfo() 則用 eval() 解析。
範例中多處使用 eval() 解析伺服器回應,這在正式環境應改用 JSON.parse(),並在伺服器端設定正確的 Content-Type;否則一旦資料來源被污染,eval() 等同執行任意程式碼。此外,DOM 走訪與 HTML 拼接時都應對外部資料做轉義(如範例中的 escapeXML()),避免 XSS。