如何使用Spring Boot实现WebSocket通信

news2024/7/6 19:32:13

如何使用Spring Boot实现WebSocket通信

大家好，我是免费搭建查券返利机器人省钱赚佣金就用微赚淘客系统3.0的小编，也是冬天不穿秋裤，天冷也要风度的程序猿！今天我们将探讨如何利用Spring Boot实现WebSocket通信，实现实时的双向数据传输和即时通讯功能。

什么是WebSocket？

WebSocket是一种在单个TCP连接上进行全双工通信的协议，它使得客户端和服务器之间的数据交换变得更加简单和高效。在实时应用程序中，如聊天应用、实时数据展示等，WebSocket能够提供更快速、更即时的数据传输和响应。

在Spring Boot中实现WebSocket

步骤一：添加WebSocket依赖

首先，在pom.xml文件中添加Spring Boot集成WebSocket的依赖：

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

步骤二：创建WebSocket处理器

定义一个WebSocket处理器来处理WebSocket连接、消息发送和接收等操作。示例代码如下：

package cn.juwatech.websocket;

import org.springframework.stereotype.Component;
import org.springframework.web.socket.config.annotation.EnableWebSocket;
import org.springframework.web.socket.config.annotation.WebSocketConfigurer;
import org.springframework.web.socket.config.annotation.WebSocketHandlerRegistry;
import org.springframework.web.socket.server.standard.ServerEndpointExporter;

@Component
@EnableWebSocket
public class WebSocketConfig implements WebSocketConfigurer {

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

}

package cn.juwatech.websocket;

import org.springframework.stereotype.Component;
import org.springframework.web.socket.WebSocketSession;
import org.springframework.web.socket.handler.TextWebSocketHandler;

@Component
public class MyWebSocketHandler extends TextWebSocketHandler {

    @Override
    public void afterConnectionEstablished(WebSocketSession session) throws Exception {
        // 新连接建立时调用
        System.out.println("WebSocket连接已建立");
    }

    @Override
    protected void handleTextMessage(WebSocketSession session, TextMessage message) throws Exception {
        // 收到消息时调用
        System.out.println("接收到消息：" + message.getPayload());
        // 处理消息并发送响应
        session.sendMessage(new TextMessage("收到消息：" + message.getPayload()));
    }

    @Override
    public void afterConnectionClosed(WebSocketSession session, CloseStatus status) throws Exception {
        // 连接关闭时调用
        System.out.println("WebSocket连接已关闭");
    }
}

步骤三：编写前端页面与WebSocket交互

在前端页面中使用JavaScript来建立WebSocket连接，并发送和接收消息。示例代码如下：

<!DOCTYPE html>
<html>
<head>
    <title>WebSocket示例</title>
    <script type="text/javascript">
        var socket = new WebSocket("ws://localhost:8080/my-websocket");

        socket.onopen = function() {
            console.log("WebSocket连接已建立");
            socket.send("Hello, WebSocket!");
        };

        socket.onmessage = function(event) {
            console.log("接收到消息：" + event.data);
        };

        socket.onclose = function(event) {
            console.log("WebSocket连接已关闭");
        };
    </script>
</head>
<body>
    <h1>WebSocket示例</h1>
    <p>查看控制台输出来查看WebSocket通信过程。</p>
</body>
</html>