一.简介(摘自百度百科)
WebSocket是一种在单个TCP连接上进行全双工通信的协议。WebSocket通信协议于2011年被IETF定为标准RFC 6455,并由RFC7936补充规范。WebSocket API也被W3C定为标准。
WebSocket使得客户端和服务器之间的数据交换变得更加简单,允许服务端主动向客户端推送数据。在WebSocket API中,浏览器和服务器只需要完成一次握手,两者之间就直接可以创建持久性的连接,并进行双向数据传输。
二.demo
1.服务器端代码
@ServerEndpoint("/websocket/{nickname}")
public class WebSocket {
private static Map<String, WebSocket> clients = new ConcurrentHashMap<String, WebSocket>();
private Session session;
private String nickname;
@OnOpen
public void onOpen(@PathParam("nickname") String nickname, Session session) {
/*
*客户端与服务端链接建立成功后调用的方法
*/
this.nickname = nickname;
this.session = session;
clients.put(nickname, this);
//System.out.println("已连接");
}
@OnClose
public void onClose() throws IOException {
/*
*客户端与服务端链接关闭后调用的方法
*/
clients.remove(nickname);
}
@OnMessage
public void onMessage(String message) throws IOException {
/*
*客户端与服务端进行消息通讯所使用的方法
*客户端通过send()方法发送消息后服务端在此接收
*
*/
//System.out.println(message);
JSONObject MSG = JSONObject.fromObject(message);
if (!MSG.get("bname").equals("sendall")){
sendMSGTo(MSG.toString(), MSG.get("bname").toString());
}
}
@OnError
public void onError(Session session, Throwable error) {
error.printStackTrace();
}
//向指定用户发送消息
public void sendMSGTo(String message, String To) throws IOException {
for (WebSocket item : clients.values()) {
if (item.nickname.equals(To) )
item.session.getAsyncRemote().sendText(message);
}
}
}
2.客户端js代码
var websocket = null;
var host = document.location.host;
function webst(){
var nickname = $(" #nowusername").text(); // 获得当前登录人员的nickname
// 判断当前浏览器是否支持WebSocket
if ('WebSocket' in window) {
websocket = new WebSocket("ws://" + host + "/此处写你自己的项目名称/websocket/"
+ nickname);
} else {
alert('当前浏览器不支持websocket')
}
// 连接发生错误的回调方法
websocket.onerror = function() {
alert("WebSocket连接发生错误");
};
// 连接成功建立的回调方法
websocket.onopen = function() {
alert("WebSocket连接成功");
}
// 接收到消息的回调方法
websocket.onmessage = function(event) {
alert(event.data);
var msgvo=JSON.parse(event.data);
showlog(msgvo.aname);//这是我自己写的函数使用时请去掉
// websocket.close();
}
// 连接关闭的回调方法
websocket.onclose = function() {
alert("WebSocket连接关闭");
}
// 监听窗口关闭事件,当窗口关闭时,主动去关闭websocket连接,防止连接还没断开就关闭窗口,防止服务端抛异常。
window.onbeforeunload = function() {
closeWebSocket();
}
}
// 关闭WebSocket连接
function closeWebSocket() {
websocket.close();
}
客户端使用时:
webst();//调用函数与服务端建立连接
websocket.send(msgvo);//通过send()方法向服务端发送消息,我所用的msgvo为json格式
服务端向客户端推送消息时,直接在onMessage()方法中进行推送。
使用Struts2框架时请务必注意,配置此条过滤,防止请求被拦截
<constant name="struts.action.excludePattern" value="/ws/.*,ws://.*"></constant>