3.基于DWR推送技术Demo

前面 我装载了两篇文章，第一篇 是对服务器推送技术的大体认识

            http://blog.csdn.net/ouyhong123/article/details/39395407

        第二篇：另一种推送技术

           http://blog.csdn.net/ouyhong123/article/details/39395651

 

有了这么推送技术的认识，那么 我们再来认识下DWR的推送技术

         DWR是一个开放源码的使用Apache许可协议的解决方案，它包含服务器端Java库、一个 DWR servlet以及 JavaScript库。虽然 DWR不是 Java平台上唯一可用的Ajax-RPC 工具包，但是它是最成熟的，而且提供了许多有用的功能。从最简单的角度来说，DWR是一个引擎，可以把服务器端Java对象的方法公开给JavaScript 代码。使用DWR 可以有效地从应用程序代码中把Ajax的全部请求 -响应循环消除掉。这意味着客户端代码再也不需要直接处理XMLHttpRequest对象或者服务器的响应。不再需要编写对象的序列化代码或者使用第三方工具才能把对象变成XML。甚至不再需要编写servlet代码把 Ajax请求调整成对 Java域对象的调用。

          DWR 从 2.0开始增加了 push 功能 , 也就是在异步传输的情况下可以从 Web-Server 端发送数据到 Browser。

 

我下面的Demo是基于DWR 3.0.对于2.0 对于推送对象的寻找和scriptSession的管理 都有不同，有时间的朋友可以去对比下版本的不同

 

        1.  我们去DWR 官网 下载3.0的jar包  地址： https://java.net/downloads/dwr/DWR_3.x/3.0_RC2/dwr.jar        

            不知道，使用DWR推送技术的朋友对DWR的认识和配置有多少的了解，对于DWR的认识我就不多说了，我下面尽量写的详细点，配置也弄详细点

 

   2. 在项目WEB-INF文件夹下新建一个dwr.xml文件

            dwr.xml配置文件中详解（转）：http://blog.csdn.net/xiaoxian8023/article/details/25064585

 version="1.0" encoding="UTF-8"?>  


   
        
         
          	
           
   

      对于上面的代码，javascript="messagePush" ，messagePush 这个可以理解成别名，到时候页面中引用

                                  param 中的value对应的代码文件 是自己定义的java类

       3.配置Web.xml文件

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

 
  
	    
	      dwr-invoke  
	      uk.ltd.getahead.dwr.DWRServlet  
	       
	         debug  
	         true   
	       
	       
	      
	     
	      
	      
	       
	         activeReverseAjaxEnabled  
	         true  
	     
	       
           initApplicationScopeCreatorsAtStartup  
           true  
         
	      
	      
	       
	        
	      2
	    
	  
	    
	     dwr-invoke  
	     /dwr/*  
	    
  

           好了..大部分的工作我们都已经处理完了，我们改实现页面和后台代码了..

       4.页面引用

               4.1 首先页面引用3个js

             engine.js 文件 是dwr的引擎文件，如果你原来就熟悉dwr的反向ajax就应该理解作用是干嘛的，如果你第一次接触dwr也没关系， 我简单的和你说下，当你的项目启动起来，你访问http://你本地ip: 端口/项目名/dwr/engine.js   你就能看到 你在dwr.xml文件中配置的方法

            util.js 是dwr自带的工具js, 具体的我也没使用过，可以搜索下

            关键的来了..你的MessagePush.js  就是你在dwr.xml文件中配置的javaScript:的别名，前面的dwr/interface 这个路径是固定的

             还哆嗦下，第一次接触dwr的朋友，不要担心engine.js 和util.js  和自定义的js 该去哪找？  这个你不要担心，不需要找，你引用的dwr.jar启动后  就会有..那么具体怎么做到的，我猜想应该是生成一个js到部署的服务器环境中...

            4.2  在body页面的onload事件中加载几个javascript方法   

           我来解释下 onload自动加载的javascript方法的作用

             dwr.engine.setActiveReverseAjax(true);      启动该页面的ReverseAjax功能

             dwr.engine.setNotifyServerOnPageUnload(true,true);    这个就是当页面加载时，后台listen监听器去除失效的scriptSession，再创建新的scriptSession

             onPageLoad();    自定义的javascript函数，下面说明

             dwr.engine.setErrorHandler(function(){});"   这个方法 防止项目已经关闭，客户页面还未关闭，页面会谈Error的问题

           4.3  书写自己的页面调用后台方法

               MessagePush.pageLoad();

              MessagePush 是dwr.xml文件中定义的别名， pageLoad是我们在自定义后台java代码中自定义的java方法

             关于参数：可以传多个，还有 就是关于中文的问题， 大家不要转码、编码了，参数通过dwr方式传入后台是不会乱码的
 

       5.对应的推送java代码

              重点来了....

                    推送消息的后台代码

             5.1  scriptsession的管理

                    这里Dwr2.0与Dwr3.0 的是有区别的，Dwr3.0的 ScriptSession 都通过ScriptSessionListener来监听

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

import javax.servlet.ServletException;

import org.directwebremoting.Browser;
import org.directwebremoting.Container;
import org.directwebremoting.ScriptSession;
import org.directwebremoting.ServerContextFactory;
import org.directwebremoting.event.ScriptSessionEvent;
import org.directwebremoting.event.ScriptSessionListener;
import org.directwebremoting.extend.ScriptSessionManager;
import org.directwebremoting.servlet.DwrServlet;

public class ConnectManagerCenter extends DwrServlet {

	private static final long serialVersionUID = -7504612622407420071L;

	// 维护一个Map key为session的Id， value为ScriptSession对象（供管理scriptSession使用）
	public static final Map scriptSessionMap = new HashMap();

	public void init() throws ServletException {

		Container container = ServerContextFactory.get().getContainer();

		ScriptSessionManager manager = container
				.getBean(ScriptSessionManager.class);

		ScriptSessionListener listener = new ScriptSessionListener() {

			/**
			 * 添加客户端session
			 * 
			 * 			 * 
			 */
			@Override
			public void sessionCreated(ScriptSessionEvent ev) {

				ScriptSession scriptSession = ev.getSession();

				scriptSessionMap.put(scriptSession.getId(), scriptSession);

				System.out
						.println("a ScriptSession iscreated \n \t scriptSessionId = "
								+ scriptSession.getId());
			}

			/**
			 * 由页面关闭，或时间超时引起的 连接关闭
			 */
			@Override
			public void sessionDestroyed(ScriptSessionEvent ev) {

				ScriptSession scriptSession = ev.getSession();

				scriptSessionMap.remove(scriptSession.getId()); // 移除scriptSession
				System.out
						.println("a ScriptSession is distroyed \n \t scriptSessionId = "
								+ scriptSession.getId());

			}

		};

		manager.addScriptSessionListener(listener);

	}

                     这里，我有两点 需要说明：

                            1. 第一次页面加载 是不会进入sessionCreated这个内部类的，第二次刷新才会触发

                            2. 关于sessionDestroyed的调用， 页面关闭后会自动调用， 但是 火狐浏览器好像有点迟缓.. 最重要的问题是，每次destroy ScriptSession的时候，这个放好会调用无数次（就是当前活跃的ScriptSession的个数次） ，我不知道这是为什么，官网的资料太少...所以 如果需要在创建和卸载时处理业务，请提前处理...

                                                        

             5.2  消息的推送集中处理类

     

public class ReverseMsgCenter {

	// ScriptSession链接处理类
	private static ConnectManagerCenter connectManagerCenter = new ConnectManagerCenter();

	/***
	 * 咨询者 页面加载时处理函数
	 * @param request
	 */
	public void pageLoad(HttpServletRequest request) {

		ScriptSession scriptSession = connectManagerCenter
				.getScriptSessionDwrFunction();

		scriptSession.setAttribute("scriptSessionId", scriptSession.getId());
		
		try {
			connectManagerCenter.init();
		} catch (ServletException e) {
			e.printStackTrace();
		}
	}
	

	/***
	 * 推送消息
	 * 
	 * 
	 * @param scriptSessionId
	 *           根据scriptSessionId可以获得该页面对象
	 * @param javaScriptFunction
	 *            推送页面的调用方法
	 * @param request
	 * @param pushMsg
	 *            推送的语句 List
	 */
	public void pushMsgMethod(String scriptSessionId, final String javaScriptFunction,
			HttpServletRequest request, Object... pushmsg) {

		final Object[] pushMsg = pushmsg;

		/**
		 * Browser.withAllSessionsFiltered(filter,runnble)
		 * 过滤器，通过自定义规则在内存中的过滤ScriptSession
		 */
		Browser.withAllSessionsFiltered(new ScriptSessionFilter() {
			public boolean match(ScriptSession session) {
				// 自定义过滤规则
				if (session.getAttribute("scriptSessionId") == null)
					return false;
				else
					return (session.getAttribute("scriptSessionId")).equals(scriptSessionId);
			}
		}, new Runnable() {

			private ScriptBuffer script = new ScriptBuffer();

			public void run() {

				script.appendCall(javaScriptFunction, pushMsg);

				Collection sessions = Browser

				.getTargetSessions();
				for (ScriptSession scriptSession : sessions) {
					scriptSession.addScript(script);
				}
			}
		});
	}
}

            这个类中，有两个方法：

               pageLoad（） 这个是让页面调用的加载类 创建ScriptSession 对象

               pushMsgMethod（） 这个方法是重点中的重点， 这个就是推送消息的封装方法：这个方法类有

            Browser.withAllSessionsFiltered(filter, run);    //注意这里调用了有filter功能（筛选对象，如果是群发的话，这里可以不判断）的方法 ，run  寻找对应的ScriptSession对应的页面Url ，从而进一步回调方法

 

                       scriptSessionId,  这个是用来精准找到是把消息推送到页面去的标识

                       javaScriptFunction,    这个是回调页面中的javascript方法，这里是方法名称

                       request,                这个是页面的请求，和一般的request不一样噢。。具体搜索

                       Object... pushmsg      参数组，用来传输数据至页面，如果只是一个参数，那么页面就直接接受不需要把这个参数当成List对象，如果是多个参数组成的参数组，那么前台接受就是数组形式  ，取值就按照 array[0], array[1]

                 下面我举个例子 关于回调接收参数的，

  //后台推送回调function
  function connectSuccessMethodCall(msg){
	if(msg[0] == "T"){ 
				//
	}else{
				
		$('#serviceTokenId').val(msg[1]);
				
		$('#sessionNo').val(msg[2]);
				
	}	

          大体就这么多啦。。大家可以在页面的onload里面 直接调用初始化的方法，得到当前的ScriptSessionId ,在调用pushMsgMethod这个方法...