WebSocket—双向实时通信

2024-10-29 13:56:13

WebSocket 是一种用于建立客户端和服务器之间的全双工通信协议。它允许在同一连接上进行双向数据传输，特别适合实时性要求高的应用场景，如即时聊天、实时通知和在线游戏等。WebSocket 使用 HTTP 握手建立连接，一旦连接建立，数据可以在客户端和服务器之间以最小的开销持续传输。

1. WebSocket 介绍

WebSocket 是基于 TCP 的一种新的网络协议。它实现了浏览器与服务器全双工通信——浏览器和服务器只需要完成一次握手，两者之间就可以创建持久性的连接，并进行双向数据传输。

双向通信：WebSocket 支持双向通信，客户端和服务器可以相互发送消息，而不需要不断地建立新的连接。
高效性：WebSocket 数据帧头信息小，节省带宽；并且连接建立后可长期保持，适合实时应用场景。
使用场景：WebSocket 适用于各种实时数据场景，如聊天应用、股票行情、物联网、实时位置服务等。

2. WebSocket 与 HTTP 的区别

HTTP是短连接
WebSocket是长连接
HTTP通信是单向的，基于请求响应模式
WebSocket支持双向通信
HTTP和WebSocket底层都是TCP连接

WebSocket缺点：

（1）服务器长期维护长连接需要一定的成本；

（2）各个浏览器支持程度不一；

（3）WebSocket 是长连接，受网络限制比较大，需要处理好重连

所以WebSocket并不能完全取代HTTP，它只适合在特定的场景下使用。

3. WebSocket 工作原理

握手阶段：客户端通过 HTTP 发起连接请求，包含 Upgrade 和 Connection 请求头，服务器响应后，协议由 HTTP 升级为 WebSocket。
数据传输阶段：连接建立后，客户端和服务器可以在同一通道上实时地发送或接收数据。
关闭连接：任一方可以随时主动关闭连接，发送关闭帧 CLOSE，另一方响应后连接断开。

4. 入门案例

4.1 定义websocket.html页面

<!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>

4.2 导入maven坐标

<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter-websocket</artifactId>
</dependency>

4.3 定义WebSocket服务类

/**
 * WebSocket服务
 * 
 * WebSocketServer 通过 @ServerEndpoint 注解定义为 WebSocket 端点，
 * 允许客户端与该服务器端点进行 WebSocket 连接和通信。
 */
@Component  // 将该类标记为 Spring 管理的组件
@ServerEndpoint("/ws/{sid}")  // 定义 WebSocket 端点路径和路径参数
public class WebSocketServer {

    // 存放所有客户端会话对象的 Map，键为会话标识 sid，值为 WebSocket 的 Session
    private static Map<String, Session> sessionMap = new HashMap<>();

    /**
     * 连接建立成功调用的方法
     * 
     * 当客户端成功连接到 WebSocket 服务器时自动调用此方法，将会话对象和会话 ID 添加到 sessionMap 中。
     * 
     * @param session WebSocket 会话对象，用于和客户端通信
     * @param sid 客户端连接时传递的路径参数，用于标识该客户端
     */
    @OnOpen
    public void onOpen(Session session, @PathParam("sid") String sid) {
        System.out.println("客户端：" + sid + " 建立连接");
        sessionMap.put(sid, session);  // 将会话存入 Map 中
    }

    /**
     * 收到客户端消息后调用的方法
     * 
     * 客户端向 WebSocket 服务器发送消息时触发此方法，并在控制台打印收到的消息内容。
     * 
     * @param message 客户端发送的消息内容
     * @param sid 该消息发送方的会话标识 sid
     */
    @OnMessage
    public void onMessage(String message, @PathParam("sid") String sid) {
        System.out.println("收到来自客户端：" + sid + " 的信息: " + message);
        // 可以在此处处理收到的消息，例如广播消息或向特定客户端发送消息
    }

    /**
     * 连接关闭时调用的方法
     * 
     * 当客户端断开 WebSocket 连接时触发此方法，从 sessionMap 中移除该会话对象。
     * 
     * @param sid 断开连接的客户端会话标识 sid
     */
    @OnClose
    public void onClose(@PathParam("sid") String sid) {
        System.out.println("连接断开: " + sid);
        sessionMap.remove(sid);  // 从 Map 中移除会话
    }

    /**
     * 群发消息
     * 
     * 将消息发送给所有已连接的客户端。
     * 
     * @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();  // 如果发送消息失败，打印异常信息
            }
        }
    }
}

4.4 定义配置类，注册WebSocket的服务端组件

/**
 * WebSocket配置类，用于注册WebSocket的Bean
 * 
 * 该配置类通过定义一个 ServerEndpointExporter Bean 来启用 WebSocket 功能，
 * 使得项目中使用 @ServerEndpoint 注解标记的 WebSocket 端点类可以自动
 * 注册到 Spring 容器中，从而提供 WebSocket 服务。
 */
@Configuration  // 标注这是一个 Spring 配置类，用于在 Spring 容器中注册 Bean
public class WebSocketConfiguration {

    /**
     * 声明 ServerEndpointExporter Bean。
     * 
     * ServerEndpointExporter 是 Spring WebSocket 配置的核心组件，用于扫描和注册
     * 所有带有 @ServerEndpoint 注解的 WebSocket 端点类。
     * 
     * @return ServerEndpointExporter 实例，用于自动注册 @ServerEndpoint 注解的 WebSocket 端点。
     */
    @Bean
    public ServerEndpointExporter serverEndpointExporter() {
        return new ServerEndpointExporter();  // 实例化 ServerEndpointExporter 并交由 Spring 容器管理
    }
}

4.5 向客户端发送消息

通过webSocketServer中的sendToAllClient方法可以向客户端发送消息。

webSocketServer.sendToAllClient("这是来自服务端的消息：" + DateTimeFormatter.ofPattern("HH:mm:ss").format(LocalDateTime.now()));
    }

码农公寓