grails Comet插件

Cometd is a scalable HTTP-based event routing bus that uses a Ajax Push technology pattern known as Comet. The term 'Comet' was coined by Alex Russell in his post Comet: Low Latency Data for the Browser.

The Plugin setup a Cometd servlet and includes all the demo programs from the original Cometd distribution.

该插件建立了一个Cometd servlet并包含所有原来Cometd版本的例子程序。

compatibility note The cometd demo works in any version. but there is a bug that caused the Cometd Servlet to fail when any Grails controller is added to the project. Please use Grails 1.1 RC1 or later for Grails development.

compatibility note  The cometd例子在任何版本下都有效。但有一个小问题，当任何Grails controller 添加到工程时，Cometd Servlet会引起失败。请使用Grails 1.1 RC1或更新版本。

特点：

• included everything from the cometd distribution, including all libraries and demo programs.
• With two additional classes for 'bridging' Cometd and the Spring-based Grails
•  使用2个额外的类作为桥接Cometd和基于 Spring的 Grails
  • SpringCometdServlet
    • extends ContinuationCometdServlet
    • it is created to skip the init() method in AbstractCometdServlet that load the init-parameters from web.xml. This implementation loads the parameters from Spring configuration instead.
    • filters are not loaded from a json file, but is also defined in Spring configuration. (remarks: this feature is not properly tested !)
  • SpringBayeux
    • A singleton bayeux instance is the core Bayeux server component
    • SpringBayeux extends ContinuationBayeux
    • The SpringBayeux is expected to be constructed in Spring before the initialization of servlet context.
• 动态增加servlet and servleting mapping，在spring中创建一个单例的Bayeux

  Dynamically adding servlet and servleting mapping, and create a singleton Bayeux in Spring

•  
  • Servlet mapping
    • 默认的, the Cometd servlet are mapped to *.cometd, /cometd, /cometd/*, and /plugins/cometd-${version}/cometd (for running the demo programs 目的是运行 示例程序)
    • the 'cometd' namespace is configurable with 'cometd.namespace' system property
    • the 'cometd' namespace是可以配置的，位于系统属性中的'cometd.namespace'。
  • Spring
    • The Bayeux instance is named 'bayeux' in Spring's application context

用法

安装

For non-Grails users, download a Grails binary distribution and setup environmental variables according to the Grails installation procedure, then run the following commands to create your Cometd project and access the demo:

1. grails create-app ${applicationName}
2. cd ${applicationName}
3. grails install-plugin cometd
4. grails run-app
5. 访问示例位置：access the demo at http://localhost:8080/${applicationName}/plugins/cometd-${pluginVersion}/

配置

• 自0.1.2版本起，如下配置是可用的。from 0.1.2, the following configurations are available:

·                plugins {

·                  cometd {

·                    'servlet-mapping' {

·                        namespace = 'cometd'

·                    }

·                    'noCacheFilter' {

·                      disable = false; //the filter add HTTP Header for disabling HTTP cache

·                    }

·                    'cometdService' { // Cometd provides extra functions including logging and client tracking

·                      disable = false; // disable

·                    }

·                  }

·                }

• 系统属性不再支持System property is no longer supported.
• 日志logging

debug consoleAppender: 'org.grails.plugins.cometd'

发送和接收消息与cometd channels

send and receive message to/from cometd channels

• 一个名为'bayeux'的spring bean，它代表Cometd server，你将在你的应用程序中和他交互
• a Spring bean named 'bayeux' which represents the Cometd server and you will interact with it in your application
  • see see API doc of AbstractBayeux
  • In Grails artifacts, you could inject the bayeux simply by:

o                     class MyChatService{

o                       def bayeux

o                     }

• 服务端接收消息receiving message at the server side
  • see the CometdService.init() as an example
• 服务端发送消息sending messaege at the server side
  • see the docs of bayeux

版本与兼容性

• 版本 0.1.*
  • 支持 Grails 1.1 RC1 for Grails开发
  • 包含 cometd-jetty 6.1.12 / cometd-api 1.0beta4
  • 该插件使用cometd-jetty, quote from the cometd mail list:
    • "Note that the jetty cometd servlet will run on tomcat. It just wont use the async features of tomcat, but it will still handle many hundreds of simultaneous users (good for many apps)."

链接

• Cometd官网
• 其他相关项目
  • Kaazing宣传要提供一个交换的CometD claims to provide an alternative to CometD http://www.kaazing.org/

作者: Mingfai Ma (mingfai.ma (at-no-spam) gmail.com)

Close

 

 

 

近日弄个例子上来

 

 

 

评论

3 楼 shiren1118 2009-03-09  

以下转的自己搜集的资料


基于 WEB 的实时事件通知方式大致有五种方案：HTTP拉取方式(pull)，HTTP流，Long Polling，Flash XMLSocket方式，Java Applet。

首先说下Comet这个词，Comet 这个词是最早由Alex Russell（Dojo Toolkit 的项目 Lead）提出的，称基于 HTTP 长连接、无须在浏览器端安装插件的“服务器推(Push)”技术为“Comet”。
1.HTTP拉取方式(pull)
在这种传统的方法中，客户端以用户可定义的时间间隔去检查服务器上的最新数据。这种拉取方式的频率要足够高才能保证很高的数据精确度，但高频率可能会导致多余的检查，从而导致较高的网络流量。而另一方面，低频率则会导致错过更新的数据。理想地，拉取的时间间隔应该等于服务器状态改变的速度。常见的实现如利用 "<meta http-equiv="refresh" content="5" />" tag，当然利用xmlHttpRequest定时取也是一种方法。

2.HTTP流(Push机制)
HTTP流有两种形式：
* Page Stream: 页面上不间断的HTTP连接响应(HTTP 1.1 Keep Alive).
   通过在 HTML 页面里嵌入一个隐蔵帧（iframe），然后将这个隐蔵帧的 SRC 属性设为对一个长连接的请求，服务器端就能源源不断地往客户端输入数据。
* Service Stream: XMLHttpRequest连接中的服务器数据流。
   客户端是在 XMLHttpRequest 的 readystate 为 4（即数据传输结束）时调用回调函数，进行信息处理。当 readystate 为 4 时，数据传输结束，连接已经关闭。Mozilla Firefox 提供了对 Streaming AJAX 的支持，即 readystate 为 3 时（数据仍在传输中），客户端可以读取数据，从而无须关闭连接，就能读取处理服务器端返回的信息。IE 在 readystate 为 3 时，不能读取服务器返回的数据，目前 IE 不支持基于 Streaming AJAX。

注：使用 Page Stream(iframe) 请求一个长连接有一个很明显的不足之处：IE、Morzilla Firefox 下端的进度栏都会显示加载没有完成，而且 IE 上方的图标会不停的转动，表示加载正在进行。Google 的天才们使用一个称为“htmlfile”的 ActiveX 解决了在 IE 中的加载显示问题，并将这种方法用到了 gmail+gtalk 产品中。Alex Russell 在 “What else is burried down in the depth's of Google's amazing JavaScript?”文章中介绍了这种方法。Zeitoun 网站提供的 comet-iframe.tar.gz，封装了一个基于 iframe 和 htmlfile 的 JavaScript comet 对象，支持 IE、Mozilla Firefox 浏览器，可以作为参考。（http://alex.dojotoolkit.org/?p=538）

3.长时间轮询(Long Polling)
也就是所谓的异步轮询(Asynchronous Polling)，这种方式是纯服务器端推送方式和客户端拉取方式的混合。它是基于BAYEUX协议(http://svn.xantus.org/shortbus/trunk/bayeux/bayeux.html)的。这个协议遵循基于主题的发布——订阅机制。在订阅了某个频道后，客户端和服务器间的连接会保持打开状态，并保持一段事先定义好的时间（默认为45秒）。如果服务器端没有事件发生，而发生了超时，服务器端就会请求客户端进行异步重新连接。如果有事件发生，服务器端会发送数据到客户端，然后客户端重新连接。
   1.  服务器端会阻塞请求直到有数据传递或超时才返回。
   2. 客户端 JavaScript 响应处理函数会在处理完服务器返回的信息后，再次发出请求，重新建立连接。
   3. 当客户端处理接收的数据、重新建立连接时，服务器端可能有新的数据到达；这些信息会被服务器端保存直到客户端重新建立连接，客户端会一次把当前服务器端所有的信息取回。


4.Flash XMLSocket(push机制)

这种方案实现的基础是：
   1. 安装了 Flash 播放器，Flash 提供了 XMLSocket 类(Flash 7.0.14以上版本)。
   2. JavaScript 和 Flash 的紧密结合：在 JavaScript 可以直接调用 Flash 程序提供的接口。

具体实现方法：在 HTML 页面中内嵌入一个使用了 XMLSocket 类的 Flash 程序。JavaScript 通过调用此 Flash 程序提供的套接口接口与服务器端的套接口进行通信。JavaScript 在收到服务器端以 XML 格式传送的信息后可以很容易地控制 HTML 页面的内容显示。

关于如何去构建 JavaScript 与 Flash XMLSocket 的 Flash 程序，以及如何在 JavaScript 里调用 Flash 提供的接口，我们可以参考 AFLAX（Asynchronous Flash and XML）项目提供的 Socket Demo 以及 SocketJS（请参见 [http://www.aflax.org/ Asynchronous Flash and XML，提供了强大的 Flash、Javascript 库和很多范例。]）。

Javascript 与 Flash 的紧密结合，极大增强了客户端的处理能力。从 Flash 播放器 V7.0.19 开始，已经取消了 XMLSocket 的端口必须大于 1023 的限制。Linux 平台也支持 Flash XMLSocket 方案。但此方案的缺点在于：
   1. 客户端必须安装 Flash 播放器；
   2. 因为 XMLSocket 没有 HTTP 隧道功能，XMLSocket 类不能自动穿过防火墙；
   3. 因为是使用Socket接口，需要设置一个通信端口，防火墙、代理服务器也可能对非 HTTP 通道端口进行限制；
   4. 必须使用XML格式作为消息格式，数据冗余增大。

此方案在一些网络聊天室，网络互动游戏中得到广泛使用。

5. Java Applet(Push机制)
类似于Flash XMLSocket方式。目前已经很少使用，原因极可能是因在手机等移动终端缺少支持。
总结和建议：

如果我们想要高数据一致性和高网络性能，我们就应该选择推送方式。但是，推送会带来一些扩展性问题；服务器应用程序CPU使用率是拉取方式的7倍。根据TUD（http://swerl.tudelft.nl/twiki/pub/Main/TechnicalReports/TUD-SERG-2007-016.pdf）的测试结果，服务器性能会在350-500个用户时趋于饱和。对于更大数量的用户，服务器端需要维护大量并发的长连接。在这种应用背景下，服务器端需要考虑负载均衡和集群技术；或是在服务器端为长连接作一些改进。
使用拉取方式，要想达到完整的数据一致性以及很高的网络性能是很困难的。如果拉取的时间间隔大于数据更新的时间间隔，就会发生一些数据的遗失。而如果小于数据更新的时间间隔，网络性能就会受到影响。拉取方式只有在拉取时间间隔等同于数据更新时间间隔时，才会恰到好处。但是，为了达到那样的目标，我们就需要提前知道准确的数据更新时间间隔。然而，数据更新的时间间隔很少是静态不变并可以预知的。这使得拉取方式只有在数据是根据某种特定模式发布的情况才有用。
控制信息与数据信息使用不同的 HTTP 连接

使用长连接时，存在一个很常见的场景：客户端网页需要关闭，而服务器端还处在读取数据的堵塞状态，客户端需要及时通知服务器端关闭数据连接。服务器在收到关闭请求后首先要从读取数据的阻塞状态唤醒，然后释放为这个客户端分配的资源，再关闭连接。所以在设计上，我们需要使客户端的控制请求和数据请求使用不同的 HTTP 连接，才能使控制请求不会被阻塞。

在实现上，如果是基于 iframe 流方式的长连接，客户端页面需要使用两个 iframe，一个是控制帧，用于往服务器端发送控制请求，控制请求能很快收到响应，不会被堵塞；一个是显示帧，用于往服务器端发送长连接请求。如果是基于 AJAX 的长轮询方式，客户端可以异步地发出一个 XMLHttpRequest 请求，通知服务器端关闭数据连接。
在客户和服务器之间保持“心跳”信息
在浏览器与服务器之间维持一个长连接会为通信带来一些不确定性：因为数据传输是随机的，客户端不知道何时服务器才有数据传送。服务器端需要确保当客户端不再工作时，释放为这个客户端分配的资源，防止内存泄漏。因此需要一种机制使双方知道大家都在正常运行。在实现上：
   1. 服务器端在阻塞读时会设置一个时限，超时后阻塞读调用会返回，同时发给客户端没有新数据到达的心跳信息。此时如果客户端已经关闭，服务器往通道写数据会出现异常，服务器端就会及时释放为这个客户端分配的资源。
   2. 如果客户端使用的是基于 AJAX 的长轮询方式；服务器端返回数据、关闭连接后，经过某个时限没有收到客户端的再次请求，会认为客户端不能正常工作，会释放为这个客户端分配、维护的资源。
   3. 当服务器处理信息出现异常情况，需要发送错误信息通知客户端，同时释放资源、关闭连接。

【附】开源项目资源
Cometd(http://cometd.com/)              Comet framework sponsored by the Dojo foundation.
Orbited(http://orbited.org/)                可缩放的分布式Comet 服务器 （python 语言实现）
Pushlets（http://www.pushlets.com/）一个开源框架，可以让服务器端java对象推送事件到浏览器端javascript，java applet，或者flash应用程序
Jetty(http://jetty.mortbay.org/)          Servlet server java 实现
Pushup(http://pushup.causology.net/)  Comet server (C++

2 楼 shiren1118 2009-03-09  

分路复用协议 Bayeux
Bayeux的主要目的是支持使用ajax的客户端与服务器端之间灵敏，快速的信息交互。
Bayeux是一种用来在客户端和服务器端传输低延迟的异步消息（主要通过http）的一种协议。它定义的消息通过命名通道进行路由并且能够进行交互传 送：server -> client, client -> server 甚至 client -> client （当然还是需要通过server中转）。默认的，此通道已经引用了发布的路由语义，但同时也支持其它路由模块。
从服务器端向客户端异步发送的数据通常被叫做 “服务器推”（server-push）。这种使用ajax的web应用和服务器推技术的结合称作“Comet”。 Cometd是一个提供多种开发语言的Bayeux项目，由Dojo基金会提供支持。
Bayeux允许实现器通过更加简单的交互，解决普通的消息分发和路由的问题，同时为日益增加的改进和扩展提供相应机制，Bayeux希望通过这种方式力求减少开发“Comet驱动”应用的复杂度。


项目主页： http://svn.cometd.org/trunk/bayeux/bayeux.html

1 楼 shiren1118 2009-03-09  

原文http://www.grails.org/Cometd+Plugin