本实例使用websocket实现了即时聊天系统,websocket技术可以在网页中使用js技术完成与后台的通讯, 而后台tomcat集成了websocket功能, 只需要很少的代码就可以完成很强大的功能, 基于此聊天系统可以扩展成实时展示系统, 如网页中显示股票信息【数据实时变化】, 网页中显示交通实况信息等
本文demo下载:http://www.wisdomdd.cn/Wisdom/resource/articleDetail.htm?resourceId=1052
项目对应的实例代码可以通过【点击下载】进行下载
项目开发工具Eclipse, JDK1.7, Maven3.0.4, tomcat8 等工具也可以在【工具下载】栏目中下载
项目包含内容(见下图):
BarrageClient-master.zip 客户端源码
Barrage-master.zip 服务端源码
介绍:
WebSocket是HTML5规范新引入的功能,用于解决浏览器与后台服务器双向通讯的问题,使用WebSocket技术,后台可以随时向前端推送消息,以保证前后台状态统一,在传统的无状态HTTP协议中,这是“无法做到”的。
原理:
客户端由HTML5 websocket监听,客户端发送长连接,后台请求阻塞实现服务端消息实时更新.
服务端获得当前连接中的所有请求ID,实时推送消息.
首先上最终结果图:
张三聊天界面:
李四聊天界面:
页面样式用的bootstrap简单的画了一下
客户端的目录结构:
客户端一共就三个文件,主要是index.html和index.js,core.js里面只写了一些工具方法
下面上index.js的代码也就是客户端的实现:
ws://127.0.0.1:8080/barrage/init 这是连接后台的固定写法
ws为前缀, 127.0.0.1为ip地址 8080为tomcat提供的服务端口 barrage为项目名称
init 为后台对应的@ServerEndpoint("/init")
var socket = new WebSocket("ws://127.0.0.1:8080/barrage/init");$(function() {listen();})function emit() {var text = encodeScript($("#msg").val());var msg = {"message" : text,"color" : "#CECECE","bubbleColor" : "#2E2E2E","fontSize" : "12","fontType" : "黑体"};msg = JSON.stringify(msg);socket.send(msg);$("#content").append("<kbd style='color: #" + "CECECE" + ";float: right; font-size: " + 12 + ";'>" + text + "</kbd><br/>");$("#msg").val("");}function listen() {socket.onopen = function() {$("#content").append("<kbd>Welcome!</kbd></br>");};socket.onmessage = function(evt) {var data = JSON.parse(evt.data);$("#content").append("<kbd style='color: #" + data.color + ";font-size: " + data.fontSize + ";margin-top: 10px;'>" + data.userName + " Say: " + data.message + "</kbd></br>");};socket.onclose = function(evt) {$("#content").append("<kbd>" + "Close!" + "</kbd></br>");}socket.onerror = function(evt) {$("#content").append("<kbd>" + "ERROR!" + "</kbd></br>");}}document.onkeydown = function(event){var e = event || window.event || arguments.callee.caller.arguments[0];if(e && e.keyCode == 13){ // enter 键emit();}};
接下来是页面index.html的实现:
<!DOCTYPE html><html> <head> <meta name="viewport" content="width=device-width, initial-scale=1"> <title>BarrageClient</title> <link rel="stylesheet" href="http://cdn.bootcss.com/bootstrap/3.3.5/css/bootstrap.min.css"> </head> <body> <div class="container" style="padding-top:20px;"> <div class="panel panel-primary"> <div class="panel-heading"> <h3 class="panel-title">Barrage</h3> </div> <div class="panel-body" id="content"></div> </div> <hr/> <input type="text" class="form-control" placeholder="msg" aria-describedby="sizing-addon1" id="msg"> <hr/> <hr/> <button type="button" class="btn btn-lg btn-success btn-block" οnclick="emit()">Emit</button> </div> <script type="text/javascript" src="http://apps.bdimg.com/libs/jquery/2.1.4/jquery.min.js"></script> <script type="text/javascript" src="http://cdn.bootcss.com/bootstrap/3.3.5/js/bootstrap.min.js"></script> <script type="text/javascript" src="js/core.js"></script> <script type="text/javascript" src="js/index.js"></script> </body></html>
core.js中的encodeScript方法
function encodeScript(data) { if(null == data || "" == data) { return ""; } return data.replace("<", "<").replace(">", ">");}
服务端目录结构
服务端使用tomcat-websocket-api的jar包实现,主要是client包下面的BarrageClient类
init为对外提供服务的方法名称
前台与后台建立连接后, onOpen方法被调用
前台与后台断开连接后, onClose方法被调用
前台向后台传送消息后, onMessage会被调用, message中的数据格式为JSON
@ServerEndpoint
(
"/init"
)
public
class
BarrageClient {
private
static
Logger LOG = LoggerFactory.getLogger(BarrageClient.
class
);
@OnOpen
public
void
onOpen(Session session) {
//加入用户池
UserPool.add(session);
}
@OnMessage
public
void
onMessage(String message, Session session)
throws
IOException {
LOG.info(
"user ["
+ session.getId() +
"] Received: "
+ message);
//给所有用户发送消息
MessageProxy.getInstance().getProxy(Message.
class
).send(message, session);
}
@OnError
public
void
onError(Throwable throwable) {
LOG.error(throwable.getMessage());
}
@OnClose
public
void
onClose(Session session) {
//移除用户池
UserPool.remove(session.getId());
}
}