服务器主动向客户端推送消息-java之comet4j实现
传统的服务器客户端模型是:客户端发起请求-服务器响应-发送响应结果到客户端。而有些场景是需要在服务端有 相关信息更新时,主动向客户端推送该信息。实现这种模型现已有相关的框架。本博客将介绍comet4j实现web方式的推送!
本博文将简单介绍两个demo,其中一个是时钟,一个是简单数字变化。至于comet4j的介绍,在这里不在累赘( 不然就太啰嗦了!)
打开eclipse,将tomcat7弄进来,新建一个dynamic web project(2.5),放入comet4j-tomcat7.jar,在webContent新建js文件夹,放入comet4j.js,整体的截图如下:
其中,comet4j需要的Jar包与js在这里下载即可:comet4j相关资料下载
除此之外,需要修改tomcat7的server.xml配置:
即:tomcat知道的配置为: <Connector connectionTimeout="20000" port="8088" protocol="HTTP/1.1" redirectPort="8443"/>
现在需要修改为:<Connector URIEncoding="UTF-8" connectionTimeout="20000" port="8088"
protocol="org.apache.coyote.http11.Http11NioProtocol" redirectPort="8443"/>
新建包:org.steadyjack.comet,在包下新建两个类,TestComet.java和TestCometTimer,均实现ServletContextListener,相关代码如下所示:
TestComet类:
package org.steadyjack.comet;
import javax.servlet.ServletContextEvent;
import javax.servlet.ServletContextListener;
import org.comet4j.core.CometContext;
import org.comet4j.core.CometEngine;
public class TestComet implements ServletContextListener {
// 频道1
private static final String CHANNEL1 = "res1";
// 频道2
private static final String CHANNEL2 = "res2";
// 通过频道1推送给前台的变量1
private static int number1 = 0;
// 通过频道2推送给前台的变量2
private static int number2 = 100;
@Override
public void contextDestroyed(ServletContextEvent arg0) {
}
@Override
public void contextInitialized(ServletContextEvent arg0) {
// CometContext : Comet4J上下文,负责初始化配置、引擎对象、连接器对象、消息缓存等。
CometContext cc = CometContext.getInstance();
// 注册频道,即标识哪些字段可用当成频道,用来作为向前台传送数据的“通道”
cc.registChannel(CHANNEL1);
cc.registChannel(CHANNEL2);
Thread myThread = new Thread(new SendToClientThread(),"SendToClientThread");
// 下面的内部类的方法是个死循环,设置helloAppModule线程为“守护线程”,则当jvm只剩“守护线程”时(主线程结束),该线程也会结束。
myThread.setDaemon(true);
// 开始线程
myThread.start();
}
/**
* 内部类线程类
*/
class SendToClientThread implements Runnable {
public void run() {
while (true) {
try {
Thread.sleep(1000);
} catch (Exception ex) {
ex.printStackTrace();
}
// CometEngine : 引擎,负责管理和维持连接,并能够必要的发送服务
CometEngine engine = CometContext.getInstance().getEngine();
// 参数的意思:通过什么频道(CHANNEL1)发送什么数据(number1++),前台可用可用频道的值(result1)来获取某频道发送的数据
engine.sendToAll(CHANNEL1, number1++);
engine.sendToAll(CHANNEL2, number2++);
}
}
}
}
package org.steadyjack.comet;
import java.text.SimpleDateFormat;
import java.util.Date;
import javax.servlet.ServletContextEvent;
import javax.servlet.ServletContextListener;
import org.comet4j.core.CometContext;
import org.comet4j.core.CometEngine;
public class TestCometTimer implements ServletContextListener {
// 频道1
private static final String CHANNEL1 = "timer";
@Override
public void contextDestroyed(ServletContextEvent arg0) {
}
@Override
public void contextInitialized(ServletContextEvent arg0) {
// CometContext : Comet4J上下文,负责初始化配置、引擎对象、连接器对象、消息缓存等。
CometContext cc = CometContext.getInstance();
// 注册频道,即标识哪些字段可用当成频道,用来作为向前台传送数据的“通道”
cc.registChannel(CHANNEL1);
Thread myThread = new Thread(new SendToClientThread(),"SendToClientThread");
// 下面的内部类的方法是个死循环,设置helloAppModule线程为“守护线程”,则当jvm只剩“守护线程”时(主线程结束),该线程也会结束。
myThread.setDaemon(true);
// 开始线程
myThread.start();
}
/**
* 内部类线程类
*/
class SendToClientThread implements Runnable {
public void run() {
while (true) {
try {
Thread.sleep(1000);
} catch (Exception ex) {
ex.printStackTrace();
}
// CometEngine : 引擎,负责管理和维持连接,并能够必要的发送服务
CometEngine engine = CometContext.getInstance().getEngine();
//设置日期格式
SimpleDateFormat df = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
// new Date()为获取当前系统时间
String strDate=df.format(new Date());
// 参数的意思:通过什么频道(CHANNEL1)发送什么数据(number1++),前台可用可用频道的值(result1)来获取某频道发送的数据
engine.sendToAll(CHANNEL1, strDate);
}
}
}
}
配置下web.xml:
<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://java.sun.com/xml/ns/javaee"
xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
id="WebApp_ID" version="2.5">
<display-name>cometProject</display-name>
<welcome-file-list>
<welcome-file>index.jsp</welcome-file>
</welcome-file-list>
<listener>
<listener-class>org.comet4j.core.CometAppListener</listener-class>
</listener>
<listener>
<listener-class>org.steadyjack.comet.TestComet</listener-class>
</listener>
<listener>
<listener-class>org.steadyjack.comet.TestCometTimer</listener-class>
</listener>
<servlet>
<servlet-name>cometServlet</servlet-name>
<servlet-class>org.comet4j.core.CometServlet</servlet-class>
</servlet>
<servlet-mapping>
<servlet-name>cometServlet</servlet-name>
<url-pattern>/comet</url-pattern>
</servlet-mapping>
</web-app>
新建两个jsp文件:index.jsp,indexTimer.jsp,分别对应上面两个servlet推送给客户端的数据(其实可以合并为一个Servlet即可!)
index.jsp:
<%@ page language="java" contentType="text/html; charset=UTF-8"
pageEncoding="UTF-8"%>
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Insert title here</title>
<script type="text/javascript" src="js/comet4j.js"></script>
<script type="text/javascript">
function init() {
var number1 = document.getElementById('number1');
var number2 = document.getElementById('number2');
// 建立连接,conn 即web.xml中 CometServlet的<url-pattern>
JS.Engine.start('comet');
// 监听后台某个频道
JS.Engine.on({
// 对应服务端 “频道1” 的值 result1
res1 : function(num1) {
number1.innerHTML = num1;
},
// 对应服务端 “频道2” 的值 result2
res2 : function(num2) {
number2.innerHTML = num2;
},
});
}
</script>
</head>
<body οnlοad="init()">
数字1:<span id="number1">...</span>
<br></br>
数字2:<span id="number2">...</span>
</body>
</html>
indexTimer.jsp:
<%@ page language="java" contentType="text/html; charset=UTF-8"
pageEncoding="UTF-8"%>
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Insert title here</title>
<script type="text/javascript" src="js/comet4j.js"></script>
<script type="text/javascript">
function init() {
var nowTime = document.getElementById('nowTime');
// 建立连接,conn 即web.xml中 CometServlet的<url-pattern>
JS.Engine.start('comet');
// 监听后台某个频道
JS.Engine.on({
timer : function(num1) {
nowTime.innerHTML = num1;
},
});
}
</script>
</head>
<body οnlοad="init()">
现在时间是:<span id="nowTime">...</span>
</body>
</html>
将项目run到tomcat7,访问index.jsp(默认)效果图:
访问indexTime.jsp效果图:
两个图都是不断在变化的!好了,就介绍到这里吧,下文介绍介绍另外一种机制。