详解基于SpringBoot的WebSocket应用开发

在现代Web应用中，实时交互和数据推送的需求日益增长。WebSocket协议作为一种全双工通信协议，允许服务端与客户端之间建立持久性的连接，实现实时、双向的数据传输，极大地提升了用户体验。本文将详细介绍如何在Spring Boot框架中使用WebSocket进行高效、稳定的实时通信。

WebSocket简介

WebSocket是一种在单个TCP连接上进行全双工通信的协议，其最大的特点是服务器可以主动向客户端发送消息，而不需要客户端先发起请求。相较于传统的HTTP长轮询或轮询机制，WebSocket能有效减少不必要的网络通信开销，并提供更优的实时性。

SpringBoot集成WebSocket

添加依赖

首先，在Spring Boot项目中引入WebSocket支持。在pom.xml文件中添加如下依赖：

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

创建WebSocket配置类

创建一个WebSocket配置类，通过WebSocketConfigurer接口来自定义WebSocket处理逻辑。例如：

@Configuration
@EnableWebSocket
public class WebSocketConfig implements WebSocketConfigurer {

    @Override
    public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
        // 注册WebSocket处理器，指定访问路径
        registry.addHandler(myWebSocketHandler(), "/webSocket/{sid}");
    }

    @Bean
    public WebSocketHandler myWebSocketHandler() {
        return new MyWebSocketHandler();
    }
}

实现WebSocket处理器

创建一个实现WebSocketHandler接口的类，如MyWebSocketHandler，并重写其中的方法以处理WebSocket的生命周期事件（如打开、关闭、接收消息等）：

@Component
public class MyWebSocketHandler implements WebSocketHandler {

    private static final CopyOnWriteArraySet<MyWebSocketHandler> webSocketSet = new CopyOnWriteArraySet<>();

    private Session session;
    private String sid;

    @Override
    public void afterConnectionEstablished(Session session) throws Exception {
        this.session = session;
        sid = session.getAttributes().get("sid").toString();
        webSocketSet.add(this);
        log.info("WebSocket连接已建立, sid: {}", sid);
    }

    @Override
    public void handleMessage(String message, Session session) throws IOException {
        log.info("接收到{}的信息: {}", sid, message);
        // 群发消息或其他处理逻辑
        for (MyWebSocketHandler item : webSocketSet) {
            try {
                if (item.sid.equals(sid)) {
                    item.sendMessage(message);
                }
            } catch (IOException e) {
                log.error("发送消息时发生错误", e);
            }
        }
    }

    @Override
    public void handleTransportError(Throwable exception, Session session) {
        if (session.isOpen()) {
            session.close();
        }
        webSocketSet.remove(this);
        log.error("WebSocket连接发生错误", exception);
    }

    @Override
    public void afterConnectionClosed(Session session, CloseStatus status) {
        webSocketSet.remove(this);
        log.info("WebSocket连接已关闭, sid: {}, 原因: {}", sid, status.getReason());
    }

    @Override
    public boolean supportsPartialMessages() {
        return false;
    }

    private void sendMessage(String message) throws IOException {
        session.getBasicRemote().sendText(message);
    }
    
    // 可以增加根据sid筛选的消息推送方法
    public static void sendInfo(SocketMsg socketMsg, String targetSid) throws IOException {
        // ...
    }
}

客户端连接WebSocket

在前端JavaScript代码中使用WebSocket API与后端建立连接，并处理各种事件：

var ws = new WebSocket('ws://localhost:8080/webSocket/' + uniqueSessionId);

ws.onopen = function(event) {
    console.log('WebSocket连接已建立');
};

ws.onmessage = function(event) {
    console.log('接收到服务器消息：', event.data);
};

ws.onerror = function(error) {
    console.error('WebSocket连接发生错误：', error);
};

ws.onclose = function(event) {
    console.log('WebSocket连接已关闭，原因：', event.reason);
};

// 发送消息到服务器
ws.send(JSON.stringify({message: 'Hello, Server!'}));

总结

通过上述步骤，我们已经在Spring Boot项目中成功实现了WebSocket功能。需要注意的是，实际应用场景中可能需要对用户权限、连接管理、消息队列、心跳检测等功能进行更细致的设计与实现，以确保WebSocket服务的稳定性和性能表现。同时，WebSocket技术的应用场景非常广泛，包括但不限于即时聊天、在线协作、实时监控等。

原文地址：https://www.toutiao.com/article/7329888313568657970/