dwr后台推送技术.docx

dwr 后台推送技术
实例分为两个页面
sendMsg.jsp页面 ，发送一段消息给后台 ，然后后台将消息推送到showMsg.jsp页面
web.xml配置
[html] view plaincopyprint?
1. <?xml version="1.0" encoding="UTF-8"?>
2. <web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns=" xmlns:web=" xsi:schemaLocation=" id="WebApp_ID" version="2.5">
3. <display-name>dwr3</display-name>
4. <welcome-file-list>
5. <welcome-file>index.jsp</welcome-file>
6. </welcome-file-list>
7. <servlet>
8. <servlet-name>dwr-invoker</servlet-name>
9. <servlet-class>uk.ltd.getahead.dwr.DWRServlet</servlet-class>
10. <init-param>
11. <param-name>debug</param-name>
12. <param-value>true</param-value>
13. </init-param>
14. <!-- 使用polling和comet的方式 -->
15. <init-param>
16. <param-name>pollAndCometEnabled</param-name>
17. <param-value>true</param-value>
18. </init-param>
19. <load-on-startup>1</load-on-startup>
20. </servlet>
21. <servlet-mapping>
22. <servlet-name>dwr-invoker</servlet-name>
23. <url-pattern>/dwr/*</url-pattern>
24. </servlet-mapping>
25. </web-app>
<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns=" xmlns:web=" xsi:schemaLocation=" id="WebApp_ID" version="2.5">
<display-name>dwr3</display-name>
<welcome-file-list>
<welcome-file>index.jsp</welcome-file>
</welcome-file-list>
<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>
<!-- 使用polling和comet的方式 -->
<init-param>
<param-name>pollAndCometEnabled</param-name>
<param-value>true</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>
</web-app>

sendMsg.java 推送类
[java] view plaincopyprint?
1. package com.zf.dwr;
2.
3. import java.util.Collection;
4.
5. import org.directwebremoting.ScriptBuffer;
6. import org.directwebremoting.ScriptSession;
7. import org.directwebremoting.WebContext;
8. import org.directwebremoting.WebContextFactory;
9. import org.directwebremoting.proxy.dwr.Util;
10.
11. public class SendMsg {
12.
13. @SuppressWarnings("deprecation")
14. public void sendMsg(String msg){
15. //得到上下文
16. WebContext contex = WebContextFactory.get();
17.
18. //得到要推送到 的页面 dwr3为项目名称 ， 一定要加上。
19. Collection<ScriptSession> sessions = contex.getScriptSessionsByPage("/dwr3/showMsg.jsp");
20.
21. //不知道该怎么解释这个 ，
22. Util util = new Util(sessions);
23.
24. //下面是创建一个javascript脚本 ， 相当于在页面脚本中添加了一句 show(msg);
25. ScriptBuffer sb = new ScriptBuffer();
26. sb.appendScript("show(");
27. sb.appendData(msg);
28. sb.appendScript(")");
29.
30. //推送
31. util.addScript(sb);
32. }
33. }
package com.zf.dwr;

import java.util.Collection;

import org.directwebremoting.ScriptBuffer;
import org.directwebremoting.ScriptSession;
import org.directwebremoting.WebContext;
import org.directwebremoting.WebContextFactory;
import org.directwebremoting.proxy.dwr.Util;

public class SendMsg {

@SuppressWarnings("deprecation")
public void sendMsg(String msg){
//得到上下文
WebContext contex = WebContextFactory.get();

//得到要推送到 的页面 dwr3为项目名称 ， 一定要加上。
Collection<ScriptSession> sessions = contex.getScriptSessionsByPage("/dwr3/showMsg.jsp");

//不知道该怎么解释这个 ，
Util util = new Util(sessions);

//下面是创建一个javascript脚本 ， 相当于在页面脚本中添加了一句 show(msg);
ScriptBuffer sb = new ScriptBuffer();
sb.appendScript("show(");
sb.appendData(msg);
sb.appendScript(")");

//推送
util.addScript(sb);
}
}

dwr.xml配置
[html] view plaincopyprint?
1. <?xml version="1.0" encoding="UTF-8"?>
2. <!DOCTYPE dwr PUBLIC
3. "-//GetAhead Limited//DTD Direct Web Remoting 3.0//EN"
4. "http://getahead.org/dwr/dwr30.dtd">
5. <dwr>
6. <allow>
7. <create creator="new" javascript="SendMsg">
8. <param name="class">com.zf.dwr.SendMsg</param>
9. </create>
10. </allow>
11. </dwr>
<?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="SendMsg">
<param name="class">com.zf.dwr.SendMsg</param>
</create>
</allow>
</dwr>

sendMsg.jsp
[html] view plaincopyprint?
1. <%@ page language="java" contentType="text/html; charset=utf-8"
2. pageEncoding="utf-8"%>
3. <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
4. <html>
5. <head>
6. <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
7. <script type="text/javascript" src="dwr/util.js"></script>
8. <script type="text/javascript" src="dwr/engine.js"></script>
9. <script type="text/javascript" src="dwr/interface/SendMsg.js"></script>
10. <script type="text/javascript" src="jquery-1.7.1.js"></script>
11. <script type="text/javascript">
12. $(function(){
13. dwr.engine.setActiveReverseAjax(true);
14. $("#but").click(function(){
15. SendMsg.sendMsg($("#msg").val());
16. });
17. });
18. </script>
19. <title>Insert title here</title>
20. </head>
21. <body>
22. <input type="text" id="msg" />
23. <input type="button" value="发送" id="but" />
24. </body>
25. </html>
<%@ page language="java" contentType="text/html; charset=utf-8"
pageEncoding="utf-8"%>
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<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/SendMsg.js"></script>
<script type="text/javascript" src="jquery-1.7.1.js"></script>
<script type="text/javascript">
$(function(){
dwr.engine.setActiveReverseAjax(true);
$("#but").click(function(){
SendMsg.sendMsg($("#msg").val());
});
});
</script>
<title>Insert title here</title>
</head>
<body>
<input type="text" id="msg" />
<input type="button" value="发送" id="but" />
</body>
</html>

showMsg.jsp
[html] view plaincopyprint?
1. <%@ page language="java" contentType="text/html; charset=utf-8"
2. pageEncoding="utf-8"%>
3. <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
4. <html>
5. <head>
6. <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
7. <script type="text/javascript" src="dwr/util.js"></script>
8. <script type="text/javascript" src="dwr/engine.js"></script>
9. <script type="text/javascript" src="jquery-1.7.1.js"></script>
10. <script type="text/javascript">
11. $(function(){
12. //这句话千万不能少 ，表示允许使用推送技术
13. dwr.engine.setActiveReverseAjax(true);
14. });
15. //这个函数是提供给后台推送的时候 调用的
16. function show(msg){
17. $("#message").text(msg);
18. }
19. </script>
20. <title>Insert title here</title>
21. </head>
22. <body>
23. <div id="message" style="width: 200px;height: 200px;border: 1px solid red ; text-align: center; padding: 5px;"></div>
24. </body>
25. </html>
<%@ page language="java" contentType="text/html; charset=utf-8"
pageEncoding="utf-8"%>
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<script type="text/javascript" src="dwr/util.js"></script>
<script type="text/javascript" src="dwr/engine.js"></script>
<script type="text/javascript" src="jquery-1.7.1.js"></script>
<script type="text/javascript">
$(function(){
//这句话千万不能少 ，表示允许使用推送技术
dwr.engine.setActiveReverseAjax(true);
});
//这个函数是提供给后台推送的时候 调用的
function show(msg){
$("#message").text(msg);
}
</script>
<title>Insert title here</title>
</head>
<body>
<div id="message" style="width: 200px;height: 200px;border: 1px solid red ; text-align: center; padding: 5px;"></div>
</body>
</html>

使用dwr推送技术时 需要有WebContext 对象，但是 WebContext 对象需要通过 WebContextFactory.get();获取 ， 而WebContextFactory.get(); 方法只有当页面请求某个java方法时，在该方法中调用WebContextFactory.get(); 才能得到值。 否则是取不到值的。
然后通过WebContext 获取指定的页面 。再向页面推送消息 。
有一个问题是当后来又新开了页面，却收不到消息 。
可以使用一个线程，去定时的更新Collection<ScriptSession> 对象

DWR推技术在开发中需要注意的ScriptSession问题

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开发实现推技术会更加方便，期待吧！！