dwr注解基础+何为dwr

DWR使用笔记

分析DWR util.js包

 

DWR3.0与Spring MVC集成方法

分析DWR util.js包 

 

 

DWR是一个开源的类库,它允许在浏览器里的代码使用运行在WEB服务器上的JAVA函数,就像它就在浏览器里一样.

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

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

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

DWR 不认为浏览器/WEB服务器协议是重要的,而更乐于保证编程界面的简单自然.对此最大的挑战就是把AJAX的异步特性和正常JAVA方法调用的同步特性相 结合.在异步模式下,结果数据在开始调用之后的一段时间之后才可以访问.DWR解决了这个问题,允许WEB开发人员使用一个特殊的方法参数来指定一个函 数,以便在数据返回后来回调此函数.

 

 

一、配置DWR使用注解功能

如果让dwr使用注解功能需要在web.xml进行如下配置：

1. < servlet >
2.          < servlet-name > dwr-invoker </ servlet-name >
3.          < servlet-class > org.directwebremoting.servlet.DwrServlet </ servlet-class >
4.          < init-param >
5.              < param-name > debug </ param-name >
6.              < param-value > true </ param-value >
7.          </ init-param >
8.          <!-- 将设定注解的域对象和业务实现类放在下面列表中，中间使用逗号间隔 -->
9.          < init-param >
10.              < param-name > classes </ param-name >
11.              < param-value >
12.                 com.dwr.test.Book,
13.                 com.dwr.test. Bank,
14.                 com.dwr.test. dao.BookDao
15.              </ param-value >
16.          </ init-param >
17.      </ servlet >
18.      < servlet-mapping >
19.          < servlet-name > dwr-invoker </ servlet-name >
20.          < url-pattern > /dwr/* </ url-pattern >
21.      </ servlet-mapping >

这样设置之后就可以在dwr中使用注解了，非常的方便。

二、DWR提供的注解类型
经常用到的注解主要有：@RemoteProxy、@RemoteMethod、@DataTransferObject和@RemoteProperty。

1. @RemoteProxy和@RemoteMethod
@RemoteMethod 对应于原来dwr.xml文件中的create标签，用于创建DWR所提供的远程方法；而@RemoteMethod对应于create标签中的 <include method=”"/>，用来指定所要暴露的方法名称。我们举例来说明：

1. @ RemoteProxy ( name = " bankFunctions " )
2. public   class    Bank   {
3.  
4.     @ RemoteMethod
5.      public   void   buy ()   {
6.          // ...
7.      }
8. }

从上面可以看出，@RemoteProxy表示这个类将用于远程方法，而使用@RemoteMethod指定所要暴露的方法，没有使用@RemoteMethod的方法将不会显示在客户端。
上面的注释使用dwr.xml表示如下：

1. < ! DOCTYPE   dwr   PUBLIC
2.      " -//GetAhead Limited//DTD Direct Web Remoting 2.0//EN "
3.      " http://getahead.ltd.uk/dwr/dwr20.dtd " >
4. < dwr >
5.      < allow >
6.          < create   creator = " new "   javascript = " bankFunctions " >
7.      < param   name = " class "   value = "  com.dwr.test. Bank "   />
8.              < include   method = " buy "   />
9.          </ create >
10.      </ allow >
11. </ dwr >

如果使用Spring中的DAO或逻辑层则需要进行如下的设置：

1. // BookDao
2. @ RemoteProxy ( creator  =  SpringCreator . class ,
3.      creatorParams  = @ Param ( name  =  " beanName " ,  value  =  " bookDao " ) ,
4.      name = " bookFunctions " )
5. public   class    BookDao   {
6.  
7.     @ RemoteMethod
8.      public   void   addBook ( Book   book )   {
9.          // ...
10.      }
11. }

通过指定@RemoteProxy中的creator类型为SpringCreator，然后在creatorParams指定对应的beanName名称。对应的dwr.xml文件如下：

1. < ! DOCTYPE   dwr   PUBLIC
2.      " -//GetAhead Limited//DTD Direct Web Remoting 2.0//EN "
3.      " http://getahead.ltd.uk/dwr/dwr20.dtd " >
4. < dwr >
5.      < allow >
6.          < create   creator = " spring "   javascript = " bookFunctions " >
7.              < param   name = " beanName "   value = " bookDao "   />
8.              < include   method = " addBook "   />
9.          </ create >
10.      </ allow >
11. </ dwr >

2. @DataTransferObject和@RemoteProperty
@DataTransferObject对应于原来dwr.xml文件中的convert标签，用于转换Java对象；@RemoteProperty则对应于convert标签中的 <param name=”include” value=”" />。

举例说明一下：

1. @ DataTransferObject
2. public   class   Book   {
3.     @ RemoteProperty
4.      private   int   id ;
5.  
6.     @ RemoteProperty
7.      private   String   name ;
8.  
9.      public   Book ()   {
10.      }
11.  
12.      public   int   getId ()   {
13.          return   id ;
14.      }
15.  
16.      public   void   setId ( int   id )   {
17.          this . id  =  id ;
18.      }
19.  
20.      public   String   getName ()   {
21.          return   name ;
22.      }
23.  
24.      public   void   setName ( String   name )   {
25.          this . name  =  name ;
26.      }
27. }

@RemoteProperty可以放在JavaBean中的私有变量上面，也可以放在getXXX方法上面。另外如果想将JavaBean中所有的属性都暴露出来的话，不需要在任何属性上面添加@RemoteProperty注释就可以了。

上面的注释对应的dwr.xml文件如下：

1. < ! DOCTYPE   dwr   PUBLIC
2.      " -//GetAhead Limited//DTD Direct Web Remoting 2.0//EN "
3.      " http://getahead.ltd.uk/dwr/dwr20.dtd " >
4. < dwr >
5.      < allow >
6.          < convert   converter = " bean "
7.              match = " com.javatang.domain.Book " >
8.              < param   name = " include "   value = " id, name "   />
9.          </ convert >
10.          <!-- 或者用下面的方式也可以
11.         <convert converter="bean" match="com.javatang.domain.Book" />
12.         -->
13.      </ allow >
14. </ dwr >

关于具体每个注释使用的方法已经所包含的参数可以参考Java Doc。使用DWR2.0的注解极大的简化了原来dwr.xml的配置，非常的方便。

 

总结：

 针对DWR对Javabean的注解分为两类：

Object和Class

针对Class的注解使用：

@RemoteProperty 注解类为远程访问类,相等于create

@RemoteMethod 注解类为远程访问方法,相等于dwr.xml中白名单中注解的方法

注意默认的类中所有的方法为全部在黑名单中。不可作为远程访问对象的。

 

针对：Object使用@DataTransferObject 和@RemoteProperty注解接口

@DataTransferObject仅仅注解类对象

@RemoteProperty注解属性和方法的应用

 

 

 

使用远程访问类的

package com.dwr.test;

import org.directwebremoting.annotations.RemoteMethod;
import org.directwebremoting.annotations.RemoteProxy;
/**
 * 注解此类为远程访问对象的应用
 * @author Rabby
 *
 */
@RemoteProxy(name = "DWRAnnotation")
public class DWRAnnotation {
 /**
  * 注解此方法为远程方法的
  * @param username
  * @return
  */
 @RemoteMethod
 public String hello(String username) {
  return "Hello ," + username;
 }
}

web.xml的配置信息：

 

<servlet>
  <servlet-name>dwr</servlet-name>
  <servlet-class>
   org.directwebremoting.servlet.DwrServlet
  </servlet-class>
  <!-- 用于测试dwr的模式 -->
  <init-param>
    <param-name>debug</param-name>
    <param-value>true</param-value>
  </init-param>
  <!-- 针对注解类必须使用的远程访问对象的描述 -->
  <init-param>
   <param-name>classes</param-name>
   <param-value>
    com.dwr.test.DWRAnnotation
   </param-value>
  </init-param>
 </servlet>
 <servlet-mapping>
  <servlet-name>dwr</servlet-name>
  <url-pattern>/dwr/*</url-pattern>
 </servlet-mapping>
 <welcome-file-list>
  <welcome-file>index.jsp</welcome-file>
 </welcome-file-list>
</web-app>

相应的jsp页面用于测试注解的使用

 

 <head>

  <script type='text/javascript'
   src='/DWRAnnotation/dwr/interface/DWRAnnotation.js'></script>
  <script type='text/javascript' src='/DWRAnnotation/dwr/engine.js'></script>
  <script type='text/javascript' src='/DWRAnnotation/dwr/util.js'></script>

  <script type="text/javascript">
    function helloMessage()
    {
      var username=DWRUtil.getValue("username");
      DWRAnnotation.hello(username,function(data)
      {
        DWRUtil.setValue("message",data);
      });
    } 
 </script>

 

 </head>

 <body>
  UserName:
  <input type="text" id="username" name="username" value="" />
  <div id="message"></div>

  <input type="button" onclick="helloMessage()" />
 </body>
</html>

 

DWR写的聊天室：

http://blog.csdn.net/caterpillar_here/archive/2006/09/30/1311605.aspx

Dwr小应用：

http://blog.csdn.net/caterpillar_here/archive/2006/09/18/1239538.aspx