如何使用 Spring Boot 搭建 WebSocket 服务器实现多客户端连接

更新时间：2024年11月06日 10:31:32 作者：不掉头发的阿水

本文介绍如何使用SpringBoot快速搭建WebSocket服务器,实现多客户端连接和消息广播,WebSocket协议提供全双工通信,SpringBoot通过@ServerEndpoint简化配置,支持实时消息推送,适用于聊天室或通知系统等应用场景

1. WebSocket 简介

WebSocket 是 HTML5 的一种协议，提供了客户端和服务器之间的全双工通信。通过 WebSocket，客户端可以与服务器进行持续连接，不用反复建立 HTTP 请求，从而降低延迟，提升通信效率。

为什么选择 Spring Boot 实现 WebSocket？

Spring Boot 简化了 WebSocket 服务器的配置与实现，使我们可以更专注于业务逻辑开发，且配合 @ServerEndpoint 注解实现更加清晰。

2. 项目环境与依赖配置

项目环境

Java 版本：JDK 8+
Spring Boot 版本：2.x
WebSocket 依赖：spring-boot-starter-websocket

Maven 依赖

在 pom.xml 文件中添加 WebSocket 的依赖：

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

3. WebSocket 服务端代码实现

在 Spring Boot 中，我们可以使用 @ServerEndpoint 注解创建 WebSocket 服务器端。以下是一个支持多客户端连接的 WebSocket 实现。

WebSocket 服务端代码解析

创建 MultiClientWebSocket 类，并实现以下功能：

记录当前在线客户端数
支持客户端连接、断开、消息接收、群发等功能
通过 @OnOpen、@OnMessage、@OnClose、@OnError 注解处理连接的各个生命周期

完整代码如下：

import lombok.extern.slf4j.Slf4j;
import org.springframework.context.annotation.Bean;
import org.springframework.stereotype.Component;
import org.springframework.web.socket.server.standard.ServerEndpointExporter;
import javax.websocket.*;
import javax.websocket.server.ServerEndpoint;
import java.io.IOException;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.atomic.AtomicInteger;
/**
 * WebSocketConfig
 */
@Component
@ServerEndpoint("/ws/multi")
@Slf4j
public class MultiClientWebSocket {
    @Bean
    public ServerEndpointExporter serverEndpointExporter() {
        log.info("WebSocketConfig: serverEndpointExporter init WebSocketConfig 注入完成");
        return new ServerEndpointExporter();
    }
    /**
     * 记录当前在线连接数
     */
    private static final AtomicInteger onlineCount = new AtomicInteger(0);
    /**
     * 存放所有在线的客户端
     */
    private static final Map<String, Session> onlineClients = new ConcurrentHashMap<>();
    @OnOpen
    public void onOpen(Session session) {
        onlineCount.incrementAndGet();
        onlineClients.put(session.getId(), session);
        log.info("有新连接加入：{}，当前在线客户端数为：{}", session.getId(), onlineCount.get());
    }
    @OnMessage
    public void onMessage(String message, Session session) throws IOException {
        System.out.println("收到客户端消息：" + message);
        session.getBasicRemote().sendText("服务器收到消息：" + message);
    }
    @OnClose
    public void onClose(Session session) {
        onlineCount.decrementAndGet(); // 在线数减1
        onlineClients.remove(session.getId());
        log.info("有一连接关闭：{}，当前在线客户端数为：{}", session.getId(), onlineCount.get());
    }
    @OnError
    public void onError(Throwable t) {
        log.error("WebSocket 连接出错{}", t.getMessage());
    }
    /**
     * 群发消息
     *
     * @param message 消息内容
     */
    public void sendMessage(String message) {
        //log.info("开始给在线的客户端{}群发消息{}",onlineClients,message);
        for (Map.Entry<String, Session> sessionEntry : onlineClients.entrySet()) {
            Session toSession = sessionEntry.getValue();
            log.info("服务端给客户端[{}]发送消息{}", toSession.getId(), message);
            toSession.getAsyncRemote().sendText(message);
        }
    }
}

代码解析

ServerEndpointExporter：Spring Boot 的 WebSocket 配置类，自动注册 @ServerEndpoint 注解声明的 WebSocket。
在线客户端管理：使用 ConcurrentHashMap 存储在线客户端的 Session，通过 AtomicInteger 记录当前连接数。
生命周期注解：
- @OnOpen：当客户端连接时触发，增加在线人数。
- @OnMessage：当收到消息时触发，服务端处理消息。
- @OnClose：当连接关闭时触发，减少在线人数。
- @OnError：当连接出错时触发，记录错误日志。
群发消息：sendMessage 方法遍历所有在线客户端的 Session，实现消息广播。

4. 启动与测试

启动 Spring Boot 项目后，WebSocket 服务端地址为：ws://localhost:8080/ws/multi。可以使用 WebSocket 测试工具（例如 Apifox或浏览器控制台）测试 WebSocket 通信。

测试步骤

连接 WebSocket：客户端连接至 ws://localhost:8080/ws/multi。
发送消息：客户端发送消息，服务端接收到消息后回复。
断开连接：客户端断开连接，服务端记录连接关闭信息。

import cn.hutool.json.JSONUtil;
import com.google.common.collect.Lists;
import com.lps.config.MultiClientWebSocket;
import com.lps.domain.R;
import lombok.RequiredArgsConstructor;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import java.util.List;
/**
 * @ClassName: WebSocketControl
 * @Description:
 * @Author: liu
 * @Date: 2024-10-30
 * @Version: 1.0
 **/
@RestController
@RequestMapping("/webSocket")
@RequiredArgsConstructor
public class WebSocketControl {
    private final MultiClientWebSocket multiClientWebSocket;
    @GetMapping("/sendList")
    public R<String> sad() {
        //Guava依赖
        List<String> strList = Lists.newArrayList("发送", "WebSocket消息","测试");
        String jsonStr = JSONUtil.toJsonStr(strList);
        multiClientWebSocket.sendMessage(jsonStr);
        return R.ok(jsonStr);
    }
}

前端测试demo

<!DOCTYPE html>
<html>
<head>
    <meta charset="UTF-8">
    <title>WebSocket Demo</title>
    <style>
        #status {
            margin-bottom: 10px;
        }
    </style>
    <script>
        let ws;
		function connectWebSocket() {
			// 检查 WebSocket 是否已连接
			if (ws && ws.readyState === WebSocket.OPEN) {
				console.log('WebSocket 已连接，无需重复连接。');
				return;
			}
			ws = new WebSocket('ws://localhost:8080/ws/multi');
			ws.onopen = function() {
				console.log('WebSocket 连接已经建立。');
				document.getElementById('status').innerText = 'WebSocket 连接已建立。';
				ws.send('Hello, server!');
			};
			ws.onmessage = function(event) {
				console.log('收到服务器消息：', event.data);
				document.getElementById('messages').innerText += '收到消息：' + event.data + '\n';
			};
			ws.onerror = function(event) {
				console.error('WebSocket 连接出现错误：', event);
				document.getElementById('status').innerText = 'WebSocket 连接出现错误。';
			};
			ws.onclose = function() {
				console.log('WebSocket 连接已经关闭。');
				document.getElementById('status').innerText = 'WebSocket 连接已关闭。';
				ws = null; // 连接关闭后将 ws 设置为 null，以便重新连接
			};
		}
        function disconnectWebSocket() {
            if (ws) {
                ws.close();
            }
        }
    </script>
</head>
<body>
    <h1>WebSocket Demo</h1>
    <div id="status">WebSocket 连接状态</div>
    <button onclick="connectWebSocket()">连接 WebSocket</button>
    <button onclick="disconnectWebSocket()">断开 WebSocket</button>
    <pre id="messages"></pre>
</body>
</html>

5. 总结

通过以上代码示例，我们可以实现一个简单的 WebSocket 服务端，支持多客户端连接和消息广播。此 WebSocket 服务端适用于需要实时消息推送的应用场景，比如聊天室、实时通知系统等。

到此这篇关于使用 Spring Boot 搭建 WebSocket 服务器实现多客户端连接的文章就介绍到这了,更多相关Spring Boot 搭建 WebSocket 服务器内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

java中的动态代理与责任链模式详解
这篇文章主要介绍了java中的动态代理与责任链模式详解,动态代理提供了一种灵活且非侵入式的方式,可以对对象的行为进行定制和扩展,它在代码重用、解耦和业务逻辑分离、性能优化以及系统架构中起到了重要的作用,需要的朋友可以参考下
2023-08-08
java8学习教程之lambda表达式的使用方法
Java8最值得学习的特性就是Lambda表达式，下面这篇文章主要给大家介绍了关于java8学习教程之lambda表达式使用的相关资料，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧。
2017-09-09
Java编程之文件读写实例详解
这篇文章主要介绍了Java编程之文件读写的方法,结合实例形式较为详细的分析了Java文件读写所涉及的类及相应的操作技巧,需要的朋友可以参考下
2015-12-12
解决JDK异常处理No appropriate protocol问题
这篇文章主要介绍了解决JDK异常处理No appropriate protocol问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
2024-06-06
javaSE中异常如何处理举例详解
程序运行过程中发生了不正常的情况,这种不正常的情况叫做异常,下面这篇文章主要给大家介绍了关于javaSE中异常如何处理的相关资料,文中通过实例代码介绍的非常详细,需要的朋友可以参考下
2023-01-01
MybatisPlus更新时部分失败的问题解决
这篇文章主要为大家详细介绍了MybatisPlus更新时部分失败的问题分析和解决方法，文中的代码示例讲解的非常详细,需要的朋友可以参考下
2023-06-06
深入解析HashMap的put方法
在Java集合中，HashMap的重要性不言而喻，作为一种存储键值对的数据结构，它在日常开发中有着非常多的应用场景，也是面试中的高频考点，本篇文章就来分析一下HashMap集合中的put方法
2022-01-01
SpringBoot注解@EnableScheduling定时任务详细解析
这篇文章主要介绍了SpringBoot注解@EnableScheduling定时任务详细解析,@EnableScheduling 开启对定时任务的支持,启动类里面使用@EnableScheduling 注解开启功能,自动扫描,需要的朋友可以参考下
2024-01-01
JAVA时间存储类Period和Duration使用详解
这篇文章主要为大家介绍了JAVA时间存储类Period和Duration使用详解，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪
2022-09-09
java socket长连接中解决read阻塞的3个办法
这篇文章主要介绍了java socket长连接中解决read阻塞的3个办法,本文取了折中的一个方法,并给出代码实例,需要的朋友可以参考下
2014-08-08