DWR搭建以及使用教程

﹏ヽ暗。殇╰゛Y 2022-05-31 01:52 253阅读 0赞

DWR（Direct Web Remoting）是一个Ajax的开源框架，用于改善web页面与Java类交互的远程服务器端的交互体验，可以帮助开发人员开发包含AJAX技术的网站。它可以允许在浏览器里的代码使用运行在WEB服务器上的JAVA函数，就像它就在浏览器里一样。

从DWR官网下载最新版本的jar包，地址：[http://directwebremoting.org/dwr/downloads/index.html][http_directwebremoting.org_dwr_downloads_index.html]

将jar包放入WEB-INF的lib文件夹下。同时，dwr依赖于commons-logging.jar这个包，所以必须将这个jar包也放入到WEB-INF的lib文件夹相爱。

首先是配置dwr的环境：

1. web.xml文件：

[查看源码][Link 1]

[打印][Link 2] [?][Link 3]

<table> 
 <tbody> 
  <tr> 
   <td><code>01</code></td> 
   <td><code>&lt;</code><code>servlet</code><code>&gt; </code></td> 
  </tr> 
 </tbody> 
</table>

<table> 
 <tbody> 
  <tr> 
   <td><code>02</code></td> 
   <td><code>&nbsp;&nbsp;</code><code>&lt;</code><code>servlet-name</code><code>&gt;dwr-invoker&lt;/</code><code>servlet-name</code><code>&gt; </code></td> 
  </tr> 
 </tbody> 
</table>

<table> 
 <tbody> 
  <tr> 
   <td><code>03</code></td> 
   <td><code>&nbsp;&nbsp;</code><code>&lt;</code><code>servlet-class</code><code>&gt;uk.ltd.getahead.dwr.DWRServlet&lt;/</code><code>servlet-class</code><code>&gt; </code></td> 
  </tr> 
 </tbody> 
</table>

<table> 
 <tbody> 
  <tr> 
   <td><code>04</code></td> 
   <td><code>&nbsp;&nbsp;</code><code>&lt;</code><code>init-param</code><code>&gt; </code></td> 
  </tr> 
 </tbody> 
</table>

<table> 
 <tbody> 
  <tr> 
   <td><code>05</code></td> 
   <td><code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;</code><code>param-name</code><code>&gt;debug&lt;/</code><code>param-name</code><code>&gt; </code></td> 
  </tr> 
 </tbody> 
</table>

<table> 
 <tbody> 
  <tr> 
   <td><code>06</code></td> 
   <td><code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;</code><code>param-value</code><code>&gt;true&lt;/</code><code>param-value</code><code>&gt; </code></td> 
  </tr> 
 </tbody> 
</table>

<table> 
 <tbody> 
  <tr> 
   <td><code>07</code></td> 
   <td><code>&nbsp;&nbsp;</code><code>&lt;/</code><code>init-param</code><code>&gt; </code></td> 
  </tr> 
 </tbody> 
</table>

<table> 
 <tbody> 
  <tr> 
   <td><code>08</code></td> 
   <td><code>&lt;/</code><code>servlet</code><code>&gt; </code></td> 
  </tr> 
 </tbody> 
</table>

<table> 
 <tbody> 
  <tr> 
   <td><code>10</code></td> 
   <td><code>&lt;</code><code>servlet-mapping</code><code>&gt; </code></td> 
  </tr> 
 </tbody> 
</table>

<table> 
 <tbody> 
  <tr> 
   <td><code>11</code></td> 
   <td><code>&nbsp;&nbsp;</code><code>&lt;</code><code>servlet-name</code><code>&gt;dwr-invoker&lt;/</code><code>servlet-name</code><code>&gt; </code></td> 
  </tr> 
 </tbody> 
</table>

<table> 
 <tbody> 
  <tr> 
   <td><code>12</code></td> 
   <td><code>&nbsp;&nbsp;</code><code>&lt;</code><code>url-pattern</code><code>&gt;/dwr/*&lt;/</code><code>url-pattern</code><code>&gt; </code></td> 
  </tr> 
 </tbody> 
</table>

<table> 
 <tbody> 
  <tr> 
   <td><code>13</code></td> 
   <td><code>&lt;/</code><code>servlet-mapping</code><code>&gt;</code></td> 
  </tr> 
 </tbody> 
</table>

2. 从官网的jar.war文件中利用winRAR等软件提取出dwr.xml文件，并将其放入到WEB-INF文件夹下。

dwr.xml是dwr的核心配置文件，主要的标签有：<converter>、<convert>、<create>这三个标签。

<converter>标签是dwr中内置的转换器。我们也可以使用自己写的转换器，不过dwr提供的转换器已经足够了，所以这个标签，一般不会自己去写。

<convert>标签是将converter中定义的转换器映射到的具体类型，如：

[查看源码][Link 1]

[打印][Link 2] [?][Link 3]

<table> 
 <tbody> 
  <tr> 
   <td><code>1</code></td> 
   <td><code>&lt;</code><code>converter</code> <code>id</code><code>=</code><code>"date"</code><code>class</code><code>=</code><code>"org.directwebremoting.convert.DateConverter"</code><code>/&gt;　</code><code>&lt;!-- 注册了 date 转换器 --&gt;</code></td> 
  </tr> 
 </tbody> 
</table>

<table> 
 <tbody> 
  <tr> 
   <td><code>2</code></td> 
   <td><code>&lt;!-- 注意:converter标签必须放到&lt;init&gt;标签内，而convert是放在&lt;allow&gt;标签内，这里只是示例，并不是完整的dwr.xml --&gt;</code></td> 
  </tr> 
 </tbody> 
</table>

<table> 
 <tbody> 
  <tr> 
   <td><code>3</code></td> 
   <td><code>&lt;</code><code>convert</code> <code>converter</code><code>=</code><code>"date"</code><code>match</code><code>=</code><code>"java.util.Date"</code><code>/&gt;　</code><code>&lt;!-- 将注册的 date 转换器应用到 java.util.Date 类型 </code></td> 
  </tr> 
 </tbody> 
</table>

<create>标签是dwr中重要的标签，用来描述 java（服务器端） 与 javascript （客户端）的交互方式。其基本格式如下：

[查看源码][Link 1]

[打印][Link 2] [?][Link 3]

<table> 
 <tbody> 
  <tr> 
   <td><code>1</code></td> 
   <td><code>&lt;</code><code>allow</code><code>&gt; </code></td> 
  </tr> 
 </tbody> 
</table>

<table> 
 <tbody> 
  <tr> 
   <td><code>2</code></td> 
   <td><code>&nbsp;&nbsp;</code><code>&lt;</code><code>create</code> <code>creator</code><code>=</code><code>"..."</code> <code>javascript</code><code>=</code><code>"..."</code> <code>scope</code><code>=</code><code>"..."</code><code>&gt; </code></td> 
  </tr> 
 </tbody> 
</table>

<table> 
 <tbody> 
  <tr> 
   <td><code>3</code></td> 
   <td><code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;</code><code>param</code> <code>name</code><code>=</code><code>"..."</code> <code>value</code><code>=</code><code>"..."</code><code>/&gt; </code></td> 
  </tr> 
 </tbody> 
</table>

<table> 
 <tbody> 
  <tr> 
   <td><code>4</code></td> 
   <td><code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;</code><code>auth</code> <code>method</code><code>=</code><code>"..."</code> <code>role</code><code>=</code><code>"..."</code><code>/&gt; </code></td> 
  </tr> 
 </tbody> 
</table>

<table> 
 <tbody> 
  <tr> 
   <td><code>5</code></td> 
   <td><code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;</code><code>exclude</code> <code>method</code><code>=</code><code>"..."</code><code>/&gt; </code></td> 
  </tr> 
 </tbody> 
</table>

<table> 
 <tbody> 
  <tr> 
   <td><code>6</code></td> 
   <td><code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;</code><code>include</code> <code>method</code><code>=</code><code>"..."</code><code>/&gt; </code></td> 
  </tr> 
 </tbody> 
</table>

<table> 
 <tbody> 
  <tr> 
   <td><code>7</code></td> 
   <td><code>&nbsp;&nbsp;</code><code>&lt;/</code><code>create</code><code>&gt; </code></td> 
  </tr> 
 </tbody> 
</table>

<table> 
 <tbody> 
  <tr> 
   <td><code>9</code></td> 
   <td><code>&lt;/</code><code>allow</code><code>&gt;</code></td> 
  </tr> 
 </tbody> 
</table>

其中，creator和javascript是必须属性，其他可以忽略。creator包含有以下几个值：

new：Java用“new”关键字创造对象

none：它不创建对象 (v1.1+)

scripted：通过BSF使用脚本语言创建对象，例如BeanShell或Groovy

spring：通过Spring框架访问Bean

struts：使用Struts的FormBean (v1.1+)

jsf：使用JSF的Bean (v1.1+)

pageflow：访问Weblogic或Beehive的PageFlow (v1.1+)

ejb3：使用EJB3 session bean (v2.0+)

关于这几个属性如何使用，这里就不在详细阐述了。我只列出一个与spring整合的例子：

[查看源码][Link 1]

[打印][Link 2] [?][Link 3]

<table> 
 <tbody> 
  <tr> 
   <td><code>01</code></td> 
   <td><code>&lt;</code><code>create</code> <code>creator</code><code>=</code><code>"spring"</code> <code>javascript</code><code>=</code><code>"backUpDocumentService"</code><code>&gt; </code></td> 
  </tr> 
 </tbody> 
</table>

<table> 
 <tbody> 
  <tr> 
   <td><code>02</code></td> 
   <td><code>&nbsp;&nbsp;</code><code>&lt;</code><code>param</code> <code>name</code><code>=</code><code>"beanName"</code> <code>value</code><code>=</code><code>"testDWR1"</code> <code>/&gt; </code></td> 
  </tr> 
 </tbody> 
</table>

<table> 
 <tbody> 
  <tr> 
   <td><code>03</code></td> 
   <td><code>&nbsp;&nbsp;</code><code>&lt;</code><code>include</code> <code>method</code><code>=</code><code>"modifyBackUpFiles"</code><code>&gt;&lt;/</code><code>include</code><code>&gt; </code></td> 
  </tr> 
 </tbody> 
</table>

<table> 
 <tbody> 
  <tr> 
   <td><code>04</code></td> 
   <td><code>&nbsp;&nbsp;</code><code>&lt;</code><code>include</code> <code>method</code><code>=</code><code>"isSafeCodeRight"</code><code>&gt;&lt;/</code><code>include</code><code>&gt; </code></td> 
  </tr> 
 </tbody> 
</table>

<table> 
 <tbody> 
  <tr> 
   <td><code>05</code></td> 
   <td><code>&lt;/</code><code>create</code><code>&gt; </code></td> 
  </tr> 
 </tbody> 
</table>

<table> 
 <tbody> 
  <tr> 
   <td><code>07</code></td> 
   <td><code>&lt;!-- 加include可以具体指定java类中关的方法，不加则默认类中全部为public的方法 --&gt;</code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</td> 
  </tr> 
 </tbody> 
</table>

<table> 
 <tbody> 
  <tr> 
   <td><code>08</code></td> 
   <td><code>&lt;</code><code>create</code> <code>creator</code><code>=</code><code>"spring"</code> <code>javascript</code><code>=</code><code>"testDWR2"</code><code>&gt; </code></td> 
  </tr> 
 </tbody> 
</table>

<table> 
 <tbody> 
  <tr> 
   <td><code>09</code></td> 
   <td><code>&nbsp;&nbsp;</code><code>&lt;</code><code>param</code> <code>name</code><code>=</code><code>"beanName"</code> <code>value</code><code>=</code><code>"testDWR2"</code> <code>/&gt; </code></td> 
  </tr> 
 </tbody> 
</table>

<table> 
 <tbody> 
  <tr> 
   <td><code>10</code></td> 
   <td><code>&lt;/</code><code>create</code><code>&gt;</code></td> 
  </tr> 
 </tbody> 
</table>

spring配置文件

[查看源码][Link 1]

[打印][Link 2] [?][Link 3]

<table> 
 <tbody> 
  <tr> 
   <td><code>1</code></td> 
   <td><code>&lt;</code><code>bean</code> <code>id</code><code>=</code><code>"testDWR1"</code> <code>class</code><code>=</code><code>"com.test.testDWR1"</code><code>&gt;&lt;/</code><code>bean</code><code>&gt; </code></td> 
  </tr> 
 </tbody> 
</table>

<table> 
 <tbody> 
  <tr> 
   <td><code>2</code></td> 
   <td><code>&lt;</code><code>bean</code> <code>id</code><code>=</code><code>"testDWR2"</code> <code>class</code><code>=</code><code>"com.test.testDWR2"</code><code>&gt;&lt;/</code><code>bean</code><code>&gt;</code></td> 
  </tr> 
 </tbody> 
</table>

3. 页面配置

在jsp页面添加三个 js 文件，分别是

[查看源码][Link 1]

[打印][Link 2] [?][Link 3]

<table> 
 <tbody> 
  <tr> 
   <td><code>1</code></td> 
   <td><code>&lt;</code><code>script</code> <code>type</code><code>=</code><code>'text/javascript'</code> <code>src</code><code>=</code><code>'js/util.js'</code><code>&gt;&lt;/</code><code>script</code><code>&gt; </code></td> 
  </tr> 
 </tbody> 
</table>

<table> 
 <tbody> 
  <tr> 
   <td><code>2</code></td> 
   <td><code>&lt;</code><code>script</code> <code>type</code><code>=</code><code>'text/javascript'</code> <code>src</code><code>=</code><code>'js/engine.js'</code><code>&gt;&lt;/</code><code>script</code><code>&gt; </code></td> 
  </tr> 
 </tbody> 
</table>

<table> 
 <tbody> 
  <tr> 
   <td><code>3</code></td> 
   <td><code>&lt;</code><code>script</code> <code>type</code><code>=</code><code>'text/javascript'</code> <code>src</code><code>=</code><code>'dwr/interface/testDWR1.js'</code><code>&gt;</code></td> 
  </tr> 
 </tbody> 
</table>

其中engine.js必须要，如果需要用到dwr提供的一些方便的工具要引用util.js ，然后是dwr自动生成的js文件，名字必须和dwr.xml中create标签的javascript属性值一样，且是dwr/interface开头的目录

4. 接下来就可以分别写javascript和java代码了。

javascript代码：

[查看源码][Link 1]

[打印][Link 2] [?][Link 3]

<table> 
 <tbody> 
  <tr> 
   <td><code>1</code></td> 
   <td><code>function</code> <code> testFun() { </code></td> 
  </tr> 
 </tbody> 
</table>

<table> 
 <tbody> 
  <tr> 
   <td><code>2</code></td> 
   <td><code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>var</code> <code>name = </code><code>"aaaaa"</code><code>; </code></td> 
  </tr> 
 </tbody> 
</table>

<table> 
 <tbody> 
  <tr> 
   <td><code>3</code></td> 
   <td><code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>testDWR1.testFun(name, returnFun);&nbsp; </code><code>//调用java方法，第二个参数是回调函数 </code></td> 
  </tr> 
 </tbody> 
</table>

<table> 
 <tbody> 
  <tr> 
   <td><code>4</code></td> 
   <td><code>}</code><code>function</code> <code>returnFun(data) {&nbsp; </code><code>//data对应着java方法的返回值 </code></td> 
  </tr> 
 </tbody> 
</table>

<table> 
 <tbody> 
  <tr> 
   <td><code>5</code></td> 
   <td><code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>alert(data); </code></td> 
  </tr> 
 </tbody> 
</table>

java代码：

[查看源码][Link 1]

[打印][Link 2] [?][Link 3]

<table> 
 <tbody> 
  <tr> 
   <td><code>1</code></td> 
   <td><code>package</code> <code> com.test; </code></td> 
  </tr> 
 </tbody> 
</table>

<table> 
 <tbody> 
  <tr> 
   <td><code>3</code></td> 
   <td><code>public</code> <code> class</code> <code>testDWR1 { </code></td> 
  </tr> 
 </tbody> 
</table>

<table> 
 <tbody> 
  <tr> 
   <td><code>4</code></td> 
   <td><code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>public</code> <code>String test(String str) { </code></td> 
  </tr> 
 </tbody> 
</table>

<table> 
 <tbody> 
  <tr> 
   <td><code>6</code></td> 
   <td><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>return</code> <code>str; </code></td> 
  </tr> 
 </tbody> 
</table>

5. 其他

dwr可以设置是否采用异步方式访问java代码，其代码为：

[查看源码][Link 1]

[打印][Link 2] [?][Link 3]

<table> 
 <tbody> 
  <tr> 
   <td><code>1</code></td> 
   <td><code>dwr.engine.setAsync(</code><code>false</code><code>);&nbsp; </code><code>//false为同步，true（默认）为异步</code></td> 
  </tr> 
 </tbody> 
</table>

以及dwr对于异常的处理，这里我只列出个简单的全局性异常捕获，具体到针对某个方法的异常捕获，大家可以自己上网找找。

[查看源码][Link 1]

[打印][Link 2] [?][Link 3]

<table> 
 <tbody> 
  <tr> 
   <td><code>1</code></td> 
   <td><code>dwr.engine.setErrorHandler(errh); </code></td> 
  </tr> 
 </tbody> 
</table>

<table> 
 <tbody> 
  <tr> 
   <td><code>2</code></td> 
   <td><code>function</code> <code> errh(errorString, exception) { </code></td> 
  </tr> 
 </tbody> 
</table>

<table> 
 <tbody> 
  <tr> 
   <td><code>3</code></td> 
   <td><code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>errorFlag = </code><code>true</code><code>; </code> </td> 
  </tr> 
 </tbody> 
</table>

<table> 
 <tbody> 
  <tr> 
   <td><code>4</code></td> 
   <td><code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>alert(</code><code>"操作失败！"</code><code>); </code></td> 
  </tr> 
 </tbody> 
</table>

dwr同样支持参数为对象的方法，这需要在dwr.xml中配置下<convert>标签：

[查看源码][Link 1]

[打印][Link 2] [?][Link 3]

<table> 
 <tbody> 
  <tr> 
   <td><code>1</code></td> 
   <td><code>&lt;</code><code>convert</code> <code>converter</code><code>=</code><code>"bean"</code> <code>match</code><code>=</code><code>"com.example.Person"</code><code>/&gt;</code></td> 
  </tr> 
 </tbody> 
</table>

那么关于dwr我也只介绍到这里了，这基本就是dwr的基本内容了，可以满足普通的项目需求了。

想进一步对于dwr的深入可以查询下相关文章或查看api，这里我就不再说的那么详细了。

[http_directwebremoting.org_dwr_downloads_index.html]: http://directwebremoting.org/dwr/downloads/index.html
[Link 1]: http://www.open-open.com/lib/view/open1338338726417.html#viewSource
[Link 2]: http://www.open-open.com/lib/view/open1338338726417.html#printSource
[Link 3]: http://www.open-open.com/lib/view/open1338338726417.html#about