dwr基础介绍

我会带着你远行 2022-07-21 00:10 214阅读 0赞

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

**DWR原理**

它包含两个主要的部分:允许[JavaScript][]从[WEB服务器][WEB]上一个遵循了[AJAX][]原则的[Servlet][]中获取数据.另外一方面一个JavaScript库可以帮助[网站开发][Link 1]人员轻松地利用获取的数据来动态改变网页的内容.

DWR采取了一个类似AJAX的新方法来动态生成基于JAVA类的JavaScript代码。这样WEB开发人员就可以在JavaScript里使用Java代码，就像它们是浏览器的[本地代码][Link 2](客户端代码)一样；但是Java代码运行在WEB服务器端而且可以自由访问WEB 服务器的资源。出于安全的理由，WEB开发者必须适当地配置哪些Java类可以安全的被外部使用。\[1\]

这个从JAVA到JavaScript的远程功能方法给DWR的用户带来非常像传统的RPC机制,就像RMI或者SOAP一样,而且拥有运行在WEB上但是不需要[浏览器插件][Link 3]的好处.

DWR不认为浏览器/WEB服务器协议是重要的,而更乐于保证编程界面的简单自然.对此最大的挑战就是把AJAX的异步特性和正常JAVA方法调用的同步特性相结合.在异步模式下,结果数据在开始调用之后的一段时间之后才可以被异步访问获取到.DWR允许WEB开发人员传递一个[回调函数][Link 4],来[异步处理][Link 5]Java[函数调用][Link 6]过程.

**DWR调用方法**

**1.1、dwr.xml的配置**

<dwr>

<allow>

</create>

</allow>

</dwr>

<allow>标签中包括可以暴露给javascript访问的东西。

<create>标签中指定javascript中可以访问的java类名，并定义DWR应当如何获得要进行远程的类的实例。creator="new"属性指定java类实例的生成方式，new意味着DWR应当调用类的[默认构造函数][Link 7]来获得实例，其他的还有spring方式，通过与IOC容器Spring进行集成来获得实例等等。javascript=" testClass "属性指定javascript代码访问对象时使用的名称。

标签指定要公开给javascript的java类名。

<include>标签指定要公开给javascript的方法。不指定的话就公开所有方法。

<exclude>标签指定要防止被访问的方法。

注意：include和exclude不能同时存在

**1.2、javascript中调用**

首先，引入javascript脚本

其中TestClass.js是dwr根据配置文件自动生成的，engine.js和util.js是dwr自带的[脚本文件][Link 8]。

其次，编写调用java方法的javascript函数

Function callTestMethod1()\{

testClass.testMethod1();

**DWR调用返回值**

**2.1、javascript中调用**

首先，引入javascript脚本

其次，编写调用java方法的javascript函数和接收返回值的[回调函数][Link 4]

Function callTestMethod2()\{

testClass.testMethod2(callBackFortestMethod2);

Function callBackFortestMethod2(data)\{

//其中data接收方法的返回值

//可以在这里对返回值进行处理和显示等等

alert("the return value is " + data);

其中callBackFortestMethod2是接收返回值的回调函数

**DWR调用简单参数**

3.1、javascript中调用

首先，引入javascript脚本

其次，编写调用java方法的javascript函数

Function callTestMethod3()\{

//定义要传到java方法中的参数

var data;

//构造参数

data = “test String”;

testClass.testMethod3(data);

**DWR调用返回JavaBean**

4.1、dwr.xml的配置

<dwr>

<allow>

</create>

</convert>

</allow>

</dwr>

<create>标签负责公开用于Web远程的类和类的方法。

<convert>标签则负责这些方法的参数和返回类型。

convert元素的作用是告诉DWR在服务器端Java 对象表示和序列化的JavaScript之间如何转换数据类型。

DWR自动地在Java和JavaScript表示之间调整简单数据类型。

这些类型包括Java原生类型和它们各自的封装类表示，还有String、Date、[数组][Link 9]和集合类型。

DWR也能把JavaBean转换成JavaScript 表示，但是出于安全性的原因，要求显式的配置，<convert>标签就是完成此功能的。

converter="bean"属性指定转换的方式采用JavaBean命名规范，match=""com.dwr.TestBean"属性指定要转换的javabean名称，标签指定要转换的JavaBean属性。

4.2、javascript中调用

首先，引入javascript脚本

其次，编写调用java方法的javascript函数和接收返回值的回调函数

Function callTestMethod4()\{

testClass.testMethod4(callBackFortestMethod4);

Function callBackFortestMethod4(data)\{

//其中data接收方法的返回值

//对于JavaBean返回值，有两种方式处理

//不知道属性名称时，使用如下方法

for(var property in data)\{

alert("property:"+property);

alert(property+":"+data\[property\]);

//知道属性名称时，使用如下方法

alert(data.username);

alert(data.password);

其中callBackFortestMethod4是接收返回值的回调函数

**DWR调用JavaBean参数**

5.1、dwr.xml的配置

配置同4.1

<dwr>

<allow>

</create>

</convert>

</allow>

</dwr>

5.2、javascript中调用

首先，引入javascript脚本

其次，编写调用java方法的javascript函数

Function callTestMethod5()\{

//定义要传到java方法中的参数

var data;

//构造参数，data实际上是一个object

data = \{ username:"user", password:"password" \}

testClass.testMethod5(data);

6、调用返回List、Set或者Map的java方法

6.1、dwr.xml的配置

配置同4.1

<dwr>

<allow>

</create>

</convert>

</allow>

</dwr>

注意：如果[List][]、Set或者Map中的元素均为简单类型（包括其封装类）或String、Date、[数组][Link 9]和集合类型，则不需要<convert>标签。

6.2、javascript中调用(以返回List为例，List的元素为TestBean)

首先，引入javascript脚本

其次，编写调用java方法的javascript函数和接收返回值的回调函数

Function callTestMethod6()\{

testClass.testMethod6(callBackFortestMethod6);

Function callBackFortestMethod6(data)\{

//其中data接收方法的返回值

//对于JavaBean返回值，有两种方式处理

//不知道属性名称时，使用如下方法

for(var i=0;i<data.length;i++)\{

for(var property in data\[i\])\{

alert("property:"+property);

alert(property+":"+data\[i\]\[property\]);

//知道属性名称时，使用如下方法

for(var i=0;i<data.length;i++)\{

alert(data\[i\].username);

alert(data\[i\].password);

7、调用有List、Set或者Map参数的java方法

7.1、dwr.xml的配置

<dwr>

<allow>

</create>

</convert>

</allow>

<!\[CDATA\[

import java.util.List;

import com.dwr.TestClass;

import com.dwr.TestBean;

TestClass.testMethod7(List<TestBean>);

\]\]>

</signatures>

</dwr>

<signatures>标签是用来声明java方法中List、Set或者Map参数所包含的确切类，以便java代码作出判断。

7.2、javascript中调用(以返回List为例，List的元素为TestBean)

首先，引入javascript脚本

其次，编写调用java方法的javascript函数

Function callTestMethod7()\{

//定义要传到java方法中的参数

var data;

//构造参数，data实际上是一个object[数组][Link 9]，即数组的每个元素均为object

data = \[

username:"user1",

password:"password2"

\},

username:"user2",

password:" password2"

\];

testClass.testMethod7(data);

注意：

1、对于第6种情况，如果java方法的返回值为Map，则在接收该返回值的javascript[回调函数][Link 4]中如下处理：

function callBackFortestMethod(data)\{

//其中data接收方法的返回值

for(var property in data)\{

var bean = data\[property\];

alert(bean.username);

alert(bean.password);

2、对于第7种情况，如果java的方法的参数为Map（假设其key为String，value为TestBean），则在调用该方法的javascript函数中用如下方法构造要传递的参数：

function callTestMethod ()\{

//定义要传到java方法中的参数

var data;

//构造参数，date实际上是一个object，其属性名为Map的key，属性值为Map的value

data = \{

"key1":\{

username:"user1",

password:"password2"

\},

"key2":\{

username:"user2",

password:" password2"

\};

testClass.testMethod(data);

并且在dwr.xml中增加如下的配置段

<!\[CDATA\[

import java.util.List;

import com.dwr.TestClass;

import com.dwr.TestBean;

TestClass.testMethod7(Map<String,TestBean>);

\]\]>

</signatures>

3、由以上可以发现，对于java方法的返回值为List(Set)的情况，DWR将其转化为Object[数组][Link 9]，传递个javascript；对于java方法的返回值为Map的情况，DWR将其转化为一个Object，其中Object的属性为原Map的key值，属性值为原Map相应的value值。

4、如果java方法的参数为List(Set)和Map的情况，javascript中也要根据3种所说，构造相应的javascript数据来传递到java中

特别说明：

创建时要先实例化：var obj = new Object(); obj = \{key:"value"\}; 也可以obj.key = "value"; 如果没有初始化，则会转换出错。

**DWR配置**

**DWR安装配置**

1. 安装 DWR JAR 包

下载 dwr.jar 文件，然后将它放在 web 程序的 WEB-INF/lib 目录下面，很可能在这个目录下已经有一些 jar 文件了。

2. 编辑 config 文件

将下面的代码添加到 WEB-INF/[web.xml][] 文件中，<servlet>需要放在另外的<servlet>之后，<servlet-mapping>也是如此。

<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>

</servlet>

<servlet-mapping>

<servlet-name>dwr-invoker</servlet-name>

<url-pattern>/dwr/\*</url-pattern>

</servlet-mapping>

接下来创建 dwr.xml 文件并将此放在 [web.xml][] 所在的 WEB-INF 目录下。文件中类似下面的内容：

<!DOCTYPE dwr PUBLIC

”-//GetAhead Limited//DTD Direct Web Remoting 1.0//EN”

”http://www.getahead.ltd.uk/dwr/dwr10.dtd”>

<dwr>

<allow>

</create>

</create>

</allow>

</dwr>

DWR 配置文件定义了由 DWR 创建和被 Javascript 远程使用的类。在上面的例子中我们在远程创建了2个类，并且给出了在 Javascript 中的类名。

上面使用的 new creator 使用了所有的 JavaBeans 必须含有的公有（public）无参（no-args）的[构造函数][Link 10]。值得一提的是， DWR 还有一些限制：

避免使用 JavaScript [保留字][Link 11]；以保留字命名的方法将自动被排除。大多数 JavaScript 的保留字同时也是 Java 的保留字，因此无论如何你也不能使用一个名为 “try()” 的方法。但是最常用的一个词 “delete()”，在 JavaScript 中有特殊的含义而在 Java 中没有。

[重载][Link 12]方法（Overloaded methods）将会在调用的时候陷入未知的状况，因此应该避免重载方法。

如果有自定义类型可以考虑添加下面的配置在<allow>中

你必须让DWR知道通过XMLHttpRequest对象，什么对象将会接收请求。这个任务由叫做dwr.xml的配置文件来完成。在配置文件中，定义了DWR允许你从网页中调用的对象。从设计上讲，DWR允许访问所有公布类的公共方法，但在我们的例子中，我们只允许访问几个方法。下面是我们示例的配置文件：

<dwr>

<allow>

</create>

</allow>

</dwr>

上面的文件实现了我们例子中的两个目标。首先，<convert>标记告诉DWR将com.yd.pojos.Userss对象的类型转换为联合[数组][Link 9]，因为，出于安全的原因，DWR默认的不会转换普通bean。第二，<create>标记让DWR暴露出com.yd.imp.UserCol类给JavaScript调用;我们在页面中使用JavaScript文件被javascript属性定义。我们必须注意<include>标记，它指明了com.yd.imp.UserCol类的哪些方法可用。

4、页面添加：

说明：Hello.js 对应dwr.xml <create creator="new" javascript="Hello" scope="page">

5、自行设计调用处理方法

function callback(str)

alert(str);

function test()

Hello.sayHelloTo("zhangsan",callback);

</script>

[WEB]: http://baike.baidu.com/view/460250.htm
[JavaScript]: http://baike.baidu.com/view/16168.htm
[AJAX]: http://baike.baidu.com/subview/1641/5762264.htm
[Servlet]: http://baike.baidu.com/view/25169.htm
[Link 1]: http://baike.baidu.com/view/71517.htm
[Link 2]: http://baike.baidu.com/view/3555594.htm
[Link 3]: http://baike.baidu.com/view/2045046.htm
[Link 4]: http://baike.baidu.com/view/414773.htm
[Link 5]: http://baike.baidu.com/view/3925481.htm
[Link 6]: http://baike.baidu.com/view/2369016.htm
[Link 7]: http://baike.baidu.com/view/2785579.htm
[Link 8]: http://baike.baidu.com/view/1295748.htm
[Link 9]: http://baike.baidu.com/view/209670.htm
[List]: http://baike.baidu.com/view/986776.htm
[web.xml]: http://baike.baidu.com/view/2545054.htm
[Link 10]: http://baike.baidu.com/view/411124.htm
[Link 11]: http://baike.baidu.com/view/421743.htm
[Link 12]: http://baike.baidu.com/view/126530.htm