最近在學 JavaScript,發現不論是 Ext 還是 Prototype 都很推崇 JSON 這種通訊協定格式。但這兩個框架都偏前端:它們把 JSON 介面設定好、並封裝了 AJAX 通訊,屬於比較「純粹」的 AJAX 實作(Ext 另外還附帶大量圖形元件,那是另一個話題了)。DWR 則不同,它是一套一站式的 AJAX 框架,不只提供客戶端工具方法,也包含服務端的設定與通訊處理。
問題就在這裡:若只用 Ext 這類前端框架,為了處理通訊而逐一定義 Servlet,實作起來既原始又難以管理。網路上因此常見兩種折衷——用 DWR 來管理通訊,或用 Struts 之類的框架做 JavaScript 映射設定。但這些做法都會把客戶端與服務端的功能切割得七零八落,顯得不夠「乾淨」。
於是我寫了下面兩個 Servlet 來回應這個問題。核心概念是:以 action 參數指定要呼叫的類別與方法,用反射動態呼叫;以 json 參數傳入 JSON 字串交給 Action 自行解析;其餘請求參數則自動對應到 setter 注入;最後把方法回傳值序列化成 JSON 寫回響應。
程式碼如下:
JSONServlet.java:
package com.digitalchina.dcscm.service;
import java.io.*;
import java.lang.reflect.Method;
import java.util.Enumeration;
import java.util.HashMap;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.json.*;
/**
* 通用 JSON 服務端
*
* @author 楊一
*/
public class JSONServlet extends javax.servlet.http.HttpServlet
implements javax.servlet.Servlet {
public JSONServlet() {
super();
}
protected void doPost(HttpServletRequest request,
HttpServletResponse response)
throws ServletException, IOException {
JSONObject jsonObject = null;
String responseText = null;
try {
// JSON 物件,由參數 json 定義
jsonObject = new JSONObject(request.getParameter("json"));
// 要存取的類別與方法,例如 Object ExampleClass.exampleMethod()
String action = (String) request.getParameter("action");
int dotPos = action.lastIndexOf(".");
String beanName = action.substring(0, dotPos);
String methodName = action.substring(dotPos + 1);
// 在當前線程環境中找該類別的實例
Object bean = findInstance(beanName);
Class clazz;
// 若無實例則建立並存入線程,否則取其原型
if (bean == null) {
clazz = Class.forName(beanName);
bean = clazz.newInstance();
storeInstance(beanName, bean);
} else {
clazz = bean.getClass();
}
// 設定 JSON 值
AbstractJSONAction aja = (AbstractJSONAction) bean;
aja.initJson(jsonObject);
// 取得要執行的方法
Method m = clazz.getMethod(methodName);
// 其餘請求參數以 setter 注入 bean
Enumeration e = request.getParameterNames();
Method setM;
while (e.hasMoreElements()) {
String str = (String) e.nextElement();
if (str.equals("json") || str.equals("action")) {
continue;
}
StringBuffer sb = new StringBuffer();
sb.append("set");
sb.append(upperFirstChar(str));
String tempMName = sb.toString();
setM = clazz.getMethod(tempMName, new Class[]{String.class});
setM.invoke(bean, (String) request.getParameter(str));
}
// 執行方法
Object retObj = m.invoke(bean);
// 回傳的 Object 需覆寫 toString(),回傳一段 JSON 字串給客戶端
responseText = retObj.toString();
} catch (Exception ex) {
ex.printStackTrace();
}
response.setCharacterEncoding("UTF-8");
response.setContentType("application/x-json");
response.getWriter().print(responseText);
}
private String upperFirstChar(String fieldName) {
char ch = fieldName.charAt(0);
ch = Character.toUpperCase(ch);
StringBuffer sb = new StringBuffer();
sb.append(ch);
sb.append(fieldName.substring(1));
fieldName = sb.toString();
return fieldName;
}
private Object findInstance(String beanName) {
HashMap hm = (HashMap) tl.get();
return hm.get(beanName);
}
private void storeInstance(String beanName, Object bean) {
HashMap hm = (HashMap) tl.get();
hm.put(beanName, bean);
}
private static ThreadLocal tl = new ThreadLocal() {
protected Object initialValue() { return new HashMap(); };
};
}
這份實作有幾個值得留意的設計取捨:用 ThreadLocal 保存請求間的實例,讓同一使用者工作階段中的狀態得以延續;用反射把參數名自動映射成 setter,省掉大量樣板程式;並以 application/x-json 作為 Content-Type,讓前端框架能直接辨識並解析。
當然,反射式呼叫必須自行承擔風險:Action 名稱與方法名稱來自請求端,若未做好白名單驗證,等於把任意類別呼叫的大門敞開。正式環境中建議限制可存取的套件或類別清單。