功能特性
-
推送消息广播。
-
推送定向消息。
-
提供连接上线前、上线、下线前、下线、发送消息等多种可处理事件。
-
消息缓存机制,确保长轮询工作模式下不丢失消息。
-
客户端正常下线,服务端可立即感知。
-
客户端异常停止工作,服务端可定时检查并感知。
-
以注册通道应用的方式,让开发者对框架功能进行扩展,实现自己的应用。
框架特性
-
独立小巧,不依赖于第三方包。
-
与应用紧密集成,无需独立应用或服务器。
-
与Session无关的连接机制,为开发人员提供最大程度的功能可控性。
-
面向事件编程,客户端与服务器端均为事件驱动开发模式,提供了良好的可扩展性机制。
-
各项性能参数均可配置。
-
支持多种主流浏览器,并支持Air应用环境。
服务器支持情况
Tomcat6、Tomcat7
浏览器支持情况
支持XMLHTTPRequest对象的浏览器均可支持长轮询工作模式,但不一定能够支持长连接。
浏览器/平台 | 版本 | 长轮询 | 长连接 |
Internet Explorer | 6,7,8,9,10,11 | √ | X |
FireFox | 3.0+(更底版本未知) | √ | √ |
Chrome | 7.0+(更底版本未知) | √ | √ |
Safari | 5+(更底版本未知) | √ | √ |
Opera | 11.10+(更底版本未知) | √ | X |
Air | 1.5+(更底版本未知) | √ | √ |
IOS(Iphone/Ipad) | 3.1+(更底版本未知) | √ | √ |
Android | 未测试 | 未知 | 未知 |
BlackBerry | 未测试 | 未知 | 未知 |
使用方法
下载相关的jar包(根据自己使用的tomcat6还是7选择)和相关js并放到自己项目当中
Comet 流是按照长轮询的实现思路进一步发展的产物。令长轮询将事件通知发送回客户端后不再关闭连接,而是一直保持直到超时事件发生才重新建立新的连接,这种变体我们就称为 Comet 流。客户端可以使用 XmlHttpRequest 对象中的 readyState 属性来判断是 Receiving 还是 Loaded。Comet 流在服务端和客户端都需要维持一个比较长时间的连接状态,这一点在客户端不算什么太大的负担,但是服务端是要同时对多个客户端服务的,按照经典 Request-Response 交互模型,每一个请求都占用一个 Web 线程不释放的话,Web 容器的线程则会很快消耗殆尽,而这些线程大部分时间处于空闲等待的状态。所以建议选择 ,因为Servlet 3.0的新特性异步处理只有在tomcat7.0及以上才支持,这样我们Web 线程不需要同步的、一对一的处理客户端请求,能做到一个 Web 线程处理多个客户端请求。而且就算以后用HTML5的websocket也需要至少是tomcat7.0。
修改tomcat服务器配置文件
因为Comet4J工作在NIO方式下(自tomcat6.0后提供的Advanced NIO 技术以便一个 Servlet 线程能处理多个 Http Request),所以我们需要调整服务器连接器配置,更换为NIO连接器。 打开server.xml文件将找到原先的连接器配置:
更改为:
在web.xml中加载Comet4J框架
org.comet4j.core.CometAppListener CometServlet CometServlet org.comet4j.core.CometServlet CometServlet /conn
客户端
Comet4J Hello World
JS.Engine类是一个静态类,它负责服务器的连接与断开以及把服务器推过来的消息转化为事件分发。
JS.Engine.start(String str)和JS.Engine.stop(String str)分别控制连接和断开动作。
start方法需要传入一个字符串参数,用来指定您配置的Comet4J连接地址。比如按前面准备工作的配置了CometServlet的地址为/conn,那么连接就用:
JS.Engine.start('conn');
stop方法可以传参与不传参,传参为对断开连接的说明。
JS.Engine.stop();JS.Engine.stop('主动断开');
JS.Engine.on方法来注册事件处理。当使用start方法成功建立连接已后JS.Engine会发出"start"事件,当断开后会发出“stop”事件,当收到某个通道推送过来的信息时也会发出与通道标识同名的事件。
JS.Engine.on({ hello : function(kb){//建立hello信道标识,当客户端对该信道推送消息时客户端就会接收并响应 kbDom.innerHTML = kb; }});JS.Engine.on( 'start', function(cId,channelList,engine){ alert('连接已建立,连接ID为:' + cId);});JS.Engine.on('stop',function(cause, cId, url, engine){ alert('连接已断开,连接ID为:' + cId + ',断开原因:' + cause + ',断开的连接地址:'+ url);});
on方法注册事件可以使用 on({name1:function(){...},name2:function(){...}})或者on('name',function(){...})两种方式。
特别注意:以上代码在事件处理函数中使用了alert仅为说明函数功能,实际使用中,在事件处理函数中切勿使用alert、prompt、confirm等可以中断脚本运行的函数,因为Engine需要实时的保持工作状态。
服务端
服务端由一个Jar包组成,其中最重的是CometContext和CometEngine两个类。
Comet Context 类
CometContext是一个单态类,通过其getInstance方法来获得实例,它主要负责框架的一些初始化工作保存着一些参数的配置值,除此之外它还有一个更重要的职责——负责注册应用通道标识。如果您想使用框架来实现自己的应用,那么您必需要为自己的应用分配一个唯一的通道标识,并将此通道标识在WEB容器启动时使用CometContext的registChannel方法进行注册,这样,客户端才可以正确接受此应用所推送的消息。
Comet Engine 类
CometContext类,它除了负责对连接的处理之外,对于开发人员而言,更加常用的可能是它所提供的sendTo或sendToAll方法来向客户端发送消息。sendTo方法是将消息推送给所有指定信道的客户端,而sendToAll方法是将消息推送给指定信道的一个或多个连接ID的客户端。
String channel = "hello";String someConnectionId = "1125-6634-888";engine.sendToAll(channel , "我来了!");engine.sendTo(channel , engine.getConnection(someConnectionId),“Hi,我是XXX”);
CometEngine另外一个很重要的地方在于,它是框架工作的事件引擎的集散地,它提供了BeforeConnectEvent、BeforeDropEvent、ConnectEvent、DropEvent、MessageEvent等事件。通过对这些事件的处理来实现具体的功能:
class JoinListener extends ConnectListener { @Override public boolean handleEvent(ConnectEvent anEvent) { CometConnection conn = anEvent.getConn(); CometContext.getInstance().getEngine().sendTo("hello", conn.getId(),"欢迎上线"); }}CometEngine engine = CometContext.getInstance().getEngine();engine.addConnectListener(new JoinListener());
测试代码:
class HelloWorld implements ServletContextListener { //定义信道标识 private static final String CHANNEL = "hello"; public void contextInitialized(ServletContextEvent arg0) { //获取CometContext实例 CometContext cc = CometContext.getInstance(); 注册hello信道 cc.registChannel(CHANNEL); //模拟推送 开启线程 Thread helloAppModule = new Thread(new HelloAppModule(), "Sender App Module"); //设置为守护线程 helloAppModule.setDaemon(true); helloAppModule.start(); } class HelloAppModule implements Runnable { public void run() { while (true) { try { //线程休眠模拟推送 Thread.sleep(1000); } catch (Exception ex) { ex.printStackTrace(); } CometEngine engine = CometContext.getInstance().getEngine(); engine.sendToAll(CHANNEL, getName()); } } } public String getName(){ String[]names = new String[]{"冯春雷","吴兆元","夏胜安","李瑞东","田东东","张文良","刘权","邵帅","肖小良","任银","王继伟"}; int number = new Random().nextInt(10) + 1; return names[number]; } public void contextDestroyed(ServletContextEvent arg0) { }}
运行项目代码:
成功!!!