DWR中Java方法的参数及返回值

DWR是一个框架，简单的说就是能够在javascript直接调用java方法，而不必去写一大堆的javascript代码。它的实现是基于ajax的，可以实现无刷新效果。

网上有不少DWR的例子，但大都只是某种方法的调用，本文只在使用层面上介绍DWR，并不涉更多的技术与设计，其目的是让初学者能够很快的学会各种java方法在javascript中是如何调用的。

本文以DWR 1.1 为基础，对于DWR 2.0，因为还没有正式发布版，故不做介绍。

一、DWR配置篇之web.xml

1 、最小配置

Xml代码

1.   
2.   dwr-invoker  
3.   uk.ltd.getahead.dwr.DWRServlet  
4.   
5.   
6.   dwr-invoker  
7.   /dwr/*  
8.   

dwr-invokeruk.ltd.getahead.dwr.DWRServletdwr-invoker/dwr/*

2、当我们想看DWR自动生成的测试页（Using debug/test mode）时，可在servlet配置中加上

Xml代码

1.   
2.   debug  
3.   true  
4.   

debugtrue

这个参数DWR默认是false。如果选择true，我们可以通过http://localhost:port/app/dwr 看到你部署的每个DWR class。并且可以测试java代码的每个方法是否运行正常。为了安全考虑，在正式环境下你一定把这个参数设为false。

 

3、多个dwr.xml文件的配置

可能有几种情况，我们一一列举。一个servlet，多个dwr.xml配置文件；多个servlet，每个servlet对应一个或多个dwr.xml配置文件。

3.1、一个servlet，多个dwr.xml配置文件

Xml代码

1.   
2.     dwr-invoker  
3.     uk.ltd.getahead.dwr.DWRServlet  
4.       
5.       config-1  
6.       WEB-INF/dwr1.xml  
7.       
8.       
9.       config-2  
10.       WEB-INF/dwr2.xml  
11.       
12.   

dwr-invokeruk.ltd.getahead.dwr.DWRServletconfig-1WEB-INF/dwr1.xmlconfig-2WEB-INF/dwr2.xml

在这种配置下，param-name的值必须以config开头。param-name可以有>=0个。如果没有param-name，那么将会读取WEB-INF/dwr.xml。如果有大于零个param-name，那么WEB-INF/dwr.xml文件将不会被读取。

 

3.2 、多个 servlet ，每个 servlet 对应一个或多个 dwr.xml

Xml代码

1.   
2.    dwr-invoker  
3.     uk.ltd.getahead.dwr.DWRServlet  
4.   
5.   
6.    dwr-invoker1  
7.    uk.ltd.getahead.dwr.DWRServlet  
8.      
9.      config-admin  
10.      WEB-INF/dwr1.xml  
11.      
12.      
13.      debug  
14.      true  
15.      
16.   
17.   
18. dwr-invoker  
19.    /dwr/*  
20.   
21.   
22.    dwr-invoker1  
23.    /dwr1/*  
24.   

dwr-invokeruk.ltd.getahead.dwr.DWRServletdwr-invoker1uk.ltd.getahead.dwr.DWRServletconfig-adminWEB-INF/dwr1.xmldebugtruedwr-invoker/dwr/*dwr-invoker1/dwr1/*

在这种情况下，我们可以根据 J2EE security 来控制权限，针对不同 url, 加不同的角色。

 

二、DWR使用篇

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

1.1、dwr.xml的配置

Xml代码

1.   
2.     
3.      creator="new" javascript="testClass" >  
4.        name="class" value="com.dwr.TestClass" />  
5.        method="testMethod1"/>  
6.       
7.     
8.   

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

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

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

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

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

 

1.2、javascript中调用

首先，引入 javascript 脚本

Js代码

1. 'dwr/interface/ testClass.js'>   
2. 'dwr/engine.js'>   
3. 'dwr/util.js'>  

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

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

Js代码

1. Function callTestMethod1(){   
2.   testClass.testMethod1();   
3. }  

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

 

 

2.调用有简单返回值的java方法

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

Xml代码

1.   
2.    
3.    creator="new" javascript="testClass" >  
4.     name="class" value="com.dwr.TestClass" />  
5.     method="testMethod2"/>  
6.     
7.    
8.    

 2.2、javascript中调用

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

Js代码

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

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

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

 

3、调用有简单参数的java方法
3.1、dwr.xml的配置
配置同1.1

Xml代码

1.   
2.    
3.    creator="new" javascript="testClass" >  
4.     name="class" value="com.dwr.TestClass" />  
5.     method="testMethod3"/>  
6.     
7.    
8.    

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

Js代码

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

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

4、调用返回JavaBean的java方法

4.1、dwr.xml的配置

Xml代码

1.   
2.    
3.    creator="new" javascript="testClass" >  
4.     name="class" value="com.dwr.TestClass" />  
5.     method="testMethod4"/>  
6.     
7.    converter="bean" match=""com.dwr.TestBean">  
8.     name="include" value="username,password" />  
9.     
10.    
11.    

标签负责公开用于Web远程的类和类的方法，标签则负责这些方法的参数和返回类型。convert元素的作用是告诉DWR在服务器端Java 对象表示和序列化的JavaScript之间如何转换数据类型。DWR自动地在Java和JavaScript表示之间调整简单数据类型。这些类型包括 Java原生类型和它们各自的封装类表示，还有String、Date、数组和集合类型。DWR也能把JavaBean转换成JavaScript 表示，但是出于安全性的原因，要求显式的配置，标签就是完成此功能的。converter="bean"属性指定转换的方式采用JavaBean命名规范，match=""com.dwr.TestBean"属性指定要转换的javabean名称，4.2、javascript中调用
首先，引入javascript脚本
其次，编写调用java方法的javascript函数和接收返回值的回调函数

Js代码

1. Function callTestMethod4(){   
2.  testClass.testMethod4(callBackFortestMethod4);   
3. }   
4. Function callBackFortestMethod4(data){   
5.  //其中date接收方法的返回值   
6.  //对于JavaBean返回值，有两种方式处理   
7.  //不知道属性名称时，使用如下方法   
8.  for(var property in data){   
9.   alert("property:"+property);   
10.   alert(property+":"+data[property]);   
11.  }   
12.  //知道属性名称时，使用如下方法   
13.  alert(data.username);   
14.  alert(data.password);   
15. }   

Function callTestMethod4(){testClass.testMethod4(callBackFortestMethod4);}Function callBackFortestMethod4(data){//其中date接收方法的返回值//对于JavaBean返回值，有两种方式处理//不知道属性名称时，使用如下方法for(var property in data){alert("property:"+property);alert(property+":"+data[property]);}//知道属性名称时，使用如下方法alert(data.username);alert(data.password);} 

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

5、调用有JavaBean参数的java方法
5.1、dwr.xml的配置
配置同4.1

Xml代码

1.   
2.    
3.    creator="new" javascript="testClass" >  
4.     name="class" value="com.dwr.TestClass" />  
5.     method="testMethod5"/>  
6.     
7.    converter="bean" match="com.dwr.TestBean">  
8.     name="include" value="username,password" />  
9.     
10.    
11.    

5.2、javascript中调用

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

Js代码

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

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

 

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

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

Xml代码

1.   
2.    
3.    creator="new" javascript="testClass" >  
4.   
5.     name="class" value="com.dwr.TestClass" />  
6.     method="testMethod6"/>  
7.     
8.    converter="bean" match="com.dwr.TestBean">  
9.     name="include" value="username,password" />  
10.     
11.    
12.    

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

6.2、javascript中调用(以返回List为例，List的元素为TestBean)
首先，引入javascript脚本
其次，编写调用java方法的javascript函数和接收返回值的回调函数

Js代码

1. Function callTestMethod6(){   
2.  testClass.testMethod6(callBackFortestMethod6);   
3. }   
4. Function callBackFortestMethod6(data){   
5.  //其中date接收方法的返回值   
6.  //对于JavaBean返回值，有两种方式处理   
7.  //不知道属性名称时，使用如下方法   
8.  for(var i=0;i
9.   for(var property in data){   
10.    alert("property:"+property);   
11.    alert(property+":"+data[property]);   
12.   }   
13.  }   
14.  //知道属性名称时，使用如下方法   
15.  for(var i=0;i
16.   alert(data[i].username);   
17.   alert(data[i].password);   
18.  }   
19. }   

Function callTestMethod6(){testClass.testMethod6(callBackFortestMethod6);}Function callBackFortestMethod6(data){//其中date接收方法的返回值//对于JavaBean返回值，有两种方式处理//不知道属性名称时，使用如下方法for(var i=0;i

7、调用有List、Set或者Map参数的java方法 
7.1、dwr.xml的配置
Xml代码 
 
  
 
   
 
   creator="new" javascript="testClass" >  
 
    name="class" value="com.dwr.TestClass" />  
 
    method="testMethod7"/>  
 
    
 
   converter="bean" match="com.dwr.TestBean">  
 
    name="include" value="username,password" />  
 
    
 
   
 
  
 
   
 
   
 
   import java.util.List;  
 
   import com.dwr.TestClass;  
 
   import com.dwr.TestBean;  
 
   TestClass.testMethod7(List);  
 
  ]]>  
 
   
 
   
);]]> 
标签是用来声明java方法中List、Set或者Map参数所包含的确切类，以便java代码作出判断。
7.2、javascript中调用(以返回List为例，List的元素为TestBean) 
首先，引入javascript脚本 
其次，编写调用java方法的javascript函数
Js代码 
 
Function callTestMethod7(){   
 
 //定义要传到java方法中的参数   
 
 var data;   
 
 //构造参数，date实际上是一个object数组，即数组的每个元素均为object   
 
 data = [   
 
 {username:"user1",password:"password2"},   
 
 {username:"user2",password:" password2"}   
 
 ];   
 
 testClass.testMethod7(data);   
 
}  
Function callTestMethod7(){//定义要传到java方法中的参数var data;//构造参数，date实际上是一个object数组，即数组的每个元素均为objectdata = [{username:"user1",password:"password2"},{username:"user2",password:" password2"}];testClass.testMethod7(data);}
 
注意 ：
1、对于第6种情况，如果java方法的返回值为Map，则在接收该返回值的javascript回调函数中如下处理：
Js代码 
 
function callBackFortestMethod(data){   
 
 //其中date接收方法的返回值   
 
 for(var property in data){   
 
  var bean = data[property];   
 
  alert(bean.username);   
 
  alert(bean.password);   
 
 }   
 
}   
function callBackFortestMethod(data){//其中date接收方法的返回值for(var property in data){var bean = data[property];alert(bean.username);alert(bean.password);}} 
2、对于第7种情况，如果java的方法的参数为Map（假设其key为String，value为TestBean），则在调用该方法的javascript函数中用如下方法构造要传递的参数：
Js代码 
 
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);   
 
}   
function callTestMethod (){//定义要传到java方法中的参数var data;//构造参数，date实际上是一个object，其属性名为Map的key，属性值为Map 的valuedata = {"key1":{username:"user1",password:"password2"},"key2":{username:"user2",password:" password2"}};testClass.testMethod(data);} 
并且在dwr.xml中增加如下的配置段
Xml代码 
 
  
 
  
 
  import java.util.List;  
 
  import com.dwr.TestClass;  
 
  import com.dwr.TestBean;  
 
  TestClass.testMethod7(Map);  
 
 ]]>  
 
   
);]]> 
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中。