DWR的注释(annotations)使用及反向调用(Reverse Ajax)

最近也不是很忙花了点时间再仔细研究了一下DWR，其实两三年前就已经开始使用它了。不过一直用的也比较简单DWR，没花过太多的心思在上面（呵呵，主要还是项目没需求啊）。不用再多说了，相信大家都知道，配置和使用都非常简单。今天要说的是DWR的一些高级一点用法。当然也不难。只是为了防止自己忘记，同时也和其他人分享一下。 言归正传开始吧。

---

先说说注释语法，省掉dwr.xml。（自从用了java 5 之后，现在越看一堆堆的配置文件越烦，越来越喜欢注释方式来的直接简单了）

 

首先下载最新的稳定版本的dwr.jar文件放到你的工程中。（还有需要其它的吗？不需要了，dwr就是这么简单）
然后在web.xml中添加如下一段
 <!-- DWRServlet -->
 <servlet>
  <servlet-name>dwr-invoker</servlet-name>
  <servlet-class>org.directwebremoting.servlet.DwrServlet</servlet-class>
  <init-param>
<!-- 默认为false，调试用，可以访问http://地址:端口/上下文/dwr 来进行测试 -->
   <param-name>debug</param-name>
   <param-value>true</param-value>
  </init-param>
<!--这就是传说中的DWR反转调用的开关了，默认也是false -->
  <init-param>
   <param-name>activeReverseAjaxEnabled</param-name>
   <param-value>true</param-value>
  </init-param>
<!--日志级别不多说了-->
  <init-param>
   <param-name>logLevel</param-name>
   <param-value>WARN</param-value>
  </init-param>
<!--这块注意了，关键来了，把使用DWR注释的类都要加在这里，2.0的DWR好像还不支持包扫描，希望以后能提供这个功能，3.0我还没注意有没有这个功能，现在还没出正式版-->
  <init-param>
   <param-name>classes</param-name>
   <param-value>
                org.relax.service.SectionManager,
    org.relax.service..entity.Section
            </param-value>
  </init-param>
 </servlet>
<!--这块不用多说了吧，如果看不懂，哪凉快哪呆着去吧-->
 <servlet-mapping>
  <servlet-name>dwr-invoker</servlet-name>
  <url-pattern>/dwr/*</url-pattern>
 </servlet-mapping>
在这里再说明一下有的文章用的是uk.ltd.getahead.dwr.DWRServlet，其实他只是继承了一下org.directwebremoting.servlet.DwrServlet自己什么也没做，所以这两个类用哪个都行（这么做应该是为了兼容以前的版本，猜的，1.0我没用过）。
下面看具体的类吧。

@Service
@RemoteProxy(creator = SpringCreator.class, name = "sectionManager", creatorParams = @Param(name = "beanName", value = "sectionManager"))
public class SectionManager extends DefaultEntityManager<Section, Integer> {

 @Autowired
 OriginCollectDataManager originCollectDataManager;

 @RemoteMethod
 public Section get(Integer id) {
  return super.get(id);
 }

 @RemoteMethod
 public List<Section> getAll() {
  return super.getAll();
 }

}

我的测试环境里还用到了spring和hibernate，所以里面还掺杂了一些spring的注释标记，当然如果你没用也无所谓。
这里主要解释一下DWR的几个Annotations
@RemoteProxy标在类上的就是使类可以运程访问
@RemoteProxy(creator = SpringCreator.class, name = "sectionManager", creatorParams = @Param(name = "beanName", value = "sectionManager"))，
上面因为使用了spring所以写的是springCreator.class, 其它还有BeanCreator, Ejb3Creator, JsfCreator, NewCreator, NullCreator, PageFlowCreator, ScriptedCreator, SingletonCreator, SpringCreator, StrutsCreator。看自己的具体需求。最常用的就是newCreator了吧。
@RemoteMethod标在方法上，不用多说可以使方法能远程访问
@DataTransferObject标在类上，注明需要转换的VO类了
@RemoteProperty标在类的属性上，标明哪些可以访问（我试了试不标，好像全都可以访问了）
常用的就这么多了，其它几个不太常用，如果用到的时候再研究吧。
还有什么要做的吗？好像就这么多了。DWR就是简单。如果标好了可以试试访问上下文路径加上/dwr来访问试试了。好像好用了哎。如下图
点进去看看都有什么方法

看上去方法好像挺多，其实真正能访问用的只有用@RemoteMethod标注过的。
测试已经好用了下面就是加到页面了。那不就更简单了吗。按着上图收到JSP文件中。然后像调用普通javascript对象一样就可以了。咱不是做普及的，今天主要讲注释的用法。这部分就到这吧。

下面说反向调用了，这个还是挺复杂的，首先解释几个概念。

dwr的逆向ajax其实主要包括两种模式：主动模式和被动模式。其中主动模式包括Polling和Comet两种，被动模式只有Piggyback这一种。

    所谓的Piggyback指的是如果后台有什么内容需要推送到前台（即调用页面的js方法），是要等到那个页面进行下一次ajax请求的时候，将需要推送的内容附加在该次请求之后，传回到页面。

    polling指的是由浏览器定时向服务端发送ajax请求，询问后台是否有什么内容需要推送，有的话就会由服务端返回推送内容。这种方式和我们直接在页面通过定时器发送ajax请求，然后查询后台是否有变化内容的实现是类似的。只不过用了dwr之后这部分工作由框架帮我们完成了。

    comet模式指的的当服务端建立和浏览器的连接，将页面内容发送到浏览器之后，对应的连接并不关闭，只是暂时挂起。如果后面有什么新的内容需要推送到客户端的时候直接通过前面挂起的连接再次传送数据。

    通过上面的解释我们可以看到，这三种模式都有各自的优缺点。从客户端请求次数的角度来说，当然是piggyback的模式最好。这个里面完全没有额外的网络请求，只有等到下次请求页面主动发起了，中间的变化内容才传递回页面。但是这也导致了这推送内容的延时，因为你完全没办法知道页面的下一次请求将在什么时候发起，也许页面永远都没有下一次请求。polling模式的网络请求最为频繁了，因为这时候页面不管后台有没有更新的内容，都需要发送请求询问。虽然这种模式可以通过增加请求间隔的时间来减少单位时间内的请求次数，但是这样同样会导致页面响应后台内容变化的间隔时间增长，这中间就产生了矛盾，具体的请求间隔时间还是要根据具体项目的需求来配置。比如服务器能承受的请求间隔和页面内容所需要的刷新频率。comet方式的响应速度应该是最快的，后台一旦有内容需要推送可以通过前面没有关闭的连接马上推送到前台。但是服务器所能提供的连接数目是一定的，在大量的挂起的连接没有关闭的情况下，可能造成新的连接请求不能接入，从而影响到服务质量。

 

概念说清楚了，下面做一吧。
前面已经说完了注释方式了，以下还用注释的方式，方便直观呀。
 @RemoteMethod
 public synchronized  void start() {
  WebContext wctx = WebContextFactory.get();
  String currentPage = wctx.getCurrentPage();
  running=true;
  for (int i = 0; i < 1000; i++) {
   if (!running) {
    break;
   }
   ScriptBuffer script = new ScriptBuffer();
   script.appendScript("receiveMessages(").appendData(i).appendScript(");");//调用页面的javascript方法把值添到页面上。
   // Loop over all the users on the current page
   Collection pages = wctx.getScriptSessionsByPage(currentPage);//循环出所有的会话页面并执行
   for (Iterator it = pages.iterator(); it.hasNext();) {
    System.err.println(i);
    ScriptSession otherSession = (ScriptSession) it.next();
    otherSession.addScript(script);
   }
   try {
    Thread.sleep(3000);
   } catch (InterruptedException e) {
    e.printStackTrace();
   }
  }
 }
 
 @RemoteMethod
 public  void stop() {
  running=false;
 }
这是个简单的程序进行之后就是用个循环来更新页面的数字。
下面也贴一下JSP的代码吧。也算补充下第一部分了。

<%@ page language="java" contentType="text/html; charset=ISO-8859-1"
    pageEncoding="UTF-8"%>
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
  <script type='text/javascript' src='/dymc-web/dwr/interface/sectionManager.js'></script>
  <script type='text/javascript' src='/dymc-web/dwr/engine.js'></script>
<script type="text/javascript">

function receiveMessages(msg) {
 //alert(msg);
 document.getElementById("content").innerHTML=msg;
}
</script>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Insert title here</title>
</head>
<body onload="dwr.engine.setActiveReverseAjax(true)">
<button onclick="sectionManager.start()">start</button>
<button onclick="sectionManager.stop()">stop</button>
<div id="content"></div>
</body>
</html>

页面包括两个钮一个开始一个停止。大家来试试吧。这里不添图了太浪费空间
运行起来后点start按钮，看看页面上是不是自己开始变了。新打开个IE，用另外的机器访问此面，疑？怎么都有数字在变换，这就是DWR Reverse Ajax的厉害所在了。再点一下stop，呀，所有打个IE里数字都不变了吧。
注意：代码用的是主动的方式，所以注意页面onload中的<body onload="dwr.engine.setActiveReverseAjax(true)">没有这句可就不好用了。当然 web.xml中也不能少了
  <init-param>
   <param-name>activeReverseAjaxEnabled</param-name>
   <param-value>true</param-value>
  </init-param>
该说的都说了就到这吧。这篇文章不是给初学者看的。所以不是特别的完整。如果你是初学者，就先去看看基础吧。可能有点不适合你。