DWR使用总结

DWR使用总结

这两天学了下DWR，现在总结一下。
DWR是方便使用AJAX连接JS和JAVA的的一个框架, 把服务器端 Java 对象的方法公开给 JavaScript 代码。
如果是用dwr2.0的jar包，还需要同时导入 log4j.jar和commons-loggin.jar,勿忘!!
web.xml和dwr.xml放在WEB-INF下!
-----------------------------
配置web.xml:WEB工程启动的时候会在这个里面找到具体所用到的类的路径，由此进行加载

<servlet>
    <servlet-name> dwr-invoke </servlet-name>
    <servlet-class> uk.ltd.getahead.dwr.DWRServlet </servlet>
     <init-param> //这个是调试用，如果正式发布请该为false，不过听说2.0就默认为true了
        <param-name> debug </param-value>
       <param-value> true </param-value>
    </init-param>
     <init-param> //这个是DWR2.0必须的,不然会报java.lang.IllegalArgumentException
        <param-name> classes </param-value>
       <param-value> java.lang.Object </param-value>
</servlet>

<servlet-mapping>
    <servlet-name> dwr-invoke </servlet-name>
    <url-pattern> /dwr/* </url-pattern>
</servlet-mapping>

-----------------------------
配置dwr.xml: dwr.xml的作用是让你告诉DWR哪些class中的哪些方法你需要暴露给前台使用，当DWR启动时候根据dwr.xml这个文件把java类中的方法转成js中可用的类中方法，使前台可以使用。

注:以下是不全按dwr2.0写的，如果用的是DWR2.0，那java里暴露类(蓝字显示)不能写在<create>属性里，应删除后写在<include method="" />前，<param name="class" value="***java里暴露的class,必须写完整路径***" />。


<dwr>
    <allow>
       <create creator="new" javascript="***js调用的class***"  class="***java里暴露的class,必须写完整路径***">
            <include method="***java暴露类里要公开的方法，如果不写默认全部公开***" />
       </create>
    </allow>
</dwr>

-----------------------------
在html或js页面中加入
<script src="<%=basePath %>dwr/interface/java里暴露的class"></script>  //切记不能<script *** />这样写
<script src=" <%=basePath %> dwr/engine.js"></script>   //Dwr的脚本驱动Js,以上两个必写
<script src=" <%=basePath %> dwr/util.js"></script>   //这是个工具包，可以不调用
<script type="text/javascript">
    function doMethod()
    {
        //调用方法:若公开的类是AAA,公开的AAA里的方法是bbb([参数]);
        AAA.bbb([参数],callBack);//回调函数callBack()
    }

    function callBack(data)//data是后台返回的值，名字自取，也可省略，因为JS允许
    {
       处理方法……;//如果callBack()没有写明返回值，可以通过argments[0]拿到
    }
</script>


其实我们调用AAA.bbb([参数],callBack);就是做了以下这一步：
(下面红字是包装好的，不在前台，所以即使你没有创建html或者jsp来调用，也可以通过localhost:8080/工程名/dwr 来看到你暴露的java类进行测试)
     function AAA() { };
    AAA.bbb = function([参数], callback) 
    { 
        DWREngine._execute('/dwr/dwr', 'AAA', 'bbb', [参数], callback); 
    }

通过在dwr.xml暴露的方法得到js里的方法，当我们调用AAA.bbb时候再通过/dwr/dwr转到DWRServlet中去用JAVA里的AAA.bbb方法，然后返回值到callback中(中间经过dwr.xml的convert)


----------------------------
上面对dwr的工作大致分析了下，现在对于参数类型的不同，对dwr.xml也要进行修正。

DWR自动地在Java和JavaScript表示之间调整简单数据类型,这些类型包括Java原生类型和它们各自的封装类表示，还有String、Date、数组和集合类型。但如果参数类型非简单数据类型，则要通过转换。

调用返回JavaBean的java 方法

在dwr.xml的<allow>标签中加入

<convert converter="bean" match="***一般来说是javabean***">  //int,String,list等不需要显式的转换就可以被js拿到
      <param name="include" value="***javabean中的属性，用','隔开***" />  //这句可以不写
</convert>

<creator>标签负责公开用于Web远程的类和类的方法，<convertor>标签则负责这些方法的参数和返回类型。 convert元素的作用是告诉DWR在服务器端Java 对象表示和序列化的JavaScript之间如何转换数据类型。

这样在js端回调函数直接拿到的data就是一个javabean,可以直接通过data.xxx拿到bean的属性xxx。

调用有JavaBean参数的java 方法

dwr.xml配置同上。

在JS端，把要传入的参数写成javabean方式，例：要传入一个名为student的javabean,参数有name,password,则
var stu = {name:"zhangsan",password:"zspassword"}; //这是json的表示方法
AAA.bbb(stu,callBack);

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

dwr.xml配置同上。如果Collection里的数据是简单数据类型，则可不需要写<convert>

在JS端，以 List，里面数据是bean为例，data是一个List型，只要用for循环就可以依次拿到数据。
遍历方法1:
for(var i=0;i<data.length;i++)  
    /*对于java方法的返回值为List(Set)的情况，DWR将其转                                 化为Object数组，传递个javascript*/
{
    alert(data[i].name+":"+data[i].password);
}

遍历方法2:
for(var  property  in data) //property为序号,从0开始
{
    var bean = data[ property ];
    alert(bean.name+":"+bean.password);
}

相比返回为javabean多了一个遍历而已。

如果java方法的返回值为 Map,则如下

for(var property in data) //property为key值
    /*对于 java方法的返回值为Map的情况，DWR将其转化为一个Object，
     其中Object的属性为原Map的key值，属性值为原Map相应的 value值*/
{
  var bean = data[property];
  alert(bean.username);
  alert(bean.password);
}

如果知道key值，则可直接用:data.key拿到value

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

在dwr.xml的<dwr>标签内加入:<signatures>标签。

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

例参数是javabean的List,则只要在参数为javabean的例子里构造时候加上[]即可，如下：

var stu = [{name:"zhangsan",password:"zspassword"},{name:"lisi",password:"lspassword"}];
//把List当作数组来处理
AAA.bbb(stu,callBack);

并且在dwr.xml中增加如下的配置段 (刚才试验了下，不加也可以)

<signatures>
 <![CDATA[
  import java.util.List;
  import com.dwr.AAA;     //AAA的包路径要写完整
  import com.dwr.TestBean;  //javabean
  AAA.bbb(List<TestBean>); 
 ]]>
</signatures>

例参数是javabean的Map, key是String,value是javabean, 如下:
var stu =

{
    "key1":{name:"zhangsan",password:"zspassword"},
    "key2":{name:"lisi",password:"lspassword"}
};

AAA.bbb(stu,callBack);

并且在dwr.xml中增加如下的配置段 (刚才试验了下，不加也可以)

<signatures>
 <![CDATA[
  import java.util.List;
  import com.dwr.AAA;     //AAA的包路径要写完整
  import com.dwr.TestBean;  //javabean
  AAA.bbb(Map<String,TestBean>); 
 ]]>
</signatures>

也许朋友们会以为这是DWR官方发布的什么帮助，但非常遗憾这不是。现在不少朋友在使用DWR开发项目，我也是其中之一，但苦于关于DWR的帮助文档实在太少，很多问题都不得不自己去钻研DWR的源码才能解决或理解。经过一段时间的苦苦钻研，总结出那么一点点心得，现在从DWR源码实现的角度详细讲解DWR的使用，写出来与大家分享。今天我先讲一讲dwr.xml的配置。

一、为什么要配置dwr.xml

要理解dwr.xml的配置首先要理解DWR的基本功能。DWR其功能的强大在于它可以用一种前所未有的便利方式将前端页面中的js与后端服务器中的java程序进行直接的转换。比如，它可以将java程序中的某个XxxBus转换成js中的一个对象，并将XxxBus中的某个方法如getXXX()转换成js中的一个名为XxxBus.getXXX()的function。同时，它可以将java中的值对象或其它数据包转换成js中的对象。理解这一点非常重要。配置文件dwr.xml就是让你告诉DWR哪些Bus你需要在页面中调用，以及你需要调用这些Bus中的哪些方法，哪些方法你不需要调用。一旦告诉了DWR这些信息，你似乎就可以在页面中像写java程序一样的直接调用Bus，而跳过了MVC层（如struts中的action和actionform）以及MVC层的繁琐配置与编程。为了帮助你理解这一点我举一个例子，已经清楚的朋友可以跳过。

假如我在项目的BUS层写了一个类叫DepartmentBus并在这个类中定义了一个方法getDepartment(String id)，那么我们先把这个类和它的方法配置到dwr.xml中（如何配置我后面再讲）。当DWR启动的时候，它会将java中的DepartmentBus及其方法getDepartment(String id)转换成js中的DepartmentBus及其方法getDepartment(String id)。更具体地说，它会动态产生一个叫DepartmentBus.js的文件（这个文件可以在测试状态下从“项目地址端口/dwr/test/DepartmentBus”中看到）。在这个文件中，会创建一个DepartmentBus的对象，一个叫DepartmentBus.fincDepartment(p0, callback)的函数。如果你在页面中引入了DepartmentBus.js文件，你就可以在该页面的 中调用DepartmentBus.fincDepartment(p0, callback)方法，DWR就可以通过Ajax的方式直接去调用服务器端的DepartmentBus中的fincDepartment(String id)。同理，如果DepartmentBus中还有其它的函数，如createDepartment(Department vo)、updateDepartment(Department vo)等，DWR也会做如此的转换。

前面我们提到，DWR可以将服务器端java中的对象及其方法转换成客户端的js中的对象及其方法，一个棘手的问题就出现了。在java中的许多方法都是将某个对象作为它参数或返回值。这些对象往往都是一个个的JOPO，即它们有许多的属性，其中包含了需要传递的数据（最典型的就是值对象）。当js在调用java的某个方法时需要提供这个对象参数，同时在调用完成时需要将对象返回值以js可以接受的方式返回。怎样做到这一点呢？最简单的方式当然是让DWR再做一次转换，将这些java对象转换成js的对象，或者将js的对象转换成java对象。Ok，经过DWR这样的两次转换，我们就可以在页面与后台间自由地进行函数调用和数据交换。

二、如何配置dwr.xml文件

讲到这里，我们现在重新回到dwr.xml文件。前面我们提到，如果你需要在页面中调用服务器端的某个类中的方法，你需要在dwr.xml中注册这个类及其方法，注册方法如下：

1. <create creator="spring" javascript="DepartmentBus" scope="script">  
2.       <param name="beanName" value="departmentBus"/>  
3. create>  

Creator是创建这个对象所使用的构建器，如果你希望使用传统的new方法就写成new，如果你希望使用spring来创建则写成spring。当然也有其它的创建方法，有哪些方法呢？你可以打开dwr.jar，在org.directwebremoting包中找到一个dwr.xml的文件。在该文件init下的create中可以看到。

Javascript是用于你在js中调用这个对象时使用什么名称，强烈建议你使用首字母大写，这样在页面中很容易看出这是一个与后台对应的对象。如果你使用了spring并且在creator中选择了spring，那么你需要一个叫beanName的参数，而其值就是在spring配置文件中配置的beanName，如departmentBus。另外2个非常有用的参数是exclude和include，exclude可以禁止页面调用后台的某个或某些方法，具体的写法是在create中加入：

1. <exclude method="createDepartment"/>  

method部分写的是这些方法不带括号的方法名，如果有多个就写多行exclude；include则规定页面只能调用某些方法。

在dwr.xml中注册了需要调用的对象及其方法以后，你应当注册其所有方法的参数和返回值所涉及的对象，注册方法如下：

xml 代码

1. <convert match="com.htxx.demo.datasource1.model.Department"    
2. javascript="Department" converter="hibernate3"/>  

match用于告诉DWR你将需要把java中的哪些类转换成js。你可以写成com.htxx.demo.model.*，但我并不推荐大家这样使用。为什么呢？如果你像前面那样一个一个地注册对象，则就可以在页面使用这个的语句初始化一个对象：

var dep = new Department();

如果你使用后一种方法去批量注册对象，那么你就不能这样初始化这个对象而只能这样手动注册：

Var dep = {departmentId:null, departmentName:null, ……};

我推荐大家采用第一种方法的好处可以在我后面写的《DWR帮助说明－如何编写通用的单行编辑框》充分展现出来。但采用这种方法在DWR的现有版本中似乎还有点儿BUG，如何解决这个BUG我也将在后面的《DWR帮助说明－dwr的bug及其解决方法》中解答。

Javascript用于说明你在页面中使用这个对象的名称，也强烈建议大家使用首字母大写。Converter用于告诉DWR用什么DWR的类来执行转换，常用的转换器有bean、object、hibernate2、hibernate3等。DWR有哪些转换器可以在dwr.jar的dwr.xml（该文件的位置见前文）中找到。我需要强调的是，如果朋友们使用了hibernate，那么你需要将需要使用的所有值对象都通过转换器注册。但是我在网上看见很多朋友都使用bean转换器来注册。如果你使用bean来转换值对象，在运行程序的时候会出现很多问题（这些问题我就不详述了），同时还会出现效率的问题，因为DWR会将该值对象的所有属性，及其这些属性的所有属性，所有属性的属性，都以穷举的方式取出来。熟悉hibernate的朋友应当马上明白这样将是数据库操作的一个灾难。如果你使用hibernate2或hibernate3作为转换器将不会发生这样的事，同时，hibernate3还较好地解决了延迟查询的问题，但DWR官方建议我们使用hibernate的openSessionInViewFilter，这我也不再详述，不清楚的朋友可以查阅hibernate3的帮助文档。但另一个问题我不得不提，DWR在使用延迟查询的时候其实还是有问题的。譬如有一个值对象Employee包含一个Department的属性，根据延迟查询的规则，在get某个Employee时，属性Department不会马上装载，即使执行getDepartment()也不会装载。必须到真正对这个Department操作的时候才会装载。既然如此，问题就来了，我们使用DWR执行查询的时候，常常是真正到页面才会读取Department，这时已经是脱离服务器端到页面端了而不能再得到Department。这个问题怎么办呢，最好的办法是在服务器端就提前装载页面需要使用的属性，因为作为开发者他肯定知道哪些属性要在客户端使用，哪些属性不需要。至于如何在服务器端就提前装载，感兴趣的朋友在我的示例中看到。

另外一个需要提的是，与creator一样，转换器也可以一样地设置exclude和include参数。但是与creator不同的是，它们说明DWR在转换对象的时候需要转换或不转换某些属性。这个参数对于hibernate的一对一关联非常重要。在hibernate中一对一关联是不做延迟查询的，假如有一个值对象Employee与值对象Address是一对一关联，那么Employee中有Address的属性，而Address中有Employee的属性。由于一对一关联不做延迟查询，当DWR在转换一个Employee是会装载它的属性Address，然后在装载Address的时候，又会去装载Address中的Employee属性。如此这样，就会形成一个死循环，最后以堆栈溢出告终。解决这个问题的办法就是禁掉Address中的Employee属性，避免产生死循环。具体写法如下：

xml 代码

1. <convert match="com.htxx.demo.model.Address" javascript="Address" converter="hibernate3">  
2.     <param name="exclude" value="employee"/>  
3. </convert>  

Value部分是需要转换的属性，如果有多个则用逗号隔开就可以了。（一个dwr+spring+hibernate的示例）