DWR2.0.x的推技术

DWR2.0.x的推技术也叫DWR Reverse Ajax（逆向Ajax）主要是在BS架构中，从服务器端向多个浏览器主动推数据的一种技术。



在DWR所开的线程中使用Reverse Ajax时，通过WebContextFactory.get()获取WebContext对象，进而获取脚本Session。


在DWR之外使用Reverse Ajax时，就要用到ServerContext，在Spring环境中要得到ServerContext，就需要用到Spring的ServletContextAware接口。



一、Reverse Ajax的实现有3种方式：

      DWR的逆向Ajax主要包括两种模式：主动模式和被动模式。其中主动模式包括polling和comet两种，被动模式只有piggyback这一种。



     1、piggyback方式

           这是默认的方式。

           如果后台有什么内容需要推送到前台，是要等到那个页面进行下一次ajax请求的时候，将需要推送的内容附加在该次请求之后，传回到页面。
           只有等到下次请求页面主动发起了，中间的变化内容才传递回页面。



      2、comet方式

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

           服务器所能提供的连接数目是一定的，在大量的挂起的连接没有关闭的情况下，可能造成新的连接请求不能接入，从而影响到服务质量。



      3、polling方式

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





二、使用DWR的推技术的步骤

     1、在web.xml文件中增加以下配置信息

<servlet>
<servlet-name>dwr-invoker</servlet-name>
<servlet-class>uk.ltd.getahead.dwr.DWRServlet</servlet-class>
<init-param>
  <param-name>debug</param-name>
  <param-value>true</param-value>
</init-param>

<!-- DWR默认采用piggyback方式 -->

<!-- 使用polling和comet的方式 -->
<init-param>
  <param-name>pollAndCometEnabled</param-name>
  <param-value>true</param-value>
</init-param>

<!-- comet方式 -->
<!--
<init-param>
  <param-name>activeReverseAjaxEnabled</param-name>
  <param-value>true</param-value>
</init-param>
  -->
 
<!-- polling方式：在comet方式的基础之上，再配置以下参数 -->
<!--
<init-param>
  <param-name>org.directwebremoting.extend.ServerLoadMonitor</param-name>
  <param-value>org.directwebremoting.impl.PollingServerLoadMonitor</param-value>
</init-param>
  -->
  
<!-- 毫秒数。页面默认的请求间隔时间是5秒 -->
<!--
<init-param>
  <param-name>disconnectedTime</param-name>
  <param-value>60000</param-value>
</init-param>
  -->
 
<load-on-startup>1</load-on-startup>     
</servlet>

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

    2、在dwr.xml中增加以下配置信息

<create creator="new" javascript="DWRHelper">
<param name="class" value="com.cjm.web.dwr.DWRHelper"/>
<include method="addMessage"/>
<include method="test"/>
</create>

<convert converter="bean" match="com.cjm.web.dwr.Message">
<param name="include" value="id,text"/>
</convert>

    3、pojo类Message的源码

public class Message {
private long id = System.currentTimeMillis();
private String text;

public Message(){
 
}

public Message(String newText){
  text = newText;
}

public long getId() {
  return id;
}
public void setId(long id) {
  this.id = id;
}
public String getText() {
  return text;
}
public void setText(String text) {
  this.text = text;
}
}

     4、DWRHelper类源码

public class DWRHelper {
private static LinkedList<Message> messages = new LinkedList<Message>();
private static ReentrantLock lock = new ReentrantLock(); //JDK5锁

public void addMessage(String text){
  try{
   lock.lock();
  
   if(text!=null && text.trim().length()>0){
    messages.addFirst(new Message(text));
    if(messages.size()>10){
     messages.removeLast();
    }
   }
  }catch(Exception ex){
   ex.printStackTrace();
  }finally{
   lock.unlock();
  }
 
  //获得DWR上下文
  WebContext webContext = WebContextFactory.get();
 
  //获取当前页面URL，比如/ext3/test_tag.jsp
  String currentPage = webContext.getCurrentPage();
 
  //当前脚本sessin
  ScriptSession scriptSession = webContext.getScriptSession();
 
  //设置页面控件的值
  Util util = new Util(scriptSession);
  util.setValue("text", ""); //这里是清空页面输入框的值
 
  //设置脚本sessin的属性值
  scriptSession.setAttribute("uid", "cjm");
 
  //获取脚本session的属性值
  for(Iterator it=scriptSession.getAttributeNames();it.hasNext();){
   String attrName = (String)it.next();
   System.out.println(attrName + "=" + scriptSession.getAttribute(attrName));
  }
 
  //获取所有浏览当前页面的脚本session
  Collection<ScriptSession> sessions = webContext.getScriptSessionsByPage(currentPage);
 
  Util utilAll = new Util(sessions);
 
  //执行客户端脚本
  ScriptBuffer script = new ScriptBuffer();
  script.appendScript("clientFunction(")
    .appendData(scriptSession.getAttribute("uid"))
    .appendScript(");");
 
  for(ScriptSession session: sessions){
   session.addScript(script);
  }
 
  //更新这些脚本session的一些元素
  utilAll.removeAllOptions("messages");
  utilAll.addOptions("messages", messages, "id", "text");
}
}

    5、JSP页面源码

<%@ page language="java" pageEncoding="UTF-8"%>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
  <head>
<script type=&apos;text/javascript&apos; src=&apos;/ext3/dwr/engine.js&apos;></script>
<script type=&apos;text/javascript&apos; src=&apos;/ext3/dwr/util.js&apos;></script>
<script type=&apos;text/javascript&apos; src=&apos;/ext3/dwr/interface/DWRHelper.js&apos;></script>
  </head>
 
  <!-- 通过 dwr.engine.setActiveReverseAjax(true); 启动该页面的Reverse Ajax功能  -->
  <body onload="dwr.engine.setActiveReverseAjax(true);sendMessage();">
   <p>输入信息: <input id="text" onkeypress="dwr.util.onReturn(event, sendMessage)" />
<input type="button" value="Send" onclick="sendMessage()" /></p>

<script type="text/javascript">
     function sendMessage() {
        DWRHelper.addMessage(dwr.util.getValue("text"));
     }
</script>

<hr/>
<select id="messages"></select>
  
  </body>
</html>


















1 关于ScriptSession
ScriptSession不会与HttpSession同时创建
当我们访问一个页面的时候，如果是第一次访问，就会创建一个新的HttpSession,之后再访问的时候，就会保持当前的Session,即使是刷新，也能保持当前的HttpSession。
但是，ScriptSession不同，第一次访问，会创建一个ScriptSession,但是，如果你刷新，就会创建一个新的ScriptSession.


2 如何得到ScriptSession
在DWR中，我们可以通过WebContextFactory.get()来取得一个WebContext对象，进而通过WebContext的getScriptSession()取得ScriptSession对象。
但是要注意，在我们自定义的Servlet中，我们也可以通过WebContextFactory.get()来取得一个WebContext,但是这种方法却不能取得ScriptSession对象。因为，此WebContext对象其实不是通过DWR的上下文环境得到的，所以，就根本没有创建ScriptSession对象。
假设这种方式也能得到ScriptSession的话，那么我们实现“推”也就可以不局限在DWR的上下文环境中了，那么其灵活性就会大很多了。

所以，这就是我们不能在Servlet中实现推的原因。

3 关于刷新就创建一个新的ScriptSession问题
在我们需要推送的页面中，如果你刷新以下，那么就提交一个Http的request,此时，如果是第一次，那么就会创建一个httpSession对象，同时，请求由DwrServlet来处理后，就会创建一个ScriptSession.这个ScriptSession会和你的request请求的URI绑定放在一个由ScriptSessionManager维护的Map里面（这里面其实是一个URI对应的Set,在Set里面放置的是URI绑定的所有ScriptSession）。
当你刷新的时候，同样的一个HttpSession,却会创建一个新的ScriptSession,然后绑定到对应的URI上。

4 向所有的页面访问者推送
当我们想向所有的页面访问者推送的时候，我们只需要，取得所有的页面访问者，就可以“推”了。
如何取得所有的页面访问者？可以通过
//        Collection pages = webContext.getScriptSessionsByPage("/SynMap/map/map.jsp");
来取得/SynMap/map/map.jsp的所有访问的ScriptSession
如何推送，
Util util = new Util(pages);
util.addFunctionCall("syningMap",new Double(x),new Double(y),new Integer(zoom));
通过此方法，就可以实现调用客户端的javascript函数，实现对客户端的操作。

5 在上面的推送中产生的问题
上面的方法已经可以实现向所有的访问者推送。但是问题是，在客户端，如果用户刷新一次或多次，那么，Collection里面可能就保存了很多的无用的ScriptSession,所以不仅仅会影响性能问题，更重要的是，可能就不能实现你想要的功能。

比如，你想取得当前再现的有效用户，那么你就需要知道那些ScriptSession是有效的。

6 如何管理有效的ScriptSession

由于上面的问题，我们就需要自己管理ScriptSession.其实，有效地HttpSession,就是那个和当前的HttpSession匹配的ScriptSession.
所以，我们就可以自己维护一个Map,在这个Map里面，我们定义key就是HttpSession的Id,其值就是ScriptSession对象。
在每一次页面载入的时候，都去注册此ScriptSession,那么就会把新的ScriptSession绑定到httpSession上面了。
// session and scriptSession map
Map sm = g.getSessions();
// hs is HttpSession
// ss is ScriptSession object
sm.put(hs.getId(), ss);

7 如何实现有效推送
通过上面的Map取得所有的有效ScriptSession集合
Collection pages = g.getSessions().values();
然后再推送，就可以了。

8 上面问题的新的解决方案
上面的技术问题和解决方案都是在DWR2.0的环境下遇到的。
昨天看了一下，即将正式发布的DWR3.0的文档，里面对AJAX Reverse技术增加了不少功能。
其中新加了一个象HttpSessionListener的东西，叫ScriptSessionListener
所以，我想，可以通过这个Listener实现上面的功能，也就是说，在监听到一个ScriptSession创建的时候，我们就直接判断，并把此ScriptSession绑定到httpSession上，就可以了。同样用上面的那个map来管理就可以了。
这个是我的思路，我还没有实践，如果你需要的话，可以自己去试一下。
新版本的DWR开发实现推技术会更加方便，期待吧！！