pub-sub是public-subscribe两个单词的缩写,其意思就是发布--订阅,它提供了一种事件处理函数的注册方式。Struts2的pub-sub事件模型基本是采用了Dojo的pub-sub事件模型。
pub-sub事件模型提供了一种简化的事件监听方式,通过pub-sub事件模型,可以让一个JavaScript事件同时触发多个事件处理函数。当我们把一个事件(也可能是一个普通的函数)作为一个发布者注册到一个主题后,如果该事件被触发(普通函数被调用),则该主题下所有的事件处理函数都会被自动调用。
在Dojo中将一个事件注册到某个主题下的代码如下:
//将foo对象的bar方法注册到/refresh主题,事件主题是一个任意的字符串,并没有太多额外的要求
dojo.event.topic.publish("/refresh","foo","bar");
将某个事件处理函数注册到某个主题下的代码如下:
//在/refresh主题下增加了一个匿名事件处理函数
dojo.event.topic.subscribe("/refresh",function(param1,param2){
//this function will be called everytime when "/refresh" is published
});
Struts2在Dojo的pub-sub事件模型基础上,进行了简单的包装,它为大部分Ajax标签提供了如下两个属性:
listenTopics:指定系列事件主题名,多个主题之间以英文逗号(,)隔开。配置该元素的HTML元素将用于加载服务器响应。
notifyTopics:指定系列事件主题名,多个主题之间以英文逗号(,)隔开。配置该元素的HTML元素将会把事件发布到指定主题,发布主题时会传递3个参数:data, type, request。这3个参数代表了与服务器交互的内容,含义如下:
data:从服务器返回的数据。
type:与服务器交互的状态,只有3个值:before(交互之前) load(加载数据中) error(服务器响应出错)
request:代表请求对象本身。
因此,Struts2中的事件处理函数大致上都是如下形式的:
function(data, type, e) { ... ... }
4.1 pub-sub的例子
下面的代码中使用了一个按钮来发布事件,将事件发布到指定主题,并且通过JavaScript代码来为该主题增加一个事件处理函数。页面代码如下:
<%@ page contentType="text/html;charset=GBK" language="java" %>
<%@ taglib prefix="s" uri="/struts-tags" %>
<html>
<head>
<title>pub-sub模型</title>
<s:head theme="ajax"/>
</head>
<script type="text/javascript">
//为lee主题增加一个事件处理函数
dojo.event.topic.subscribe("/lee", function(data, type, e){
alert('正处于Dojo的异步交互过程中,类型是:'+type);
alert(e);
});
</script>
<body>
简单pub-sub模型<br>
<!-- notifyTopics属性设置该元素引发的事件发布到的主题 -->
<s:submit type="submit" theme="ajax" value="提交" align="left" notifyTopics="/lee"/>
</body>
</html>
在上面代码中,定义"提交"按钮时,指定了notifyTopics="/lee"属性,该属性指定单击该按钮时,单击事件将被发布到/lee主题。
上面的代码是直接指定了事件处理函数作为/lee主题的订阅者,除此之外,我们也可以指定一个Struts2标签元素作为主题的订阅者,指定订阅者通过为Struts2标签listenTopics属性实现。如下面的JSP页面代码:
<%@ page contentType="text/html;charset=GBK" language="java" %>
<%@ taglib prefix="s" uri="/struts-tags" %>
<html>
<head>
<title>pub-sub模型</title>
<s:head theme="ajax"/>
</head>
<body>
pub-sub模型<br>
<s:url id="data" value="/data.action"/>
<!-- notifyTopics属性设置该元素引发的事件发布到的主题 -->
<s:submit type="submit" theme="ajax" value="更新" align="left" notifyTopics="/change"/>
<!-- listenTopics属性设置该元素订阅的主题 -->
<s:div theme="ajax" id="t1" cssStyle="background-color:#bbbbbb;width:360px;height:80px" listenTopics="/change" href="${data}"/>
</body>
</html>
上面的代码让一个"更新"按钮作为事件发布者,让一个div元素作为事件订阅者,意思就是每当单击"更新"按钮时,该按钮将会把单击事件发布到/change主题,而订阅者div元素的默认行为(更新自己的内容)被触发。本例子中的action直接转发到如下JSP页面:
<%@ page contentType="text/html;charset=GBK" language="java" %>
<%@ taglib prefix="s" uri="/struts-tags" %>
<%=Math.random() > 0.5 ? "Spring2.0宝典" : "轻量级J2EE企业应用实战"%>
每次单击"更新"按钮时,将会引起页面中div元素内容的改变。
如果我们想阻止某个Ajax过程,则可以先将该Ajax标签的事件注册到某个事件主题下,再为该主题增加事件订阅者,并在该事件订阅者中取消该请求。例子如下:
<s:url id="ajaxTest" value="/AjaxTest.action" />
<!-- 将下面Ajax按钮的Ajax事件注册到/request事件主题下 -->
<s:submit type="submit" theme="ajax" value="submit" notifyTopics="/request" href="%{ajaxTest}" />
下面为/request事件主题增加订阅者
dojo.event.topic.subscribe("/request",function(data,type,request){
//取消request
request.cancel=true;
});
通过上面的代码即可强行中止Ajax请求