AJAX實(shí)踐DWR篇

2024-09-01 08:32:02

字體：大中小

供稿：網(wǎng)友

DWR(Direct Web Remoting)是一個WEB遠(yuǎn)程調(diào)用框架.利用這個框架可以讓AJAX開發(fā)變得很簡單.利用DWR可以在客戶端利用JavaScript直接調(diào)用服務(wù)端的Java方法并返回值給JavaScript就好像直接本地客戶端調(diào)用一樣(DWR根據(jù)Java類來動態(tài)生成JavaScrip代碼).它的最新版本DWR0.6添加許多特性如:支持Dom Trees的自動配置,支持Spring(JavaScript遠(yuǎn)程調(diào)用spring bean),更好瀏覽器支持,還支持一個可選的commons-logging日記操作.

以上摘自open-open，看了幾天，確實(shí)是一個非常優(yōu)秀的項目，它通過反射，將java翻譯成javascript，然后利用回調(diào)機(jī)制，輕松實(shí)現(xiàn)了javascript調(diào)用Java代碼。

其大概開發(fā)過程如下：
1.編寫業(yè)務(wù)代碼，該代碼是和dwr無關(guān)的。
2.確認(rèn)業(yè)務(wù)代碼中哪些類、哪些方法是要由javascript直接訪問的。
3.編寫dwr組件，對步驟2的方法進(jìn)行封裝。
4.配置dwr組件到dwr.xml文件中，如果有必要，配置convert，進(jìn)行java和javascript類型互轉(zhuǎn)。
5.通過反射機(jī)制，dwr將步驟4的類轉(zhuǎn)換成javascript代碼，提供給前臺頁面調(diào)用。
5.編寫網(wǎng)頁，調(diào)用步驟5的javascript中的相關(guān)方法（間接調(diào)用服務(wù)器端的相關(guān)類的方法），執(zhí)行業(yè)務(wù)邏輯，將執(zhí)行結(jié)果利用回調(diào)函數(shù)返回。
6.在回調(diào)函數(shù)中，得到執(zhí)行結(jié)果后，可以繼續(xù)編寫業(yè)務(wù)邏輯的相關(guān)javascript代碼。

下面以用戶注冊的例子，來說明其使用。（注意，本次例子只是用于演示，說明DWR的使用，類設(shè)計并不是最優(yōu)的）。

1.先介紹下相關(guān)的Java類

User: 用戶類，
public class User {
//登陸ID，主鍵唯一
private String id;
//姓名
private String name;
//口令
private String password;
//電子郵件
private String email;

//以下包含getXXX和setXXX方法
.......
}

UserDAO：實(shí)現(xiàn)User的數(shù)據(jù)庫訪問，這里作為一個演示，編寫測試代碼
public class UserDAO {
//存放保存的數(shù)據(jù)
private static Map dataMap = new HashMap();

//持久用戶
public boolean save(User user) {
if (dataMap.containsKey(user.getId()))
return false;
System.out.println("下面開始保存用戶");
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);
System.out.println("用戶保存結(jié)束");
return true;
}

//查找用戶
public User find(String id) {
return (User)dataMap.get(id);
}
}

DWRUserAccess：DWR組件，提供給javascript訪問的。

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);
}
}

下面說明下程序執(zhí)行的流程

1.用戶在頁面上輸入相關(guān)注冊信息，id、name、password、email，點(diǎn)擊“提交”按鈕
2.javascript代碼開始執(zhí)行，根據(jù)用戶填寫相關(guān)信息，通過dwr提供的DWRUserAccess.js里save的方法，調(diào)用服務(wù)器端的DWRUserAccess類save方法，將注冊信息保存。
3.通過DWRUserAccess.jsp里的find方法，調(diào)用服務(wù)器端DWRUserAccess類里的find方法，執(zhí)行用戶信息查找。

注意，在以上的執(zhí)行過程中，DWRUserAccess是供DWR調(diào)用的，是DWR組件，因此需要將DWRUserAccess類配置到dwr中。

接下來講解本次dwr測試環(huán)境的配置。

1.新建一個webapp，命名為testApp
2.將dwr.jar拷貝到testApp的WEB-INF的lib目錄下
3.編譯上面的User，UserDAO，DWRUserAccess類，放到classes目錄下
4.在web.xml中配置servlet,適配路徑到dwr目錄下,如下所示
<servlet>
<servlet-name>dwr-invoker</servlet-name>
<display-name>DWR Servlet</display-name>
<description>Direct Web Remoter Servlet</description>
<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的請求，關(guān)于這個攔截器，我們會在后面介紹。

5.WEB-INF下新建一個dwr.xml文件，內(nèi)容如下：
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE dwr PUBLIC "-//GetAhead Limited//DTD Direct Web Remoting 1.0//EN" "http://www.getahead.ltd.uk/dwr/dwr10.dtd">

<dwr>
<allow>
<create creator="new" javascript="DWRUserAccess">
<param value="test.DWRUserAccess"/>
</create>
<convert converter="bean" match="test.User"/>
</allow>
</dwr>

這里我們把DWRUserAccess配置到了dwr中，create元素中，creater="new"表示每調(diào)用一次DWRUserAccess時，需要new一個這樣的類；javascript="DWRUserAccess"，表示提供給前臺頁面調(diào)用的javascirpt文件是DWRUserAccess.js。

convert元素用于數(shù)據(jù)類型轉(zhuǎn)換，即java類和javascript之間相互轉(zhuǎn)換，因?yàn)楹颓芭_交換的是User對象，因此需要對此使用bean轉(zhuǎn)換，我們將在后面介紹這個類。

4.編寫測試的HTML頁面 test.html
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD>
<TITLE>DWR測試</TITLE>
<meta http-equiv=Content-Type content="text/html; charset=gb2312">
<script src="/oblog312/dwr/engine.js"></script>
<script src="/oblog312/dwr/util.js"></script>
<script src="/oblog312/dwr/interface/DWRUserAccess.js"></script>
</HEAD>
<BODY>
<B>用戶注冊</B><br>
------------------------------------------------
<Br>
<form>
登陸ID：<input type="text"><br>
口令：<input type="password"><br>
姓名：<input type="text"><br>
電子郵件：<input type="text"><br>
<input type="button" value="提交"><br>
</form>

<br>
<br><B>用戶查詢</B><br>
------------------------------------------------
<Br>
<form>
登陸ID：<input type="text"><br>
<input type="button" value="提交"><br>
</form>
<br>
</BODY>
</HTML>
<SCRIPT LANGUAGE="JavaScript">

</SCRIPT>

以下對頁面的javascript進(jìn)行解釋

<script src="/oblog312/dwr/engine.js"></script>
<script src="/oblog312/dwr/util.js"></script>
這兩個是dwr提供的，用戶可以不必關(guān)心，只需要導(dǎo)入即可

<script src="/oblog312/dwr/interface/DWRUserAccess.js"></script>
是我們編寫的DWRUserAccess類，經(jīng)dwr反射后，生成的javascript代碼，它和DWRUserAccess.java是對應(yīng)的，供用戶調(diào)用，實(shí)際上我們就是通過這個js文件去調(diào)用服務(wù)器端的DWRUserAccess類的。

<SCRIPT LANGUAGE="JavaScript">

</SCRIPT>

這段javascirpt代碼，我們來看下OnSave函數(shù)，首先它構(gòu)造一個map，將表單數(shù)據(jù)都設(shè)置到map中，然后調(diào)用DWRUserAccess.save(userMap, saveFun)，執(zhí)行save操作。大家可以注意到，服務(wù)器端的DWRUserAccess中的save方法是這樣的：boolean save(User user)，其參數(shù)是一個User對象，返回一個boolean值；而客戶端的方法是這樣的：save(userMap,saveFun)，第一個參數(shù)userMap是javascirpt中的map對象，在這里相當(dāng)于服務(wù)器端的User對象（在服務(wù)器端執(zhí)行時，會通過convert轉(zhuǎn)換成User對象），前面我們提到dwr是利用回調(diào)函數(shù)來返回執(zhí)行結(jié)果的，第二個參數(shù)saveFun即是一個回調(diào)函數(shù)。在函數(shù)function saveFun(data)中，data是執(zhí)行結(jié)果，這里是一個bool值，非常簡單的，我們通過判斷data是否為真，可以知道用戶名是否重復(fù)，用戶是否注冊成功。

看一下OnFind查找函數(shù)，執(zhí)行結(jié)果在回調(diào)函數(shù)findFun(data)中，因?yàn)榉?wù)器端返回的是一個User對象，通過convert，將會轉(zhuǎn)換成javascript的一個map對象，
于是在findFun中，通過data.id、data.name、data.password、data.email我們可以輕松的訪問到這個User對象。

好了配置完畢，啟動服務(wù)器，在目錄中打入localhost/testApp/test.html。

1.在“用戶注冊”表單中，id框中輸入admin，password中輸入123456，name中輸入chenbug，email中輸入chenbug@zj.com，點(diǎn)擊提交按鈕，彈出對話框：“注冊成功”，在服務(wù)器后臺可以看到信息如下：

下面開始保存用戶
id：admin
password：123456
name：chenbug
email：chenbug@zj.com
用戶保存結(jié)束

再次點(diǎn)擊提交按鈕，彈出對話框“登陸ID已經(jīng)存在”。

2.在“用戶查詢”對話框中，輸入登陸ID為admin，點(diǎn)擊提交按鈕，提示找到用戶，并顯示相關(guān)信息，輸入admin123，點(diǎn)擊提交按鈕，提示無法找到用戶。

至此，測試結(jié)束。

后續(xù)：
1。攔截器 uk.ltd.getahead.dwr.DWRServlet
該類攔截所有指向dwr目錄下的請求，并調(diào)用Processor的handler方法進(jìn)行處理，在uk.ltd.getahead.dwr.impl.DefaultProcessor下，我們可以看到詳細(xì)的處理過程。
if (pathInfo.length() == 0 ||
pathInfo.equals(HtmlConstants.PATH_ROOT) ||
pathInfo.equals(req.getContextPath()))
{
resp.sendRedirect(req.getContextPath() + servletPath + HtmlConstants.FILE_INDEX);
}
else if (pathInfo.startsWith(HtmlConstants.FILE_INDEX))
{
index.handle(req, resp);
}
else if (pathInfo.startsWith(HtmlConstants.PATH_TEST))
{
test.handle(req, resp);
}
else if (pathInfo.startsWith(HtmlConstants.PATH_INTERFACE))
{
iface.handle(req, resp);
}
else if (pathInfo.startsWith(HtmlConstants.PATH_EXEC))
{
exec.handle(req, resp);
}
else if (pathInfo.equalsIgnoreCase(HtmlConstants.FILE_ENGINE))
{
file.doFile(req, resp, HtmlConstants.FILE_ENGINE, HtmlConstants.MIME_JS);
}
else if (pathInfo.equalsIgnoreCase(HtmlConstants.FILE_UTIL))
{
file.doFile(req, resp, HtmlConstants.FILE_UTIL, HtmlConstants.MIME_JS);
}
else if (pathInfo.equalsIgnoreCase(HtmlConstants.FILE_DEPRECATED))
{
file.doFile(req, resp, HtmlConstants.FILE_DEPRECATED, HtmlConstants.MIME_JS);
}
else
{
log.warn("Page not found (" + pathInfo + "). In debug/test mode try viewing /[WEB-APP]/dwr/"); //$NON-NLS-1$ //$NON-NLS-2$
resp.sendError(HttpServletResponse.SC_NOT_FOUND);
}

通過判斷request請求的servlet路徑，進(jìn)行處理，大家可以自己去參看，這里不詳細(xì)討論。

2.bean轉(zhuǎn)換器，<convert converter="bean" match="test.User"/>
將dwr.jar解壓縮，在路徑uk/ltd/getahead/dwr下可以看到dwr.xml，這里配置了系統(tǒng)默認(rèn)的一些轉(zhuǎn)換器，
<converter/>即是剛才用到User類的轉(zhuǎn)換器，進(jìn)入代碼我們來看看它是如何在javascript和java間進(jìn)行轉(zhuǎn)換的。

打開BeanConverter代碼，定位到函數(shù)

public Object convertInbound(Class paramType, InboundVariable iv, InboundContext inctx) throws ConversionException

即是將javascript對象轉(zhuǎn)換成java對象的，其中
paramType即Class類型，在上面的例子中是test.User，
InboundVariable iv，是傳入的值，通過iv.getValue可以得到傳入的javascript值串
InboundContext inctx，是入口參數(shù)上下文，用于保存轉(zhuǎn)換的后java對象。

因?yàn)榍芭_傳入的是一個javascript的map類型，而map肯定是以{開始和以}結(jié)束的，于是在這個函數(shù)一開始進(jìn)行了判斷
if (!value.startsWith(ConversionConstants.INBOUND_MAP_START))
{
throw new IllegalArgumentException(Messages.getString("BeanConverter.MissingOpener", ConversionConstants.INBOUND_MAP_START)); //$NON-NLS-1$
}

if (!value.endsWith(ConversionConstants.INBOUND_MAP_END))
{
throw new IllegalArgumentException(Messages.getString("BeanConverter.MissingCloser", ConversionConstants.INBOUND_MAP_START)); //$NON-NLS-1$
}

javascript中，map里各個項是用逗號連接的，如var userMap = {id:'admin',password:'123456',name:'chenbug',email:'chenbug@zj.com'};而每個項的鍵值對是用冒號連接的，
在convertInbound函數(shù)的接下來的處理中，即是通過分析map字串，通過paramType構(gòu)造java實(shí)例（即User類），然后通過反射，將這些鍵值對設(shè)置到j(luò)ava實(shí)例中，并返回。
這樣就完成了javascript到j(luò)ava的轉(zhuǎn)換。

另一個函數(shù)
public String convertOutbound(Object data, String varname, OutboundContext outctx) throws ConversionException

即是將java對象轉(zhuǎn)換為javascript對象（其實(shí)是聲明和賦值語句）。
Object data ，是待轉(zhuǎn)換的java對象
String varname，是javascript中的該對象的變量名
OutboundContext outctx，傳出參數(shù)上下文，用于保存轉(zhuǎn)換后的javascript值

StringBuffer buffer = new StringBuffer();
buffer.append("var "); //$NON-NLS-1$
buffer.append(varname);
buffer.append("={};"); //$NON-NLS-1$
這里聲明了map類型的變量。

即下來來的代碼即是通過反射進(jìn)行變量賦值，如下
buffer.append(varname);
buffer.append('.');
buffer.append(name);
buffer.append('=');
buffer.append(nested.getAssignCode());
buffer.append(';');
大家可以自己去參看更多的代碼。

3.dwr本身提供了一個測試環(huán)境，大家在配置完后，可以在IE中輸入地址，看到配置的各DWR組件，并進(jìn)行相關(guān)測試。