DWR(Direct Web Remoting)是一個 Web 遠端呼叫框架,它讓 AJAX 開發變得輕鬆許多。有了 DWR,你可以在客戶端用 JavaScript 直接呼叫服務端的 Java 方法並取得回傳值,寫起來就跟本地呼叫一樣——因為 DWR 會依據 Java 類別動態產生對應的 JavaScript 程式碼。0.6 版加入了 DOM Tree 自動配置、Spring 整合(可遠端呼叫 Spring bean)、更好的瀏覽器支援,以及一個可選的 commons-logging 日誌功能。
它的原理是透過反射把 Java 翻譯成 JavaScript,再利用回呼機制完成呼叫。整個開發流程大致是:
1. 撰寫與 DWR 無關的業務程式碼。
2. 決定哪些類別、哪些方法要開放給 JavaScript 直接存取。
3. 撰寫 DWR 元件,把第 2 步的方法包裝起來。
4. 在 dwr.xml 中設定元件,必要時設定 convert 進行 Java 與 JavaScript 的型別互轉。
5. DWR 透過反射把設定好的類別轉成 JavaScript,交給前台頁面呼叫。
6. 撰寫網頁呼叫這些方法,間接執行服務端邏輯,結果透過回呼函式取回,再繼續寫後續處理。
以下用使用者註冊當例子(為了聚焦在 DWR 用法,類別設計並非最佳實踐)。
User——純資料物件:
public class User {
private String id; // 登陸 ID,主鍵唯一
private String name; // 姓名
private String password; // 口令
private String email; // 電子郵件
// 其餘為 getXXX / setXXX
}
UserDAO——示範用的資料存取,這裡用一個靜態 Map 充當資料庫:
public class UserDAO {
private static Map dataMap = new HashMap();
public boolean save(User user) {
if (dataMap.containsKey(user.getId())) return false;
System.out.println("id:" + user.getId());
System.out.println("password:" + user.getPassword());
System.out.println("name:" + user.getName());
System.out.println("email:" + user.getEmail());
dataMap.put(user.getId(), user);
return true;
}
public User find(String id) {
return (User) dataMap.get(id);
}
}
DWRUserAccess——真正開放給 JavaScript 呼叫的 DWR 元件:
public class DWRUserAccess {
UserDAO userDAO = new UserDAO();
public boolean save(User user) { return userDAO.save(user); }
public User find(String id) { return userDAO.find(id); }
}
使用者填好 id、name、password、email 後按下提交,JavaScript 便透過 DWR 產生的 DWRUserAccess.js 呼叫 save,把資料存進服務端;查詢時則呼叫同一支 js 的 find。由於 DWRUserAccess 是給 DWR 用的元件,必須先在設定檔中登記。
1. 建立一個名為 testApp 的 webapp。
2. 把 dwr.jar 複製到 WEB-INF/lib。
3. 編譯上述三個類別,放進 classes 目錄。
4. 在 web.xml 註冊 servlet:
<servlet>
<servlet-name>dwr-invoker</servlet-name>
<display-name>DWR Servlet</display-name>
<servlet-class>uk.ltd.getahead.dwr.DWRServlet</servlet-class>
<init-param>
<param-name>debug</param-name>
<param-value>true</param-value>
</init-param>
<init-param>
<param-name>scriptCompressed</param-name>
<param-value>false</param-value>
</init-param>
<load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
<servlet-name>dwr-invoker</servlet-name>
<url-pattern>/dwr/*</url-pattern>
</servlet-mapping>
這樣就能攔截 testApp 下所有指向 dwr 的請求。
5. 在 WEB-INF 新增 dwr.xml:
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE dwr PUBLIC "-//GetAhead Limited//DTD Direct Web Remoting 1.0//EN"
"https://www.getahead.ltd.uk/dwr/dwr10.dtd">
<dwr>
<allow>
<create creator="new" javascript="DWRUserAccess">
<param name="class" value="test.DWRUserAccess"/>
</create>
<convert converter="bean" match="test.User"/>
</allow>
</dwr>
creator="new" 代表每次呼叫都重新 new 一個物件;javascript="DWRUserAccess" 指定前台要載入的 js 檔名;convert 則負責 Java 與 JavaScript 之間的型別轉換——因為前後端交換的是 User 物件,必須用 bean 轉換器處理。
<head>
<script src="/testApp/dwr/engine.js"></script>
<script src="/testApp/dwr/util.js"></script>
<script src="/testApp/dwr/interface/DWRUserAccess.js"></script>
</head>
<body>
<form name="regForm">
登陸ID:<input type="text" name="id"><br>
口 令:<input type="password" name="password"><br>
姓 名:<input type="text" name="name"><br>
電子郵件:<input type="text" name="email"><br>
<input type="button" name="submitBtn" value="提交" onclick="OnSave()">
</form>
<form name="queryForm">
登陸ID:<input type="text" name="id"><br>
<input type="button" name="submitBtn" value="提交" onclick="OnFind()">
</form>
</body>
前兩個 script 是 DWR 自帶的,直接引入即可;第三個 DWRUserAccess.js 才是 DWR 依我們的類別反射產生的,與 DWRUserAccess.java 一一對應,我們實際上就是透過它去呼叫服務端的方法。
function saveFun(data) {
if (data) { alert("注冊成功!"); } else { alert("登陸ID已經存在!"); }
}
function OnSave() {
var userMap = {};
userMap.id = regForm.id.value;
userMap.password = regForm.password.value;
userMap.name = regForm.name.value;
userMap.email = regForm.email.value;
DWRUserAccess.save(userMap, saveFun);
}
function findFun(data) {
if (data == null) { alert("無法找到用戶:" + queryForm.id.value); return; }
alert("找到用戶,\nid:" + data.id + ",\npassword:" + data.password
+ ",\nname:" + data.name + ",\nemail:" + data.email);
}
function OnFind() {
DWRUserAccess.find(queryForm.id.value, findFun);
}
仔細對照會發現一個有趣的落差:服務端的 save 是 boolean save(User user),而客戶端寫成 save(userMap, saveFun)。第一個參數 userMap 是 JavaScript 的 map 物件,執行時由 convert 轉成 User;第二個參數 saveFun 就是回呼函式,用來接 boolean 回傳值。find 同理,服務端回傳的 User 會被轉成 JavaScript 的 map,於是 data.id、data.name 都能直接取用。
啟動伺服器,開啟 localhost/testApp/test.html。在註冊表單填入 id 為 admin、密碼 123456、姓名 chenbug、信箱 chenbug@zj.com,按提交會跳出「注冊成功」,伺服器 console 同步印出資料;再按一次則提示「登陸ID已經存在」。查詢區輸入 admin 可查到資料,輸入不存在的 id 則提示找不到。測試到此完成。
請求攔截器:uk.ltd.getahead.dwr.DWRServlet 攔截所有指向 dwr 目錄的請求,再交給 Processor 的 handle 方法處理。在 impl.DefaultProcessor 中可以看到完整的分派邏輯——依 pathInfo 的開頭判斷要導向 index、test、interface、exec,還是直接送出 engine.js、util.js 等靜態檔案,都不符合就回 404。
Bean 轉換器:解壓 dwr.jar,在 uk/ltd/getahead/dwr/dwr.xml 裡可以看到系統預設的轉換器,其中 uk.ltd.getahead.dwr.convert.BeanConverter 就是我們用到的那一個。
convertInbound 負責把 JavaScript 物件轉成 Java 物件。由於前台傳來的是 map,字串必定以 { 開頭、} 結尾,所以函式一開始就檢查這兩點,不符合就丟出 IllegalArgumentException。JavaScript 的 map 內部以逗號分隔項目、以冒號分隔鍵值,例如 {id:'admin',password:'123456'};接下來程式便解析這個字串,透過 paramType 建立 Java 實例,再用反射把各組鍵值塞進去,完成 JavaScript 到 Java 的轉換。
反方向的 convertOutbound 則產生宣告與賦值的 JavaScript 語句:先 buffer.append("var " + varname + "={};") 宣告一個 map 變數,再逐一用反射取值,append 出 varname.屬性 = 值; 這樣的賦值碼。
最後一個小技巧:設定完成後,在瀏覽器打開 https://localhost/testApp/dwr/index.html,DWR 會列出所有已設定的元件,並提供測試介面,改設定時很好用。