WebSocket protocol是HTML5 一种新协议。它实现了浏览器与服务器全双工通信(full-duplex)。一开始的握手还得需要借助HTTP实现。 WebSocket是真正实现了全双工通信的服务器向客户端推送的互联网协议。
真正解决的问题:
解决了常规AJAX轮询、传统长连接的性能损失。因为传统的方式是 连接打开、连接关闭型性能损失很大。Websocker实现的方式是在单位时间内,不会频繁的连接打开与关闭。我们真正解决还是需要依赖Tomcat或者Netty开发!
WebSocket是基于事件驱动的操作。并且不用担心跨域问题!
Maven
代码语言:javascript复制 <dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-websocket</artifactId>
</dependency>
WebSocketConfig
代码语言:javascript复制import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.socket.config.annotation.EnableWebSocket;
import org.springframework.web.socket.server.standard.ServerEndpointExporter;
/**
* @author : zanglikun
* @date : 2021/9/16 10:13
* @Version: 1.0
* @Desc : Web Socker 配置类
*/
@Configuration //配置类注解
@EnableWebSocket //启动WebSocket服务
public class WebSocketConfig {
@Bean
public ServerEndpointExporter serverEndpointExporter() {
return new ServerEndpointExporter();
}
}
WebSocketServer
代码语言:javascript复制package com.zanglikun.emailclock.config;
import java.io.IOException;
import java.util.concurrent.CopyOnWriteArraySet;
import javax.websocket.OnClose;
import javax.websocket.OnError;
import javax.websocket.OnMessage;
import javax.websocket.OnOpen;
import javax.websocket.Session;
import javax.websocket.server.PathParam;
import javax.websocket.server.ServerEndpoint;
import org.springframework.stereotype.Component;
import cn.hutool.log.Log;
import cn.hutool.log.LogFactory;
/**
* @author : zanglikun
* @date : 2021/9/16 11:42
* @Version: 1.0
* @Desc : 暂时没有注释说明此方法是做什么的
*/
@ServerEndpoint("/websocket/{sid}") // 需要提供个客户端一个操作终端
@Component
public class WebSocketServer {
static Log log=LogFactory.get(WebSocketServer.class);
//静态变量,用来记录当前在线连接数。应该把它设计成线程安全的。
private static int onlineCount = 0;
//concurrent包的线程安全Set,用来存放每个客户端对应的MyWebSocket对象。
private static CopyOnWriteArraySet<WebSocketServer> webSocketSet = new CopyOnWriteArraySet<WebSocketServer>();
//与某个客户端的连接会话,需要通过它来给客户端发送数据
private Session session;
//接收sid
private String sid="";
/**
* 连接建立成功调用的方法*/
@OnOpen //只有追加此注解才表示开启相应的事件监听
public void onOpen(Session session,@PathParam("sid") String sid) {
this.session = session;
webSocketSet.add(this); //加入set中
addOnlineCount(); //在线数加1
log.info("有新窗口开始监听:" sid ",当前在线人数为" getOnlineCount());
this.sid=sid;
try {
sendMessage("恭喜你,连接成功,您当前的是第" onlineCount "位用户");
} catch (IOException e) {
log.error("websocket IO异常");
}
}
/**
* 连接关闭调用的方法
*/
@OnClose
public void onClose() {
webSocketSet.remove(this); //从set中删除
subOnlineCount(); //在线数减1
log.info("有一连接关闭!当前在线人数为" getOnlineCount());
}
/**
* 收到客户端消息后调用的方法
*
* @param message 客户端发送过来的消息*/
@OnMessage
public void onMessage(String message, Session session) {
log.info("收到来自窗口" sid "的信息:" message);
//群发消息
for (WebSocketServer item : webSocketSet) {
try {
item.sendMessage(message);
} catch (IOException e) {
e.printStackTrace();
}
}
}
/**
*
* @param session
* @param error
*/
@OnError
public void onError(Session session, Throwable error) {
log.error("发生错误");
error.printStackTrace();
}
/**
* 实现服务器主动推送
*/
public void sendMessage(String message) throws IOException {
this.session.getBasicRemote().sendText(message);
}
/**
* 群发自定义消息
* */
public static void sendInfo(String message,@PathParam("sid") String sid) throws IOException {
log.info("推送消息到窗口" sid ",推送内容:" message);
for (WebSocketServer item : webSocketSet) {
try {
//这里可以设定只推送给这个sid的,为null则全部推送
if(sid==null) {
item.sendMessage(message);
}else if(item.sid.equals(sid)){
item.sendMessage(message);
}
} catch (IOException e) {
continue;
}
}
}
/**
* 获取当前的在线人数
* @return
*/
public static synchronized int getOnlineCount() {
return onlineCount;
}
/**
* 增加当前的在线人数
*/
public static synchronized void addOnlineCount() {
WebSocketServer.onlineCount ;
}
/**
* 减少当前的在线人数
*/
public static synchronized void subOnlineCount() {
WebSocketServer.onlineCount--;
}
}
测试的HTML代码
代码语言:javascript复制<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title><!DOCTYPE HTML>
<html>
<head>
<meta charset="utf-8">
<title>枕聊Websocket测试</title>
<script type="text/javascript">
function WebSocket_For_Test()
{
if ("WebSocket" in window)
{
alert("您的浏览器支持 WebSocket!");
// 打开一个 web socket
var ws = new WebSocket("ws://127.0.0.1:18888/websocket/1212");
ws.onopen = function()
{
// Web Socket 已连接上,使用 Websocket自带send() 方法发送数据
alert("数据正在发送...");
ws.send("你好啊,兄弟!");
alert("数据发送结束");
};
ws.onmessage = function (evt)
{
var received_msg = evt.data;
alert("数据已接收...内容是:" received_msg);
};
ws.onclose = function()
{
// 关闭 websocket
alert("连接已关闭...");
};
}
else
{
// 浏览器不支持 WebSocket
alert("您的浏览器不支持 WebSocket!");
}
}
</script>
</head>
<body>
<div id="sse">
<a href="javascript:WebSocket_For_Test()">运行 WebSocket</a>
</div>
</body>
</html>
特殊说明: 解决问题的光鲜,藏着磕Bug的痛苦。 万物皆入轮回,谁也躲不掉! 以上文章,均是我实际操作,写出来的笔记资料,不会出现全文盗用别人文章!烦请各位,请勿直接盗用!