pushlet 之消息通知

最近做完一个用户上传视频文件，在服务器完成转码的服务。根据需要设计了一个简单的消息通知系统，使用pushlet实现。如有错误，欢迎指正，非常感谢。

[资源]
官方网站：http://www.pushlets.com/ 下载到pushlet的jar包，解压后可以看到官方的例子。


在实践中参考了pushlet-2.0.4\webapps\pushlet\examples\ajax\ajax-2.html的例子

第一步

将pushlet.jar放到工程的lib目录中，将pushlet-2.0.4\webapps\pushlet\lib\js-pushlet-client.js放到网页能访问的目录，将pushlet-2.0.4\webapps\pushlet\WEB-INF\classes\pushlet.properties和pushlet-2.0.4\webapps\pushlet\WEB-INF\classes\sources.properties拷贝到工程目录的classes目录下。

第二步

使用pushlets在网页客户端中配置非常简单

在网中页面引用如下代码

<script type="text/javascript" src="../../lib/ajax-pushlet-client.js">
</script>

<script type="text/javascript">
        //可以设置debug为true，会在新标签页中打印debug信息，调试的时候非常有用。
	PL.setDebug(false);

	// Pushlet Event Callback from Server
        //回调
	function onEvent(event) {
		pr(event.toString());
	}
       
        //订阅topic
	function joinListen() {
		pr('joinListen...');
		PL.joinListen('/pushlet/ping');
	}
        //取消订阅
	function leave() {
		pr('leaving...');
		PL.leave();
	}

	// 打印信息
	function pr(aString) {
		document.disp.event.value = aString;
	}

	//-->
	</script>

第三步

在工程的web.xml中添加配置如下

<!-- Define the pushlet servlet -->
	<servlet>
		<servlet-name>pushlet</servlet-name>
		<servlet-class>nl.justobjects.pushlet.servlet.Pushlet</servlet-class>
		<load-on-startup>1</load-on-startup>
	</servlet>

	<!-- Define the Servlet Mappings. -->

	<!-- The pushlet -->
	<servlet-mapping>
		<servlet-name>pushlet</servlet-name>
		<url-pattern>/js/pushlet.srv</url-pattern>
	</servlet-mapping>

其中url-pattern跟前面ajax-pushlet-client.js放置的目录有关，需要根据自己的项目路径调整。

第四步
服务器端实现pushlets有两种方式，第一种使用eventpullsource，需要实现包含一个继承了EventPullSource的内部静态类，如下面代码中的EncodeJobQuery。

public class EncodeJobQuery {

	public static class EncodeJobEventPullSource extends EventPullSource {
		Logger log = Logger.getLogger(getClass());
		@Autowired
		PvmsEncodeMessageManager encodeMessageManager;
		
		@Override
		protected long getSleepTime() {
			return 5000l;
		}

		@Override
		protected Event pullEvent() {
                        //参数是subject，与js中的subject相同
			Event event = Event.createDataEvent("/pushlet/ping");
			event.setField("msg", "encoding....");
			return event;
		}
	}
}

同时要在classes/sources.properties文件中增加一个行。

source7=cn.com.people.tv.pvms.encode.EncodeJobQuery$EncodeJobEventPullSource

第二种方法是在程序中调用Dispatcher.getInstance().multicast(event)，除了multicast还有其他两种方法用来发送消息。

String subject = "/pushlet/ping"
Event event = Event.createDataEvent(subject);
		event.setField("msg", "ping.....");
PvmsEncodeMessage.MSG_MESSAGE_COUNT);
		Dispatcher.getInstance().multicast(event);

总结：
在使用的过程中遇到了若干问题

1.怎么实现根据用户来推送消息
我在实现的时候为不同的用户定义不同的topic，根据用户id来区分。看了文档介绍，说可以绑定pushlet的session，没研究明白具体怎么操作。我的实现方式缺点是，如果服务器重启或者消息发送失败导致pushlet的session关闭，那么后续的消息就没办法发送给用户。

2.发送离线消息
我把消息存在服务器，只用pushlet来发送当前的消息数量。比如在用户登录后，发送给用户一条消息告诉用户有多少条未读消息，用户可以手动标记消息为已读或者删除消息。