DWR推送

Ajax 2020-06-13

框架简介：DWR（Direct Web Remoting） 

是一个用于改善web页面与java类交互的远程服务器端Ajax开源框架，可以帮助开发人员开发包含AJAX技术的网站。它可以允许在浏览器里的代码使用运行在WEB服务器上的JAVA函数，就像它就在浏览器里一样。

本Demo实现的基本功能：

点击jsp界面的按钮，通过DWR调用到服务器端的java代码，在控制台打印出jsp输入框中的值

Demo构建流程：

1.新建Web工程

2.导入jar包：commons-logging-x.x.x.jar和dwr3.0.jar

3.在web.xml中加入DWR使用能力： 

<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>
 <init-param>
       <param-name>crossDomainSessionSecurity</param-name >
       <param-value>false</param-value >
  </init-param>
  <init-param>
       <param-name>allowScriptTagRemoting</param-name >
       <param-value>true</param-value >
   </init-param>
</servlet> 
<servlet-mapping>  
    <servlet-name> dwr-invoker</servlet-name>  
    <url-pattern>/dwr/*</url-pattern> </servlet-mapping>

4.在src中新建类MessagePush： 

package sugar.dwr;

public class MessagePush {

        public void send(String str){
              System. out.println(str);
       }
}

5.与web.xml同级目录下创建dwr.xml，用来配置js函数与java代码的映射关系： 

<?xml version="1.0" encoding= "UTF-8"?> 
<!DOCTYPE dwr PUBLIC "-//GetAhead Limited//DTD Direct Web Remoting 3.0//EN" "http://getahead.org/dwr/dwr30.dtd" > 
<dwr>  
  <allow>  
   <create creator="new" javascript= "messagePush"> 
       <param name="class" >sugar.dwr.MessagePush</ param> 
    </create>
  </allow>  
</dwr>

6.在index.jsp中写入js逻辑（该处使用到jquery，请自行添加）： 

<%@ page language= "java" import ="java.util.*" pageEncoding="UTF-8" %>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
  <head >
    <title >DWR</ title>
    <script type= "text/javascript" src ="js/jquery-1.8.3.js"></ script> <script type= "text/javascript" src ="dwr/util.js"></ script> <script type="text/javascript" src= "dwr/engine.js"></script > <script type="text/javascript" src= "dwr/interface/messagePush.js" ></script>
  </head >
  <body >
        <table border="0" >
               <tr>
                      <td>< input id ="content" type="text" /></td>
                      <td>< input id ="send" type="button" value= "send"/></td >
               </tr>
        </table>
        <script type="text/javascript" > $( "#send").click(function(){ var content = $("#content" ).val(); messagePush.send(content); }); </script>
  </body >
</html>

说明：jsp文件中必须引入几个js,它们都是隐含存在的，不用考虑它们在哪儿。其中engine.js和util.js是固定的。另外的一个js的名称就是dwr.xml中配置的类名。

1.服务器推送技术和DWR的推送方式

传统模式的 Web 系统以客户端发出请求、服务器端响应的方式工作，服务端不能主动发送请求(消息)给客户端。

这种方式并不能满足很多现实应用的需求，譬如： 

监控系统：后台硬件热插拔、LED、温度、电压发生变化； 

    即时通信系统：其它用户登录、发送信息； 

    即时报价系统：后台数据库内容发生变化；

　　这些应用都需要服务器能实时地将更新的信息传送到客户端，而无须客户端发出请求。“服务器推”技术在现实应用中有一些解决方案，这些解决方案大致可以分为两类： 

一类需要在浏览器端安装插件，基于套接口（Socket）传送信息，或是使用 RMI、CORBA 进行远程调用；而另一类则无须浏览器安装任何插件、基于 HTTP 长连接。

　　而基于客户端套接口的“服务器推”技术大体可以分为:

　　　　1.传统轮询：在 Web 早期，这一点常使用 Meta 刷新实现。这将自动指示浏览器在指定秒数之后重新装载页面，从而支持简陋的轮询（ polling ）。例如在 HTML 文件中加入 ，实际上就是 HTTP 头标告知浏览器每 12 秒更新一次文档。

　　　　　　　　　 优点：不需要服务器端配置

　　　　　　　　　 缺点：用户体验度差

　　　　　　　　　　　　 对服务器的压力很大，带宽流失严重

　　　　2.ajax轮询：Ajax 隔一段时间（通常使用 JavaScript 的 setTimeout 函数）就去服务器查询是否有改变，从而进行增量式的更新。但是间隔多长时间去查询成了问题，因为性能和即时性造成了严重的反比关系。间隔太短，连续不断的请求会冲垮服务器，间隔太长，务器上的新数据就需要越多的时间才能到达客户机。

　　　　　　　　　 优点：不需要太多的服务器端配置

　　　　　　　　　 　　 降低了带宽的负荷（因为返回的不是完整的页面）

　　　　　　　　　 缺点：对服务器的压力并没有减少

　　　　　　　　　　　　 实时性差，有一定的延迟

　　　　　　　　　 应用：这种技术很常见，很多webmail应用程序就是通过这种技术在电子邮件到达时显示电子邮件的。

　　　　3.comet：Comet 方式通俗的说就是一种长连接机制 (long lived http) 。同样是由 browser 端主动发起请求，但是 Server 端以一种似乎非常慢的响应方式给出回答。这样在这个期间内，服务器端可以使用同一个 connection 把要更新的数据主动发送给 browser 。因此请求可能等待较长的时间，期间没有任何数据返回，但是一旦有了新的数据，它将立即被发送到客户机。Comet 又有很多种实现方式，但是总的来说对 Server 端的负载都会有增加 . 虽然对于单位操作来说，每次只需要建议一次 connection,但是由于 connection 是保持较长时间的,对于 server 端的资源的占用要有所增加。

　　　　　　　　　 优点：实时性好（消息延时小）；性能好（能支持大量用户）　　　　　　　　　

　　　　　　　　　 缺点：长期占用连接，丧失了无状态高并发的特点。

　　　　　　　　　 应用：股票系统。实时通讯。

　　　　4.flash xml socket：这种方案实现的基础是：一、 Flash 提供了 XMLSocket 类。二、 JavaScript 和 Flash 的紧密结合：在 JavaScript 可以直接调用 Flash 程序提供的接口。

　　　　　　　　　 优点：实时性好（消息延时小）；性能好（能支持大量用户）　　　　　　　　　

　　　　　　　　　 缺点：因为 XMLSocket 没有 HTTP 隧道功能， XMLSocket 类不能自动穿过防火墙；

　　　　　　　　　　　　 因为是使用套接口，需要设置一个通信端口，防火墙、代理服务器也可能对非 HTTP 通道端口进行限制；

　　　　　　　　　 应用：网络聊天室，网络互动游戏。

　　　　5.java appet：在客户端使用 Java Applet ，通过 java.net.socket 或 java.net.DatagramSocket 或 java.net.MulticastSocket 建立与服务器端的套接口连接，从而实现 “ 服务器推送 ” 。

DWR采用的是长连接机制。

1、长连接技术通过客户端发出请求获取服务器端数据的方式通常称为”拉”技术，很形象说明客户端在拉取服务器端数据，而有时候需要服务器端主动向客户端”推”数据，比如监测聊天上线人数主动向上线发送消息，后台数据库发生变化是主动更新所有客户端展示。

2、Reverse Ajax实现服务器推技术DWR2.x的推技术也叫DWR Reverse Ajax（逆向Ajax）主要是在BS架构中，从服务器端向多个浏览器主动推数据的一种技术。DWR的逆向Ajax主要包括两种模式：主动模式和被动模式。其中主动模式包括polling和comet两种，被动模式只有piggyback这一种：

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

（2）comet方式当服务端建立和浏览器的连接，将页面内容发送到浏览器之后，对应的连接并不关闭，只是暂时挂起。如果后面有什么新的内容需要推送到客户端的时候直接通过前面挂起的连接再次传送数据。服务器所能提供的连接数目是一定的，在大量的挂起的连接没有关闭的情况下，可能造成新的连接请求不能接入，从而影响到服务质量。

（3）polling方式由浏览器定时向服务端发送ajax请求，询问后台是否有什么内容需要推送，有的话就会由服务端返回推送内容。这种方式和我们直接在页面通过定时器发送ajax请求，然后查询后台是否有变化内容的实现是类似的。

2.ScriptSession的生命周期

客户端每次请求（刷新）都会生成一个新的ScriptSession，当客户端请求时或者客户端退出时将会销毁ScriptSession。

通过ScriptSession我们可以得到客户端（浏览器）的脚本执行权。即我们可以直接调用浏览器的js代码。

本节Demo实现的基本功能：

在上节（ DWR3.0框架入门（1） —— 实现ajax ）的代码基础上修改，实现将index.jsp输入框中的推送文本显示在其它打开的jsp页面上

3.Demo修改的流程

1.修改MessagePush中的send方法： 

package sugar.dwr;

import java.util.Collection;

import org.directwebremoting.browser;
import org.directwebremoting.ScriptBuffer;
import org.directwebremoting.ScriptSession;

public class MessagePush {

        public void send(final String content){

              Runnable run = new Runnable(){
                      private ScriptBuffer script = new ScriptBuffer();
                      public void run() {
                            //设置要调用的 js及参数
                            script.appendCall("show",content);
                            //得到所有ScriptSession
                           Collection<ScriptSession> sessions = browser.getTargetSessions();
                            //遍历每一个ScriptSession
                            for (ScriptSession scriptSession : sessions){
                                  scriptSession.addScript( script);
                           }
                     }
              };
               //执行推送
              browser. withAllSessions(run);
       }
}

2.新建receiver.jsp用来接收来自服务器的消息： 

<%@ page language= "java" import ="java.util.*" pageEncoding="UTF-8" %>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
  <head >
    <title >dwr接收</title >
        <script src="js/jquery-1.8.3.js" ></script>
        <script type="text/javascript" src= "dwr/util.js"></script > <script type="text/javascript" src= "dwr/engine.js"></script > <script type="text/javascript" src= "dwr/interface/messagePush.js" ></script>
  </head >

  <body >
        dwr接收<br />
        <div id="content" style=" width: 200px ;height: 30px;border : 1px solid ; text-align: center ; padding: 5px;"></ div>
        <script type="text/javascript" > //这个方法用来启动该页面的ReverseAjax功能 dwr.engine.setActiveReverseAjax( true); //设置在页面关闭时，通知服务端销毁会话 dwr.engine.setNotifyServerOnPageUnload( true); //这个函数是提供给后台推送的时候 调用的 function show(content){ $( "#content" ).text(content); } </script>
  </body >
</html>

1.ScriptSession使用中存在的问题 

在上一节实现了服务器的推送功能，但是根据 ScriptSession的生命周期我们可以得出以下几点的问题：

（1）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）向所有的页面访问者推送
当我们想向所有的页面访问者推送的时候，我们只需要，取得所有的页面访问者，就可以“推”了。
如何取得所有的页面访问者？

DWR3.0可以通过

//得到所有ScriptSession
Collection sessions = browser.getTargetSessions();

DWR2.x可以通过

Collection pages = webContext.getScriptSessionsByPage(“/yourPage.jsp”);

通过此方法，就可以实现调用客户端的javascript函数，实现对客户端的操作。

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

2.如何管理有效的ScriptSession 

由于上面的问题，我们就需要自己管理ScriptSession。其实，有效地HttpSession,就是那个和当前的HttpSession匹配的ScriptSession。

所以，我们就可以自己维护一个Map,在这个Map里面，我们定义key就是HttpSession的Id,其值就是ScriptSession对象。

在每一次页面载入的时候，都去注册此ScriptSession,那么就会把新的ScriptSession绑定到httpSession上面了。

在DWR3.0中推出了 ScriptSessionListener用来监听ScriptSession的创建及销毁事件。我们可以使用该监听器来维护我们自己的Map。

在上一节的代码上修改Demo：

1.新建一个类实现 ScriptSessionListener接口

package sugar.dwr;

import java.util.Collection;
import java.util.HashMap;
import java.util.Map;

import javax.servlet.http.HttpSession;

import org.directwebremoting.ScriptSession;
import org.directwebremoting.WebContext;
import org.directwebremoting.WebContextFactory;
import org.directwebremoting.event.ScriptSessionEvent;
import org.directwebremoting.event.ScriptSessionListener;

public class DWRScriptSessionListener implements ScriptSessionListener {

     //维护一个Map key为session的Id， value为ScriptSession对象
     public static final Map<String,ScriptSession> scriptSessionMap = new HashMap<String,ScriptSession>();

     /** * ScriptSession创建事件 */
     public void sessionCreated(ScriptSessionEvent event) {
           WebContext webContext = WebContextFactory. get();
           HttpSession session = webContext.getSession();
           ScriptSession scriptSession = event.getSession();
            scriptSessionMap.put(session.getId(),scriptSession);     //添加scriptSession
           System. out.println( "session: " + session.getId() + " scriptSession: " + scriptSession.getId() + "is created!");
     }

     /** * ScriptSession销毁事件 */
     public void sessionDestroyed(ScriptSessionEvent event) {
           WebContext webContext = WebContextFactory. get();
           HttpSession session = webContext.getSession();
           ScriptSession scriptSession = scriptSessionMap.remove(session.getId());  //移除scriptSession
           System. out.println( "session: " + session.getId() + " scriptSession: " + scriptSession.getId() + "is destroyed!");
     }

     /** * 获取所有ScriptSession */
     public static Collection<ScriptSession> getScriptSessions(){
            return scriptSessionMap.values();
     }
}

2.新建一个类继承 DefaultScriptSessionManager，用来绑定 DWRScriptSessionListener 

package sugar.dwr;

import org.directwebremoting.impl.DefaultScriptSessionManager;

public class DWRScriptSessionManager extends DefaultScriptSessionManager {
     public DWRScriptSessionManager(){
            //绑定一个ScriptSession增加销毁事件的监听器
            this.addScriptSessionListener( new DWRScriptSessionListener());
           System. out.println( "bind DWRScriptSessionListener");
     }
}

3.在web.xml中将 DWRScriptSessionManager 配置在 dwr-invoker servlet中 

<init-param>
      <param-name >org.directwebremoting.extend.ScriptSessionManager </param-name>
      <param-value >sugar.dwr.DWRScriptSessionManager </param-value>
</init-param>

4.通过以下方法获取所有的 ScriptSession 

//得到所有ScriptSession Collection<ScriptSession> sessions = DWRScriptSessionListener.getScriptSessions();

3.使用 ScriptSessionFilter过滤 

如果我们不想要给所有的客户端 推送消息，只想给特定的客户端推送，那么我们可以使用 ScriptSessionFilter来实现。在filter中去判定session中的Attribute值是不是我们给定的。

1.使用以下方法推送消息 

//执行推送
browser.withAllSessionsFiltered(filter,run);    //注意这里调用了有filter功能的方法

2.通过参数可知我们需要一个 ScriptSessionFilter对象，此时send的方法改写成如下： 

public void send(final String content){

            //过滤器
           ScriptSessionFilter filter = new ScriptSessionFilter() {

                 public boolean match(ScriptSession scriptSession) {
                     String tag = (String)scriptSession.getAttribute("tag" );
                     System. out.println(tag);
                      return "receiverTag" .equals(tag);
                }
           };

           Runnable run = new Runnable(){
                 private ScriptBuffer script = new ScriptBuffer();
                 public void run() {
                      //设置要调用的 js及参数
                      script.appendCall( "show",content);
                      //得到所有ScriptSession
                     Collection<ScriptSession> sessions = DWRScriptSessionListener.getScriptSessions();
                      //遍历每一个ScriptSession
                      for (ScriptSession scriptSession : sessions){
                           scriptSession.addScript( script);
                     }
                }
           };
            //执行推送
           browser. withAllSessionsFiltered(filter,run);    //注意这里调用了有filter功能的方法

3.在打开jsp页面时需要在 ScriptSession 中注入设定的attribute，MessagePush中的方法 

public void onPageLoad(final String tag){
        //获取当前的ScriptSession
        ScriptSession scriptSession = WebContextFactory.get().getScriptSession();
        scriptSession.setAttribute( "tag",tag);
        System. out.println( "setAttribute");
}

4.在jsp中调用该方法

<script type= "text/javascript"> //这个方法用来启动该页面的ReverseAjax功能 dwr.engine.setActiveReverseAjax( true); //设置在页面关闭时，通知服务端销毁会话 dwr.engine.setNotifyServerOnPageUnload( true); var tag = "receiverTag"; //自定义一个标签 messagePush.onPageLoad(tag); //这个函数是提供给后台推送的时候 调用的 function show(content){ $( "#content").text(content); } </script >

这样我们可以给不同客户端的jsp中导入不同的tag值，过滤推送的客户端

相关文章

ajax 上传文件项目下载
IE6是一个非常老旧的网页浏览器，虽然现在很少人再使用它，但...
ajax .post()
PHP中的count()函数是用来计算数组或容器中元素的个数。这个...
ajax 不返回值 写法
使用 AJAX（Asynchronous JavaScript and XML）技术可以在不...
ajax 下载文件 blob
Ajax（Asynchronous JavaScript and XML）是一种用于改进网页...
ajax 下载excel文件流
本文将介绍如何通过AJAX下载Excel文件流。通过AJAX，我们可以...
ajax .get .post
Ajax是一种用于客户端和服务器之间的异步通信技术。通过Ajax...