WebSocket(java版)服务示例

说明：

这是一个使用 Java JDK 8 和 Spring Boot 实现的WebSocket演示项目。目的是为解决多端消息通讯的问题。

WebSocket 是一种基于 TCP 的全双工通信协议 ，核心作用是解决传统 HTTP 协议 "请求 - 响应" 模式的局限性，实现 客户端与服务器之间的实时、双向、低延迟数据传输。

源码地址：https://gitee.com/lqh4188/web-socket

一、功能介绍

功能特性：

基于 Maven 的 Spring Boot 项目骨架。
纯 WebSocket 端点 /ws ，支持用户隔离，http:使用ws，https:使用wss。
支持分片设置和缓冲区大小设置，解决传输内容限制
提供静态测试页面 index.html ，用于连接、发送消息、查看消息。

项目结构：

pom.xml ：Spring Boot 3.3，依赖 spring-boot-starter-web 和 spring-boot-starter-websocket 。
src/main/java/com/example/websocket/WebSocketApplication.java ：应用入口。
src/main/java/com/example/websocket/WebSocketConfig.java ：注册 WebSocket 处理器，端点为 /ws 。
src/main/java/com/example/websocket/ChatWebSocketHandler.java ：文本消息处理，广播到所有会话。
src/main/resources/static/index.html ：页面内置 JS，连接 ws://{host}/ws ，可发送、显示消息。

关键代码位置

启动类： src/main/java/com/example/websocket/WebSocketApplication.java:1
WebSocket 配置： src/main/java/com/example/websocket/WebSocketConfig.java:1
文本消息处理器： src/main/java/com/example/websocket/ChatWebSocketHandler.java:1
静态页面： src/main/resources/static/index.html:1

测试连接

打开 http://localhost:8800 ，使用页面上的"连接/发送"测试
WebSocket 地址： ws://localhost:8080/ws

二、运行测试

可通过UserId来创建独立的联接，进行用户隔离

三、核心代码说明

由于websocket对传输的内容有限制，若内容较大可进行缓冲区大小设置，并对不同文本进行分片处理

ChatWebSocketHandler.java代码：

java 复制代码

package com.example.websocket;
import java.io.ByteArrayOutputStream;
import java.net.URI;
import java.nio.ByteBuffer;
import java.nio.charset.StandardCharsets;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.ConcurrentHashMap;

import org.springframework.web.socket.BinaryMessage;
import org.springframework.web.socket.CloseStatus;
import org.springframework.web.socket.TextMessage;
import org.springframework.web.socket.WebSocketSession;
import org.springframework.web.socket.handler.AbstractWebSocketHandler;
import com.fasterxml.jackson.databind.ObjectMapper;

public class ChatWebSocketHandler extends AbstractWebSocketHandler {
    private final ConcurrentHashMap<String, Set<WebSocketSession>> userSessions = new ConcurrentHashMap<>();
    private static final ObjectMapper MAPPER = new ObjectMapper();
    private final ConcurrentHashMap<String, StringBuilder> textFragments = new ConcurrentHashMap<>();
    private final ConcurrentHashMap<String, ByteArrayOutputStream> binaryFragments = new ConcurrentHashMap<>();

    @Override
    public void afterConnectionEstablished(WebSocketSession session) throws Exception {
        // 验证用户ID的有效性
        String uid = resolveUserId(session);
        if (uid == null || uid.isEmpty()) {
            session.close(CloseStatus.BAD_DATA);
            return;
        }
        session.getAttributes().put("userId", uid);
        //多会话管理
        userSessions.computeIfAbsent(uid, k -> ConcurrentHashMap.newKeySet()).add(session);
    }

    @Override
    protected void handleTextMessage(WebSocketSession session, TextMessage message) throws Exception {
        // 分片处理
        String id = session.getId();
        if (!message.isLast()) {
            textFragments.computeIfAbsent(id, k -> new StringBuilder()).append(message.getPayload());
            return;
        }
        StringBuilder sb = textFragments.remove(id);
        String payload = sb != null ? sb.append(message.getPayload()).toString() : message.getPayload();
        routePayload(session, payload);
    }

    @Override
    protected void handleBinaryMessage(WebSocketSession session, BinaryMessage message) throws Exception {
        //二进制消息处理
        String id = session.getId();
        ByteBuffer buf = message.getPayload();
        byte[] chunk = new byte[buf.remaining()];
        buf.get(chunk);
        ByteArrayOutputStream acc = binaryFragments.computeIfAbsent(id, k -> new ByteArrayOutputStream());
        acc.write(chunk);
        if (message.isLast()) {
            byte[] all = acc.toByteArray();
            binaryFragments.remove(id);
            String payload = new String(all, StandardCharsets.UTF_8);
            routePayload(session, payload);
        }
    }

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

    @Override
    public void afterConnectionClosed(WebSocketSession session, CloseStatus status) throws Exception {
        //  WebSocket 连接关闭时的清理逻辑
        Object v = session.getAttributes().get("userId");
        if (v == null) return;
        String uid = String.valueOf(v);
        Set<WebSocketSession> set = userSessions.get(uid);
        if (set != null) {
            set.remove(session);
            if (set.isEmpty()) userSessions.remove(uid);
        }
    }

    /** 从 WebSocket 连接的 URL 查询参数中提取用户ID */
    private String resolveUserId(WebSocketSession session) {
        URI uri = session.getUri();
        if (uri == null) return null;
        String q = uri.getQuery();
        if (q == null || q.isEmpty()) return null;
        String[] parts = q.split("&");
        for (String p : parts) {
            int i = p.indexOf('=');
            if (i > 0) {
                String k = p.substring(0, i);
                String val = p.substring(i + 1);
                if ("userId".equals(k)) return val;
            }
        }
        return null;
    }

    private void routePayload(WebSocketSession session, String payload) throws Exception {
        Object v = session.getAttributes().get("userId");
        if (v == null) return;
        String fromUid = String.valueOf(v);

        // 解析消息
        Message message = new Message();
        message.setFromUserId(fromUid);
        
        try {
            // 尝试将payload解析为Message对象
            Message receivedMsg = MAPPER.readValue(payload, Message.class);
            message.setToUserId(receivedMsg.getToUserId());
            message.setContent(receivedMsg.getContent());
            message.setType(receivedMsg.getType());
        } catch (Exception e) {
            // 如果解析失败，将整个payload作为content
            message.setContent(payload);
        }

        String toUid = message.getToUserId();
        boolean isP2P = toUid != null && !toUid.isEmpty();
        
        Set<WebSocketSession> targets;
        if (isP2P) {
            targets = userSessions.get(toUid);
        } else {
            targets = userSessions.get(fromUid);
        }
        
        // 序列化消息对象
        String outStr = MAPPER.writeValueAsString(message);
        TextMessage msg = new TextMessage(outStr);
        
        if (targets == null || targets.isEmpty()) {
            if (session.isOpen()) {
                session.sendMessage(msg);
            }
            return;
        }

        for (WebSocketSession s : targets) {
            if (s.isOpen()) {
                s.sendMessage(msg);
            }
        }
        if (isP2P && session.isOpen()) {
            session.sendMessage(msg);
        }
    }
}

配置类WebSocketConfig.java

java 复制代码

package com.example.websocket;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.socket.WebSocketHandler;
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.ServletServerContainerFactoryBean;

@Configuration
@EnableWebSocket
public class WebSocketConfig implements WebSocketConfigurer {
    @Override
    public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
        registry.addHandler(chatHandler(), "/ws").setAllowedOriginPatterns("*");
    }

    @Bean
    public WebSocketHandler chatHandler() {
        return new ChatWebSocketHandler();
    }

    // 配置 WebSocket 容器参数（解决消息过大、超时等问题）
    @Bean
    public ServletServerContainerFactoryBean createWebSocketContainer() {
        ServletServerContainerFactoryBean container = new ServletServerContainerFactoryBean();
        // 文本消息缓冲区：2MB（解决解码后消息过大的核心配置）
        container.setMaxTextMessageBufferSize(2 * 1024 * 1024);
        // 二进制消息缓冲区：4MB（按需配置）
        container.setMaxBinaryMessageBufferSize(4 * 1024 * 1024);
        // 会话空闲超时：60秒（无交互则关闭连接）
        container.setMaxSessionIdleTimeout(60_000L);
        return container;
    }
}