DWR的原理和解释

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

介绍

它包含两个主要的部分:允许JavaScript从WEB服务器上一个遵循了AJAX原则的Servlet中获取数据.另外一方面一个JavaScript库可以帮助网站开发人员轻松地利用获取的数据来动态改变网页的内容.
DWR采取了一个类似AJAX的新方法来动态生成基于JAVA类的JavaScript代码。这样WEB开发人员就可以在JavaScript里使用Java代码，就像它们是浏览器的本地代码(客户端代码)一样；但是Java代码运行在WEB服务器端而且可以自由访问WEB 服务器的资源。出于安全的理由，WEB开发者必须适当地配置哪些Java类可以安全的被外部使用。[1]
这个从JAVA到JavaScript的远程功能方法给DWR的用户带来非常像传统的RPC机制,就像RMI或者SOAP一样,而且拥有运行在WEB上但是不需要浏览器插件的好处.
DWR不认为浏览器/WEB服务器协议是重要的,而更乐于保证编程界面的简单自然.对此最大的挑战就是把AJAX的异步特性和正常JAVA方法调用的同步特性相结合.在异步模式下,结果数据在开始调用之后的一段时间之后才可以被异步访问获取到.DWR允许WEB开发人员传递一个回调函数,来异步处理Java函数调用过程.
另外 .dwr还是文件的一种格式：比如以Dreamweaver软件里有查找和替换，经常用的查找和替换内容可以保存，保存的文件就是以 .dwr结尾的文件。这种文件用记事本打开后可以看到它的内容

一、调用没有返回值和参数的Java方法

1.1、dwr.xml的配置

<dwr>
<allow>
<create creator="new" javascript="testClass" >
<include method="testMethod1"/>
</create>
</allow>
</dwr>

<allow>标签中包括可以暴露给javascript访问的东西。
<create>标签中指定javascript中可以访问的java类名，并定义DWR应当如何获得要进行远程的类的实例。creator="new"属性指定java类实例的生成方式，new意味着DWR应当调用类的默认构造函数来获得实例，其他的还有spring方式，通过与IOC容器Spring进行集成来获得实例等等。javascript=" testClass "属性指定javascript代码访问对象时使用的名称。
标签指定要公开给javascript的java类名。
<include>标签指定要公开给javascript的方法。不指定的话就公开所有方法。
<exclude>标签指定要防止被访问的方法。
注意：include和exclude不能同时存在
1.2、javascript中调用

首先，引入javascript脚本

<script src='/[WEB-APP]/dwr/interface/ testClass.js'></script>
<script src='/[WEB-APP]/dwr/engine.js'></script>
<script src='/[WEB-APP]/dwr/util.js'></script>

其中TestClass.js是dwr根据配置文件自动生成的，engine.js和util.js是dwr自带的脚本文件。
其次，编写调用java方法的javascript函数

Function callTestMethod1(){
testClass.testMethod1();
}

二、调用有简单返回值的java方法

2.1、dwr.xml的配置
配置同1.1

<dwr>
<allow>
<create creator="new" javascript="testClass" >
<include method="testMethod2"/>
</create>
</allow>
</dwr>

2.2、javascript中调用
首先，引入javascript脚本
其次，编写调用java方法的javascript函数和接收返回值的回调函数

Function callTestMethod2(){
testClass.testMethod2(callBackFortestMethod2);
}
Function callBackFortestMethod2(data){
//其中data接收方法的返回值
//可以在这里对返回值进行处理和显示等等
alert("the return value is " + data);
}

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

三、调用有简单参数的java方法

3.1、dwr.xml的配置
配置同1.1

<dwr>
<allow>
<create creator="new" javascript="testClass" >
<include method="testMethod3"/>
</create>
</allow>
</dwr>

3.2、javascript中调用
首先，引入javascript脚本
其次，编写调用java方法的javascript函数

Function callTestMethod3(){
//定义要传到java方法中的参数
var data;
//构造参数
data = “test String”;
testClass.testMethod3(data);
}

四、调用返回JavaBean的java方法

4.1、dwr.xml的配置

<dwr>
<allow>
<create creator="new" javascript="testClass" >
<include method="testMethod4"/>
</create>
<convert converter="bean" match=""com.dwr.TestBean">
</convert>
</allow>
</dwr>

<creator>标签负责公开用于Web远程的类和类的方法。
<convert>标签则负责这些方法的参数和返回类型。
convert元素的作用是告诉DWR在服务器端Java 对象表示和序列化的JavaScript之间如何转换数据类型。
DWR自动地在Java和JavaScript表示之间调整简单数据类型。
这些类型包括Java原生类型和它们各自的封装类表示，还有String、Date、数组和集合类型。
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是接收返回值的回调函数

五、调用有JavaBean参数的java方法

5.1、dwr.xml的配置
配置同4.1

<dwr>
<allow>
<create creator="new" javascript="testClass" >
<include method="testMethod5"/>
</create>
<convert converter="bean" match="com.dwr.TestBean">
</convert>
</allow>
</dwr>

5.2、javascript中调用
首先，引入javascript脚本
其次，编写调用java方法的javascript函数

Function callTestMethod5(){
//定义要传到java方法中的参数
var data;
//构造参数，data实际上是一个object
data = { username:"user",password:"password" }
testClass.testMethod5(data);
}

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

6.1、dwr.xml的配置
配置同4.1

<dwr>
<allow>
<create creator="new" javascript="testClass" >
<include method="testMethod6"/>
</create>
<convert converter="bean" match="com.dwr.TestBean">
</convert>
</allow>
</dwr>

注意：如果List、Set或者Map中的元素均为简单类型（包括其封装类）或String、Date、数组和集合类型，则不需要<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);
}
}

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

7.1、dwr.xml的配置

<dwr>
<allow>
<create creator="new" javascript="testClass" >
<include method="testMethod7"/>
</create>
<convert converter="bean" match="com.dwr.TestBean">
</convert>
</allow>
<signatures>
<![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数组，即数组的每个元素均为object
data = [
{
username:"user1",password:"password2"
},{
username:"user2",password:" password2"
}
];
testClass.testMethod7(data);
}

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

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","key2":{
username:"user2",password:" password2"
}
};
testClass.testMethod(data);
}

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

<signatures>
<![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数组，传递个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"; 如果没有初始化，则会转换出错。

八、安装配置

1. 安装 DWR JAR 包
下载 dwr.jar 文件，然后将它放在 web 程序的 WEB-INF/lib 目录下面，很可能在这个目录下已经有一些 jar 文件了。
2. 编辑 config 文件
将下面的代码添加到 WEB-INF/web.xml 文件中，<servlet>需要放在另外的<servlet>之后，<servlet-mapping>也是如此。

<servlet>
<servlet-name>dwr-invoker</servlet-name>
<display-name>DWR Servlet</display-name>
<servlet-class>uk.ltd.getahead.dwr.DWRServlet</servlet-class>

workjjh
<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 creator=”new” javascript=”JDate”>
</create>
<create creator=”new” javascript=”Demo”>
</create>
</allow>
</dwr>

DWR 配置文件定义了由 DWR 创建和被 Javascript 远程使用的类。在上面的例子中我们在远程创建了2个类，并且给出了在 Javascript 中的类名。
上面使用的 new creator 使用了所有的 JavaBeans 必须含有的公有（public）无参（no-args）的构造函数。值得一提的是， DWR 还有一些限制：
避免使用 JavaScript 保留字；以保留字命名的方法将自动被排除。大多数 JavaScript 的保留字同时也是 Java 的保留字，因此无论如何你也不能使用一个名为 “try()” 的方法。但是最常用的一个词 “delete()”，在 JavaScript 中有特殊的含义而在 Java 中没有。
重载方法（Overloaded methods）将会在调用的时候陷入未知的状况，因此应该避免重载方法。
3. 访问下面的地址
http://localhost:8080/[YOUR-WEBAPP]/dwr/
你应该会看到一个页面，上面显示了刚才你在第二步所创建的类。进入一个链接之后你会看到所有等待调用方法的列表。这些动态产生的例子你也能通过 DWR 来实现。
亲自尝试和体会下吧。
怎样应用到你的 Web 程序中？
在侧边栏有很多例子演示了怎样改变网页中的文本、更新列表、操作表单和动态修改表格。每一个例子都有详细的说明。
另外一个开始方法就是从页面中查看源代码，这些页面你刚刚浏览过：
进入 http://localhost:8080/[YOUR-WEBAPP]/dwr/ 然后点击你创建的类；
查看源代码然后定位到你所感兴趣的方法的代码行；
将这些文本粘贴到你 Web 程序的一个 HTML 或 JSP页面中；
包含下面的 javascrip 文件：
<script src=’/[YOUR-WEBAPP]/dwr/interface/[YOUR-SCRIPT].js’></script>
<script src=’/[YOUR-WEBAPP]/dwr/engine.js’></script>
你可以根据实际情况修改 /[YOUR-WEBAPP]/ 部分。

九、相关配置

1、拷贝dwr.jar到项目的lib中
2、配置web.xml，添加：

<servlet>
<servlet-name>dwr-invoker</servlet-name>
<servlet-class>org.directwebremoting.servlet.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>

3、新建dwr.xml，配置允许js调用的class

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE dwr PUBLIC "-//GetAhead Limited//DTD Direct Web Remoting 2.0//EN" "http://www.getahead.ltd.（由于编辑过程中不能存在网址，所以此解释是隐藏的）uk/dwr/dwr20.dtd">
<dwr>
<allow>
<create creator="new" javascript="Hello" scope="page">
<param name="class" value="demo.Hello" />
</create>
</allow>
</dwr>

如果有自定义类型可以考虑添加下面的配置在<allow>中
<convert converter="bean" match="x.y.Bean"/>
你必须让DWR知道通过XMLHttpRequest对象，什么对象将会接收请求。这个任务由叫做dwr.xml的配置文件来完成。在配置文件中，定义了DWR允许你从网页中调用的对象。从设计上讲，DWR允许访问所有公布类的公共方法，但在我们的例子中，我们只允许访问几个方法。下面是我们示例的配置文件：

<dwr>
<allow>
<convert converter="bean" match="com.yd.pojos.UseRSS"/>
<create creator="new" javascript="userAction" class="com.yd.imp.UserCol">
<include method="getALlUser"/>
</create>
</allow>
</dwr>

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

<script type="text/javascript" src="dwr/engine.js"></script>
<script type="text/javascript" src="dwr/util.js"></script>
<script type="text/javascript" src="dwr/interface/Hello.js"></script>

说明：Hello.js 对应dwr.xml <create creator="new" javascript="Hello" scope="page">
5、自行设计调用处理方法

<script type="text/javascript">
function callback(str)
{
alert(str);
}
function test()
{
Hello.sayHelloTo("zhangsan",callback);
}
</script>