WebSocket 详解--spring boot简单使用案例

52 阅读 0 评论 0 点赞

一、什么是WebSocket

WebSocket 是一种网络通信协议，专为在单个 TCP 连接上进行全双工通信而设计。WebSocket 允许客户端和服务器之间的消息能够实时双向传输。这与传统的 HTTP 请求-响应模式有很大的不同。

二、WebSocket 的关键特性

双向通信：WebSocket 提供了双向通信通道。客户端和服务器可以随时向对方发送消息，而无需客户端发起请求。

持久连接：一旦 WebSocket 连接建立，连接将保持打开状态，直到客户端或服务器显式关闭它。这样避免了频繁的 HTTP 请求开销。

低延迟：由于连接保持打开状态，WebSocket 消息的传输延迟非常低，非常适合需要快速响应的应用，如在线游戏、实时聊天等。

轻量协议：WebSocket 协议头部相对较小，减少了数据传输的开销。

三、WebSocket 工作原理

握手：WebSocket 连接始于 HTTP 请求。客户端发出一个带有特殊头部的 HTTP 请求，要求升级到 WebSocket 协议。服务器同意后，通过 HTTP 101 状态码响应，表示协议切换。

数据传输：握手完成后，客户端和服务器之间的通信切换到 WebSocket 协议。两者可以在这条连接上随时发送文本或二进制消息。

连接关闭：连接可以由客户端或服务器主动关闭，通过发送关闭消息并随后关闭 TCP 连接。

四、WebSocket 应用场景

实时聊天应用：如在线客服、社交网络聊天。
在线游戏：需要低延迟实时通信的多人游戏。
实时数据流：如股票行情、体育比分更新。
协同编辑：如 Google Docs 这样的实时文档编辑工具。
物联网（IoT）设备：需要与服务器持续通信的智能设备。
WebSocket 的优势在于其双向通信能力和低延迟，是需要实时数据更新的应用的不二选择。

五、WebSocket简单使用案例——java为例

1、为了方便部署，直接创建一个spring boot项目

首先，使用 Spring Initializr 创建一个新的 Spring Boot 项目。你可以访问 Spring Initializr 或者在 IntelliJ IDEA 中创建一个新项目。

选择的依赖项：

Spring Web
Spring Boot Starter WebSocket
下载项目并解压到你的工作目录中。

2. 编写 WebSocket 服务器端点

2.1 创建 WebSocket 配置类

在 src/main/java/com/example/demo 下创建一个配置类 WebSocketConfig.java：

package com.example.demo;

import org.springframework.context.annotation.Configuration;
import org.springframework.web.socket.config.annotation.EnableWebSocket;
import org.springframework.web.socket.config.annotation.WebSocketConfigurer;
import org.springframework.web.socket.config.annotation.WebSocketHandlerRegistry;

@Configuration
@EnableWebSocket
public class WebSocketConfig implements WebSocketConfigurer {

    @Override
    public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
        registry.addHandler(new MyWebSocketHandler(), "/websocket")
                .setAllowedOrigins("*");
    }
}

2.2 创建 WebSocket 处理器

在同一包下创建一个处理器类 MyWebSocketHandler.java：

package com.example.demo;

import org.springframework.web.socket.CloseStatus;
import org.springframework.web.socket.TextMessage;
import org.springframework.web.socket.WebSocketSession;
import org.springframework.web.socket.handler.TextWebSocketHandler;

import java.util.Collections;
import java.util.HashSet;
import java.util.Set;

public class MyWebSocketHandler extends TextWebSocketHandler {

    private static Set<WebSocketSession> sessions = 
        Collections.synchronizedSet(new HashSet<>());

    @Override
    public void afterConnectionEstablished(WebSocketSession session) throws Exception {
        sessions.add(session);
    }

    @Override
    public void handleTextMessage(WebSocketSession session, TextMessage message) throws Exception {
        for (WebSocketSession webSocketSession : sessions) {
            if (webSocketSession.isOpen() && !session.getId().equals(webSocketSession.getId())) {
                webSocketSession.sendMessage(new TextMessage(message.getPayload()));
            }
        }
    }

    @Override
    public void afterConnectionClosed(WebSocketSession session, CloseStatus status) throws Exception {
        sessions.remove(session);
    }
}

3. 创建 WebSocket 客户端

为了测试 WebSocket，我们可以创建一个简单的 HTML 文件和 JavaScript 客户端。

在 src/main/resources/static 下创建一个新的 HTML 文件 index.html：

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>WebSocket Test</title>
</head>
<body>
    <h1>WebSocket Test</h1>
    <input type="text" id="messageInput" placeholder="Enter message">
    <button onclick="sendMessage()">Send</button>
    <ul id="messages"></ul>

    <script>
        let websocket = new WebSocket("ws://localhost:8080/websocket");

        websocket.onopen = function(event) {
            console.log("Connected to WebSocket");
        };

        websocket.onmessage = function(event) {
            let messages = document.getElementById("messages");
            let message = document.createElement("li");
            message.textContent = event.data;
            messages.appendChild(message);
        };

        websocket.onclose = function(event) {
            console.log("Disconnected from WebSocket");
        };

        function sendMessage() {
            let input = document.getElementById("messageInput");
            websocket.send(input.value);
            input.value = '';
        }
    </script>
</body>
</html>

4. 运行 Spring Boot 应用程序

打开你的 IDE（如 IntelliJ IDEA），加载项目并运行 Spring Boot 应用程序。

你可以通过运行 DemoApplication.java 主类来启动应用程序：
package com.example.demo;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class DemoApplication {

    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }
}

5. 测试 WebSocket

启动应用程序后，打开浏览器并访问 http://localhost:8080。你应该看到一个简单的页面，允许你输入消息并发送。消息将通过 WebSocket 发送到服务器，并广播到所有连接的客户端。

这是一个使用 Spring Boot 和注解配置的 WebSocket 完整示例。这个示例展示了如何使用注解简化 WebSocket 的配置和处理。你可以根据需要进一步扩展和定制这个项目。

6、效果展示

7、注解的写法

直接使用注解包括 @OnOpen, @OnMessage, @OnClose, @OnError等去配置websocket

创建一个配置类 WebSocketConfig.java：

package com.example.demo;

import org.springframework.context.annotation.Configuration;
import org.springframework.web.socket.server.standard.ServerEndpointExporter;

@Configuration
public class WebSocketConfig {

    public ServerEndpointExporter serverEndpointExporter() {
        return new ServerEndpointExporter();
    }
}

在同一包下创建 WebSocket 端点类 WebSocketServer.java：

package com.example.demo;

import javax.websocket.OnClose;
import javax.websocket.OnError;
import javax.websocket.OnMessage;
import javax.websocket.OnOpen;
import javax.websocket.Session;
import javax.websocket.server.ServerEndpoint;
import java.io.IOException;
import java.util.Collections;
import java.util.HashSet;
import java.util.Set;

@ServerEndpoint("/websocket")
public class WebSocketServer {

    private static Set<Session> clients = Collections.synchronizedSet(new HashSet<>());

    @OnOpen
    public void onOpen(Session session) {
        clients.add(session);
        System.out.println("New connection with client id: " + session.getId());
    }

    @OnMessage
    public void onMessage(String message, Session session) throws IOException {
        System.out.println("New message from client id: " + session.getId() + ": " + message);
        for (Session client : clients) {
            if (!client.getId().equals(session.getId())) {
                client.getBasicRemote().sendText(message);
            }
        }
    }

    @OnClose
    public void onClose(Session session) {
        clients.remove(session);
        System.out.println("Connection closed with client id: " + session.getId());
    }

    @OnError
    public void onError(Session session, Throwable throwable) {
        System.out.println("Error from client id: " + session.getId());
        throwable.printStackTrace();
    }
}

其他地方和上面的一样。

六、实际开发可能需要考虑的相关问题

1、处理客户端断网的策略。

心跳检测：定期发送心跳消息以确保连接的有效性。
超时处理：在特定时间内未收到客户端的消息或心跳回应时关闭连接。
异常处理：捕获并处理连接异常，如断网错误。
2、连接管理

连接断开和重连：客户端可能会由于网络波动、服务器重启等原因导致连接断开。需要实现自动重连机制。
解决方案：客户端实现自动重连，服务器端实现连接状态的监控和重连处理。
连接数量限制：服务器可能会面临大量的并发连接，需要管理连接的生命周期。
解决方案：使用连接池、限制单个用户的最大连接数、负载均衡。
3、数据传输

消息顺序：WebSocket 是全双工通信，消息可能会乱序到达。

解决方案：在消息中添加序列号，客户端根据序列号重排消息。

消息大小：某些应用可能需要传输大数据，WebSocket 本身对消息大小有一定限制。

解决方案：将大消息分割成小块发送，在客户端重新组装。
4、安全性

数据加密：WebSocket 传输的数据可以被中间人截获。

解决方案：使用 wss:// 协议（基于 TLS 加密的 WebSocket）确保传输安全。

身份验证和授权：需要确保只有经过认证和授权的客户端才能建立 WebSocket 连接。

解决方案：在握手阶段进行身份验证，使用 JWT 或其他令牌机制。

跨站脚本攻击 (XSS)：WebSocket 可能成为 XSS 攻击的目标。

解决方案：在服务器端验证和过滤输入数据，确保数据格式和内容安全。
5、性能优化

延迟：需要尽量减少消息传输的延迟。

解决方案：优化网络路径、使用更快的服务器、减少数据量。

带宽消耗：频繁的消息传输会消耗大量带宽。

解决方案：压缩消息、优化数据结构。
6、服务器架构

扩展性：需要确保 WebSocket 服务器能处理大量并发连接。

解决方案：使用集群和负载均衡，将连接分配到多个服务器上。

高可用性：需要确保服务器在出现故障时能迅速恢复。

解决方案：使用容错和故障转移机制，配置多个冗余服务器。

本站资源均来自互联网，仅供研究学习，禁止违法使用和商用，产生法律纠纷本站概不负责！如果侵犯了您的权益请与我们联系！

转载请注明出处：免费源码网-免费的源码资源网站 » WebSocket 详解--spring boot简单使用案例

点赞(0) 打赏

本文分类：文章资讯
本文标签：WebSocket 详解--spring boot简单使用案例
浏览次数：52 次浏览
本文链接：https://freeymw.com/article/13127.html

上一篇 > 在无线网中 2.4G、5G、WiFi6、WiFi7 都是什么意思？
下一篇 > Linux环境编程基础学习2

评论列表共有 0 条评论

暂无评论

WebSocket 详解--spring boot简单使用案例

一、什么是WebSocket

二、WebSocket 的关键特性

三、WebSocket 工作原理

四、WebSocket 应用场景

五、WebSocket简单使用案例——java为例

1、为了方便部署，直接创建一个spring boot项目

2. 编写 WebSocket 服务器端点

2.1 创建 WebSocket 配置类

2.2 创建 WebSocket 处理器

3. 创建 WebSocket 客户端

4. 运行 Spring Boot 应用程序

5. 测试 WebSocket

6、效果展示

7、注解的写法

六、实际开发可能需要考虑的相关问题

1、处理客户端断网的策略。

2、连接管理

3、数据传输

4、安全性

5、性能优化

6、服务器架构

评论列表 共有 0 条评论

发表评论 取消回复

评论列表共有 0 条评论

发表评论取消回复