Pushlet实例解析

1.1 Pushlet

1.1.1 介绍

Pushlet 是一个开源的 Comet 框架，在设计上有很多值得借鉴的地方，对于开发轻量级的 Comet 应用很有参考价值。

观察者模型

Pushlet 使用了观察者模型：客户端发送请求，订阅感兴趣的事件；服务器端为每个客户端分配一个会话 ID 作为标记，事件源会把新产生的事件以多播的方式发送到订阅者的事件队列里。

客户端 JavaScript 库

pushlet 提供了基于 AJAX 的 JavaScript 库文件用于实现长轮询方式的“服务器推”；还提供了基于 iframe 的 JavaScript 库文件用于实现流方式的“服务器推”。

JavaScript 库做了很多封装工作：

l 定义客户端的通信状态：STATE_ERROR、STATE_ABORT、STATE_NULL、STATE_READY、STATE_JOINED、STATE_LISTENING；

l 保存服务器分配的会话 ID，在建立连接之后的每次请求中会附上会话 ID 表明身份；

l 提供了 join()、leave()、subscribe()、 unsubsribe()、listen() 等 API 供页面调用；

l 提供了处理响应的 JavaScript 函数接口 onData()、onEvent()…

网页可以很方便地使用这两个 JavaScript 库文件封装的 API 与服务器进行通信。

客户端与服务器端通信信息格式

pushlet 定义了一套客户与服务器通信的信息格式，使用 XML 格式。定义了客户端发送请求的类型：join、leave、subscribe、unsubscribe、listen、refresh；以及响应的事件类型：data、join_ack、listen_ack、refresh、heartbeat、error、abort、subscribe_ack、unsubscribe_ack。

服务器端事件队列管理

pushlet 在服务器端使用 Java Servlet 实现，其数据结构的设计框架仍可适用于 PHP、C 编写的后台客户端。

Pushlet 支持客户端自己选择使用流、拉（长轮询）、轮询方式。服务器端根据客户选择的方式在读取事件队列（fetchEvents）时进行不同的处理。“轮询”模式下 fetchEvents() 会马上返回。”流“和”拉“模式使用阻塞的方式读事件，如果超时，会发给客户端发送一个没有新信息收到的“heartbeat“事件，如果是“拉”模式，会把“heartbeat”与“refresh”事件一起传给客户端，通知客户端重新发出请求、建立连接。

客户服务器之间的会话管理

服务端在客户端发送 join 请求时，会为客户端分配一个会话 ID， 并传给客户端，然后客户端就通过此会话 ID 标明身份发出 subscribe 和 listen 请求。服务器端会为每个会话维护一个订阅的主题集合、事件队列。

服务器端的事件源会把新产生的事件以多播的方式发送到每个会话（即订阅者）的事件队列里。

 

对比参考：Comt4j消息推送实例 与 Servlet3.0 服务端推技术

 

1.1.2 实例

1.1.2.1 服务端

新建消息发送源。

package com.pushlet.server; import nl.justobjects.pushlet.core.Event; import nl.justobjects.pushlet.core.EventPullSource; public class HelloWorldPlushlet extends EventPullSource {  /**   * 设置消息推送的时间间隔.   */  @Override protected long getSleepTime() {  return 1000;   } /**  * 推送消息事件方法.  */  @Override protected Event pullEvent() { Event event = Event.createDataEvent("/helloworld");  event.setField("hellokey", "hello world");  return event;   }   }

在sources.properties下配置消息发送源。

1.1.2.2 客户端

<script type="text/javascript" src="ajax-pushlet-client.js"></script> <script type="text/javascript">              PL._init();              PL.joinListen('/helloworld');             function onData(event) {                  var resultArea = $('#result')[0];                 if (event.get("hellokey") != undefined) {                 resultArea.value = resultArea.value + event.get("hellokey") + '\n';                 }             }      </script>

1.1.2.3 运行效果

在浏览器打开：http://IP:8080/PushletDemo/index.jsp，运行效果如下。

从HTTP请求看出，pushlet是采用轮询的方式实现“服务端推”。

每一次轮询，pushlet把客户端监听的事件与事件源（Key）编码成“p_id”，获取服务端的响应后，通过“event.get("hellokey")”，从响应包中获取数据。