思维导图
讲述之前，首先讲述一个知识点，SSE (Server-Sent Events)连接和websocket全双工连接的区别和各自的优缺点。
SSE (Server-Sent Events)连接
优点：
- 简单性：SSE仅支持服务器到客户端的单向通信，实现起来比较简单。
- 易用性：SSE是基于HTTP的，因此更容易集成到现有的Web应用中。
- 自动重连：SSE客户端在连接断开时会自动尝试重连，这对于签到系统来说是一个有用的特性。
缺点：
- 单向通信：SSE不支持客户端到服务器的通信，所有客户端的响应都需要通过单独的HTTP请求发送。
- 有限的用例：由于是单向通信，SSE不适合需要双向实时交互的应用。
websocket全双工连接
优点：
- 全双工通信：WebSocket支持客户端和服务器之间的双向通信，这意味着服务器可以推送消息到客户端，客户端也可以主动发送消息到服务器。
- 低延迟：由于WebSocket在建立连接后保持开放状态，它可以实现快速的消息传递，适合需要实时交互的应用。
- 自定义协议：WebSocket允许自定义数据协议，可以传输更复杂的数据结构。
缺点：
- 复杂性：WebSocket的协议相对复杂，实现起来可能需要更多的开发工作。
- 服务器资源：保持大量WebSocket连接会消耗更多的服务器资源。
实现Websocket实现简单的客户端和服务端之间连接
1.首先要准备一个客户端界面，这边的前端界面代码如下：
<!DOCTYPE HTML>
<html>
<head>
<meta charset="UTF-8">
<title>WebSocket Demo</title>
</head>
<body>
<input id="text" type="text" />
<button onclick="send()">发送消息</button>
<button onclick="closeWebSocket()">关闭连接</button>
<div id="message">
</div>
</body>
<script type="text/javascript">
var websocket = null;
var clientId = Math.random().toString(36).substr(2);
//判断当前浏览器是否支持WebSocket
if('WebSocket' in window){
//连接WebSocket节点
websocket = new WebSocket("ws://localhost:8080/ws/"+clientId);
}
else{
alert('Not support websocket')
}
//连接发生错误的回调方法
websocket.onerror = function(){
setMessageInnerHTML("error");
};
//连接成功建立的回调方法
websocket.onopen = function(){
setMessageInnerHTML("连接成功");
}
//接收到消息的回调方法
websocket.onmessage = function(event){
setMessageInnerHTML(event.data);
}
//连接关闭的回调方法
websocket.onclose = function(){
setMessageInnerHTML("close");
}
//监听窗口关闭事件，当窗口关闭时，主动去关闭websocket连接，防止连接还没断开就关闭窗口，server端会抛异常。
window.onbeforeunload = function(){
websocket.close();
}
//将消息显示在网页上
function setMessageInnerHTML(innerHTML){
document.getElementById('message').innerHTML += innerHTML + '<br/>';
}
//发送消息
function send(){
var message = document.getElementById('text').value;
websocket.send(message);
}
//关闭连接
function closeWebSocket() {
websocket.close();
}
</script>
</html>
2.准备一个可以运行的springboot工程，自己准备？-->作者说：对！
2.1在准备好的springboot工程上添加websocket启动依赖
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-websocket</artifactId>
</dependency>
版本的话要根据自己的springboot工程选择，自己去网上查，我这边springboot工程和websocket用的都是2.7.3的版本
3.在准备好的springboot工程上准备一个websocket的配置类
/**
* WebSocket配置类，用于注册WebSocket的Bean
*/
@Configuration
public class WebSocketConfiguration {
@Bean
public ServerEndpointExporter serverEndpointExporter() {
return new ServerEndpointExporter();
}
}
4.准备一个websocket服务类
/**
* WebSocket服务
*/
@Component
@ServerEndpoint("/ws/{sid}")
public class WebSocketServer {
//存放会话对象
private static Map<String, Session> sessionMap = new HashMap();
/**
* 连接建立成功调用的方法
*/
@OnOpen
public void onOpen(Session session, @PathParam("sid") String sid) {
System.out.println("客户端：" + sid + "建立连接");
sessionMap.put(sid, session);
}
/**
* 收到客户端消息后调用的方法
*
* @param message 客户端发送过来的消息
*/
@OnMessage
public void onMessage(String message, @PathParam("sid") String sid) {
System.out.println("收到来自客户端：" + sid + "的信息:" + message);
}
/**
* 连接关闭调用的方法
*
* @param sid
*/
@OnClose
public void onClose(@PathParam("sid") String sid) {
System.out.println("连接断开:" + sid);
sessionMap.remove(sid);
}
/**
* 群发
*
* @param message
*/
public void sendToAllClient(String message) {
Collection<Session> sessions = sessionMap.values();
for (Session session : sessions) {
try {
//服务器向客户端发送消息
session.getBasicRemote().sendText(message);
} catch (Exception e) {
e.printStackTrace();
}
}
}
}
5.一个定时想客户端发送消息的类，为什么要定时发送呢，主要是方便查看连接情况，防止websocket连接断开，也就是心跳消息：为了保持WebSocket连接活跃，服务器可能会定期发送心跳消息到客户端。这有助于在网络闲置时维持连接，防止由于超时而自动断开。
@Component
public class WebSocketTask {
@Autowired
private WebSocketServer webSocketServer;
/**
* 通过WebSocket每隔5秒向客户端发送消息
*/
@Scheduled(cron = "0/5 * * * * ?")
public void sendMessageToClient() {
webSocketServer.sendToAllClient("这是来自服务端的消息：" + DateTimeFormatter.ofPattern("HH:mm:ss").format(LocalDateTime.now()));
}
}
备注：有些小伙伴会发现 自己的这个注解报错@Scheduled(cron = "0/5 * * * * ?")，其实是正常的，因为这个定时心跳消息用的是springTask做的，而上面的步骤里面没有springTask功能运行的必须代码，那么要怎么使用springTask呢，请看这篇文章springboot中SpringTask定时任务的部署1.功能简述：SpringTask是Spring框架提供的任务调 - 掘金 (juejin.cn)很简单的
在所有步骤都完成之后，就可以运行springboot工程并打开前端界面了
这些是运行成功的截图：
连接成功：
向服务端发送消息：
消息接受成功：
那么完结(QwQ)
