DWR實例教程

時間  2019-11-08
標籤 dwr 實例 教程 欄目 Ajax 简体版
原文   原文鏈接

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

以上摘自open-open，它經過反射，將java翻譯成javascript，而後利用回調機制，輕鬆實現了javascript調用Java代碼。

其大概開發過程以下：
1.編寫業務代碼，該代碼是和dwr無關的。
2.確認業務代碼中哪些類、哪些方法是要由javascript直接訪問的。
3.編寫dwr組件，對步驟2的方法進行封裝。
4.配置dwr組件到dwr.xml文件中，若是有必要，配置convert，進行java和javascript類型互轉。
5.經過反射機制，dwr將步驟4的類轉換成javascript代碼，提供給前臺頁面調用。
5.編寫網頁，調用步驟5的javascript中的相關方法（間接調用服務器端的相關類的方法），執行業務邏輯，將執行結果利用回調函數返回。
6.在回調函數中，獲得執行結果後，能夠繼續編寫業務邏輯的相關javascript代碼。

下面以用戶註冊的例子，來講明其使用。（注意，本次例子只是用於演示，說明DWR的使用，類設計並非最優的）。

1.先介紹下相關的Java類

  User: 用戶類，
  public class User {
//登錄ID，主鍵惟一
private String id;
//姓名
private String name;
//口令
private String password;
//電子郵件
private String email;
        
//如下包含getXXX和setXXX方法
.......
  }

  UserDAO：實現User的數據庫訪問，這裏做爲一個演示，編寫測試代碼
  public class UserDAO { 
    //存放保存的數據
    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("用戶保存結束");
      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);
      }
  }
  

  下面說明下程序執行的流程

  1.用戶在頁面上輸入相關注冊信息，id、name、password、email，點擊「提交」按鈕
  2.javascript代碼開始執行，根據用戶填寫相關信息，經過dwr提供的DWRUserAccess.js裏save的方法，調用服務器端的DWRUserAccess類save方法，將註冊信息保存。
  3.經過DWRUserAccess.jsp裏的find方法，調用服務器端DWRUserAccess類裏的find方法，執行用戶信息查找。

  注意，在以上的執行過程當中，DWRUserAccess是供DWR調用的，是DWR組件，所以須要將DWRUserAccess類配置到dwr中。

  接下來說解本次dwr測試環境的配置。

  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的請求，關於這個攔截器，咱們會在後面介紹。

  5.WEB-INF下新建一個dwr.xml文件，內容以下：
  < 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 name="class" value="test.DWRUserAccess"/>
    </create>
<convert converter="bean" match="test.User"/>
  </allow>
</dwr>

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

  convert元素用於數據類型轉換，即java類和javascript之間相互轉換，由於和前臺交換的是User對象，所以須要對此使用bean轉換，咱們將在後面介紹這個類。

  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 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()"><br>
    </form>

<br>
<br><B>用戶查詢</B><br>
------------------------------------------------
<Br>
<form name="queryForm">
登錄ID：<input type="text" name="id"><br>
<input type="button" name="submitBtn" value="提交" onclick="OnFind()"><br>
</form>
<br>
</BODY>
</HTML>
<SCRIPT LANGUAGE="JavaScript">
<!--
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); 
}
//-->
</SCRIPT>


如下對頁面的javascript進行解釋

<script src="/oblog312/dwr/engine.js"></script>
<script src="/oblog312/dwr/util.js"></script>
這兩個是dwr提供的，用戶能夠沒必要關心，只須要導入便可

<script src="/oblog312/dwr/interface/DWRUserAccess.js"></script>
是咱們編寫的DWRUserAccess類，經dwr反射後，生成的javascript代碼，它和DWRUserAccess.java是對應的，供用戶調用，實際上咱們就是經過這個js文件去調用服務器端的DWRUserAccess類的。

<SCRIPT LANGUAGE="JavaScript">
<!--
function saveFun(data) {
if (data) {
  alert("註冊成功！");
} else {
  alert("用戶名已經存在！");
}
}

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

這段javascirpt代碼，咱們來看下OnSave函數，首先它構造一個map，將表單數據都設置到map中，而後調用DWRUserAccess.save(userMap, saveFun)，執行save操做。你們能夠注意到，服務器端的DWRUserAccess中的save方法是這樣的：boolean save(User user)，其參數是一個User對象，返回一個boolean值；而客戶端的方法是這樣的：save(userMap,saveFun)，第一個參數userMap是javascirpt中的map對象，在這裏至關於服務器端的User對象（在服務器端執行時，會經過convert轉換成User對象），前面咱們提到dwr是利用回調函數來返回執行結果的，第二個參數saveFun便是一個回調函數。在函數function saveFun(data)中，data是執行結果，這裏是一個bool值，很是簡單的，咱們經過判斷data是否爲真，能夠知道用戶名是否重複，用戶是否註冊成功。

看一下OnFind查找函數，執行結果在回調函數findFun(data)中，由於服務器端返回的是一個User對象，經過convert，將會轉換成javascript的一個map對象，
因而在findFun中，經過data.id、data.name、data.password、data.email咱們能夠輕鬆的訪問到這個User對象。


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

1.在「用戶註冊」表單中，id框中輸入admin，password中輸入123456，name中輸入chenbug，email中輸入chenbug@zj.com，點擊提交按鈕，彈出對話框：「註冊成功」，在服務器後臺能夠看到信息以下：

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

再次點擊提交按鈕，彈出對話框「登錄ID已經存在」。

2.在「用戶查詢」對話框中，輸入登錄ID爲admin，點擊提交按鈕，提示找到用戶，並顯示相關信息，輸入admin123，點擊提交按鈕，提示沒法找到用戶。

至此，測試結束。


後續：
1。攔截器 uk.ltd.getahead.dwr.DWRServlet
該類攔截全部指向dwr目錄下的請求，並調用Processor的handler方法進行處理，在uk.ltd.getahead.dwr.impl.DefaultProcessor下，咱們能夠看到詳細的處理過程。
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路徑，進行處理，你們能夠本身去參看，這裏不詳細討論。


2.bean轉換器，<convert converter="bean" match="test.User"/>
將dwr.jar解壓縮，在路徑ukltdgetaheaddwr下能夠看到dwr.xml，這裏配置了系統默認的一些轉換器，
<converter id="bean" class="uk.ltd.getahead.dwr.convert.BeanConverter"/>便是剛纔用到User類的轉換器，進入代碼咱們來看看它是如何在javascript和java間進行轉換的。

打開BeanConverter代碼，定位到函數

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

便是將javascript對象轉換成java對象的，其中
paramType即Class類型，在上面的例子中是test.User，
InboundVariable iv，是傳入的值，經過iv.getValue能夠獲得傳入的javascript值串
InboundContext inctx，是入口參數上下文，用於保存轉換的後java對象。

由於前臺傳入的是一個javascript的map類型，而map確定是以{開始和以}結束的，因而在這個函數一開始進行了判斷
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函數的接下來的處理中，便是經過分析map字串，經過paramType構造java實例（即User類），而後經過反射，將這些鍵值對設置到java實例中，並返回。
這樣就完成了javascript到java的轉換。


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

便是將java對象轉換爲javascript對象（實際上是聲明和賦值語句）。
Object data ，是待轉換的java對象
String varname，是javascript中的該對象的變量名
OutboundContext outctx，傳出參數上下文，用於保存轉換後的javascript值

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

即下來來的代碼便是經過反射進行變量賦值，以下
  buffer.append(varname);
                    buffer.append('.');
                    buffer.append(name);
                    buffer.append('=');
                    buffer.append(nested.getAssignCode());
                    buffer.append(';');
你們能夠本身去參看更多的代碼。

3.dwr自己提供了一個測試環境，你們在配置完後，能夠在IE中輸入地址http://localhost/testApp/dwr/index.html，看到配置的各DWR組件，並進行相關測試。javascript

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程