DWR3.0框架入门（3） —— ScriptSession的维护及优化

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<ScriptSession> 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 >

这样在服务器启动时即会绑定 ScriptSessionListener， ScriptSession在创建时会自动添加到我们维护的Map中

 

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值，过滤推送的客户端