1. WebSocket介绍
WebSocket 是基于 TCP 的一种新的网络协议。它实现了浏览器与服务器全双工通信——浏览器和服务器只需要完成一次握手，两者之间就可以创建持久性的连接， 并进行双向数据传输。
HTTP协议和WebSocket协议对比：
- HTTP是短连接
- WebSocket是长连接
- HTTP通信是单向的，基于请求响应模式
- WebSocket支持双向通信
- HTTP和WebSocket底层都是TCP连接
这里不得不产生一个问题：既然WebSocket支持双向通信，功能看似比HTTP强大，那么我们是不是可以基于WebSocket开发所有的业务功能？答案肯定时不行的，WebSocket还是存在一些缺点的。
- 服务器长期维护长连接需要一定的成本
- 各个浏览器支持程度不一
- WebSocket 是长连接，受网络限制比较大，需要处理好重连
故WebSocket并不能完全取代HTTP，它只适合在特定的场景下使用。
一般的WebSocket的应用场景：
- 视频弹幕
- 网页聊天
- 实况数据实时更新
2. Spring Boot实现WebSocket
2.1 服务端
创建Spring Boot项目，添加WebSocket的依赖：
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-websocket</artifactId>
</dependency>
定义配置类，注册WebSocket的服务端组件
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.socket.server.standard.ServerEndpointExporter;
/**
* WebSocket配置类，用于注册WebSocket的Bean
*/
@Configuration
public class WebSocketConfiguration {
@Bean
public ServerEndpointExporter serverEndpointExporter() {
return new ServerEndpointExporter();
}
}
定义WebSocket服务端组件
import jakarta.websocket.Session;
import jakarta.websocket.server.ServerEndpoint;
import org.springframework.stereotype.Component;
import jakarta.websocket.OnClose;
import jakarta.websocket.OnMessage;
import jakarta.websocket.OnOpen;
import jakarta.websocket.server.PathParam;
import java.util.Collection;
import java.util.HashMap;
import java.util.Map;
/**
* WebSocket服务
*/
@Component
@ServerEndpoint("/ws/{sid}") // 请求路径，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();
}
}
}
}
为了演示方便一点，这里使用了Spring Task定时任务去调用sendToAllClient函数模拟服务端主动给客户端发送消息。
import com.example.websocket.WebSocketServer;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.scheduling.annotation.Scheduled;
import org.springframework.stereotype.Component;
import java.time.LocalDateTime;
import java.time.format.DateTimeFormatter;
@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()));
}
}
2.2 客户端
这里简单使用一个html文件来表示
<!DOCTYPE HTML>
<html lang="en">
<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">
let websocket = null
// 生成一个用户端id
const clientId = Math.random().toString(36).slice(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() {
const message = document.getElementById('text').value;
websocket.send(message);
}
// 关闭连接
function closeWebSocket() {
websocket.close();
}
</script>
</html>
直接运行html文件，就会请求ws://localhost:8080/ws/{sid}建立连接。
这里可以看到发送的请求模式为websocket，其请求的url与预设的一致。
再看服务端输出的消息：
每一次关闭网页或者刷新就会导致连接断开，再次打开又会重新连接，这里调用的是WebSocket服务端组件设定的相应方法。
用户端的页面展示：
用户端会接收服务端每隔5秒发来的信息。
用户端也可以向服务端法相消息：
服务端就会接收到消息：
这里设置了一个按钮可以主动关闭连接，也可以实现断开连接，想要再次连接刷新网页就好了
本文主要是使用Spring Boot来简单实现websocket，还有一些其他方式，大家可以尽情探索。
