如何使用?Spring?Boot?搭建?WebSocket?服務(wù)器實(shí)現(xiàn)多客戶(hù)端連接
更新時(shí)間：2024年11月06日 10:31:32 作者：不掉頭發(fā)的阿水
本文介紹如何使用SpringBoot快速搭建WebSocket服務(wù)器,實(shí)現(xiàn)多客戶(hù)端連接和消息廣播,WebSocket協(xié)議提供全雙工通信,SpringBoot通過(guò)@ServerEndpoint簡(jiǎn)化配置,支持實(shí)時(shí)消息推送,適用于聊天室或通知系統(tǒng)等應(yīng)用場(chǎng)景
在 Web 開(kāi)發(fā)中，WebSocket 為客戶(hù)端和服務(wù)端之間提供了實(shí)時(shí)雙向通信的能力。本篇博客介紹如何使用 Spring Boot 快速搭建一個(gè) WebSocket 服務(wù)器，并支持多客戶(hù)端的連接和消息廣播。
1. WebSocket 簡(jiǎn)介
WebSocket 是 HTML5 的一種協(xié)議，提供了客戶(hù)端和服務(wù)器之間的全雙工通信。通過(guò) WebSocket，客戶(hù)端可以與服務(wù)器進(jìn)行持續(xù)連接，不用反復(fù)建立 HTTP 請(qǐng)求，從而降低延遲，提升通信效率。
為什么選擇 Spring Boot 實(shí)現(xiàn) WebSocket？
Spring Boot 簡(jiǎn)化了 WebSocket 服務(wù)器的配置與實(shí)現(xiàn)，使我們可以更專(zhuān)注于業(yè)務(wù)邏輯開(kāi)發(fā)，且配合 @ServerEndpoint 注解實(shí)現(xiàn)更加清晰。
2. 項(xiàng)目環(huán)境與依賴(lài)配置
項(xiàng)目環(huán)境
- Java 版本：JDK 8+
- Spring Boot 版本：2.x
- WebSocket 依賴(lài)：
spring-boot-starter-websocket
Maven 依賴(lài)
在 pom.xml 文件中添加 WebSocket 的依賴(lài)：
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-websocket</artifactId>
</dependency>3. WebSocket 服務(wù)端代碼實(shí)現(xiàn)
在 Spring Boot 中，我們可以使用 @ServerEndpoint 注解創(chuàng)建 WebSocket 服務(wù)器端。以下是一個(gè)支持多客戶(hù)端連接的 WebSocket 實(shí)現(xiàn)。
WebSocket 服務(wù)端代碼解析
創(chuàng)建 MultiClientWebSocket 類(lèi)，并實(shí)現(xiàn)以下功能：
- 記錄當(dāng)前在線(xiàn)客戶(hù)端數(shù)
- 支持客戶(hù)端連接、斷開(kāi)、消息接收、群發(fā)等功能
- 通過(guò)
@OnOpen、@OnMessage、@OnClose、@OnError注解處理連接的各個(gè)生命周期
完整代碼如下：
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();
}
/**
* 記錄當(dāng)前在線(xiàn)連接數(shù)
*/
private static final AtomicInteger onlineCount = new AtomicInteger(0);
/**
* 存放所有在線(xiàn)的客戶(hù)端
*/
private static final Map<String, Session> onlineClients = new ConcurrentHashMap<>();
@OnOpen
public void onOpen(Session session) {
onlineCount.incrementAndGet();
onlineClients.put(session.getId(), session);
log.info("有新連接加入：{}，當(dāng)前在線(xiàn)客戶(hù)端數(shù)為：{}", session.getId(), onlineCount.get());
}
@OnMessage
public void onMessage(String message, Session session) throws IOException {
System.out.println("收到客戶(hù)端消息：" + message);
session.getBasicRemote().sendText("服務(wù)器收到消息：" + message);
}
@OnClose
public void onClose(Session session) {
onlineCount.decrementAndGet(); // 在線(xiàn)數(shù)減1
onlineClients.remove(session.getId());
log.info("有一連接關(guān)閉：{}，當(dāng)前在線(xiàn)客戶(hù)端數(shù)為：{}", session.getId(), onlineCount.get());
}
@OnError
public void onError(Throwable t) {
log.error("WebSocket 連接出錯(cuò){}", t.getMessage());
}
/**
* 群發(fā)消息
*
* @param message 消息內(nèi)容
*/
public void sendMessage(String message) {
//log.info("開(kāi)始給在線(xiàn)的客戶(hù)端{(lán)}群發(fā)消息{}",onlineClients,message);
for (Map.Entry<String, Session> sessionEntry : onlineClients.entrySet()) {
Session toSession = sessionEntry.getValue();
log.info("服務(wù)端給客戶(hù)端[{}]發(fā)送消息{}", toSession.getId(), message);
toSession.getAsyncRemote().sendText(message);
}
}
}代碼解析
ServerEndpointExporter：Spring Boot 的 WebSocket 配置類(lèi)，自動(dòng)注冊(cè)@ServerEndpoint注解聲明的 WebSocket。- 在線(xiàn)客戶(hù)端管理：使用
ConcurrentHashMap存儲(chǔ)在線(xiàn)客戶(hù)端的Session，通過(guò)AtomicInteger記錄當(dāng)前連接數(shù)。 - 生命周期注解：
@OnOpen：當(dāng)客戶(hù)端連接時(shí)觸發(fā)，增加在線(xiàn)人數(shù)。@OnMessage：當(dāng)收到消息時(shí)觸發(fā)，服務(wù)端處理消息。@OnClose：當(dāng)連接關(guān)閉時(shí)觸發(fā)，減少在線(xiàn)人數(shù)。@OnError：當(dāng)連接出錯(cuò)時(shí)觸發(fā)，記錄錯(cuò)誤日志。
- 群發(fā)消息：
sendMessage方法遍歷所有在線(xiàn)客戶(hù)端的Session，實(shí)現(xiàn)消息廣播。
4. 啟動(dòng)與測(cè)試
啟動(dòng) Spring Boot 項(xiàng)目后，WebSocket 服務(wù)端地址為：ws://localhost:8080/ws/multi?？梢允褂?WebSocket 測(cè)試工具（例如 Apifox或?yàn)g覽器控制臺(tái)）測(cè)試 WebSocket 通信。
測(cè)試步驟
- 連接 WebSocket：客戶(hù)端連接至
ws://localhost:8080/ws/multi。 - 發(fā)送消息：客戶(hù)端發(fā)送消息，服務(wù)端接收到消息后回復(fù)。
- 斷開(kāi)連接：客戶(hù)端斷開(kāi)連接，服務(wù)端記錄連接關(guān)閉信息。
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依賴(lài)
List<String> strList = Lists.newArrayList("發(fā)送", "WebSocket消息","測(cè)試");
String jsonStr = JSONUtil.toJsonStr(strList);
multiClientWebSocket.sendMessage(jsonStr);
return R.ok(jsonStr);
}
}
前端測(cè)試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 已連接，無(wú)需重復(fù)連接。');
return;
}
ws = new WebSocket('ws://localhost:8080/ws/multi');
ws.onopen = function() {
console.log('WebSocket 連接已經(jīng)建立。');
document.getElementById('status').innerText = 'WebSocket 連接已建立。';
ws.send('Hello, server!');
};
ws.onmessage = function(event) {
console.log('收到服務(wù)器消息：', event.data);
document.getElementById('messages').innerText += '收到消息：' + event.data + '\n';
};
ws.onerror = function(event) {
console.error('WebSocket 連接出現(xiàn)錯(cuò)誤：', event);
document.getElementById('status').innerText = 'WebSocket 連接出現(xiàn)錯(cuò)誤。';
};
ws.onclose = function() {
console.log('WebSocket 連接已經(jīng)關(guān)閉。');
document.getElementById('status').innerText = 'WebSocket 連接已關(guān)閉。';
ws = null; // 連接關(guān)閉后將 ws 設(shè)置為 null，以便重新連接
};
}
function disconnectWebSocket() {
if (ws) {
ws.close();
}
}
</script>
</head>
<body>
<h1>WebSocket Demo</h1>
<div id="status">WebSocket 連接狀態(tài)</div>
<button onclick="connectWebSocket()">連接 WebSocket</button>
<button onclick="disconnectWebSocket()">斷開(kāi) WebSocket</button>
<pre id="messages"></pre>
</body>
</html>5. 總結(jié)
通過(guò)以上代碼示例，我們可以實(shí)現(xiàn)一個(gè)簡(jiǎn)單的 WebSocket 服務(wù)端，支持多客戶(hù)端連接和消息廣播。此 WebSocket 服務(wù)端適用于需要實(shí)時(shí)消息推送的應(yīng)用場(chǎng)景，比如聊天室、實(shí)時(shí)通知系統(tǒng)等。
到此這篇關(guān)于使用 Spring Boot 搭建 WebSocket 服務(wù)器實(shí)現(xiàn)多客戶(hù)端連接的文章就介紹到這了,更多相關(guān)Spring Boot 搭建 WebSocket 服務(wù)器內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！
相關(guān)文章
詳解Java中l(wèi)og4j.properties配置與加載應(yīng)用
這篇文章主要介紹了 log4j.properties配置與加載應(yīng)用的相關(guān)資料,需要的朋友可以參考下2018-02-02
大家都知道Map是一種以鍵值對(duì)的形式存在的集合,其中每個(gè)鍵映射到一個(gè)值，下面把Map遍歷集合總結(jié)了一下給大家分享下,需要的朋友可以參考下2015-07-07
這篇文章主要介紹了Java 中 Map 集合的三種遍歷方式,每種遍歷方式結(jié)合示例代碼給大家介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值，需要的朋友可以參考下2022-12-12
這篇文章主要給大家介紹了關(guān)于JDK更換IDEA如何修改的相關(guān)資料,Java的不同版本的JDK之間存在細(xì)微的差別,文中通過(guò)圖文介紹的非常詳細(xì),需要的朋友可以參考下2023-07-07
Java實(shí)現(xiàn)簡(jiǎn)易界面通訊錄
這篇文章主要為大家詳細(xì)介紹了Java實(shí)現(xiàn)簡(jiǎn)易界面通訊錄，文中示例代碼介紹的非常詳細(xì)，具有一定的參考價(jià)值，感興趣的小伙伴們可以參考一下2022-04-04
本篇文章主要介紹了詳解SpringMVC解決跨域的兩種方案，小編覺(jué)得挺不錯(cuò)的，現(xiàn)在分享給大家，也給大家做個(gè)參考。一起跟隨小編過(guò)來(lái)看看吧2017-08-08
這篇文章主要介紹了springboot之配置雙kafka全過(guò)程，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教2023-04-04
SpringBoot+Redis?BitMap實(shí)現(xiàn)簽到與統(tǒng)計(jì)的項(xiàng)目實(shí)踐
最近項(xiàng)目里需要集成簽到和統(tǒng)計(jì)功能，連續(xù)簽到后會(huì)給用戶(hù)發(fā)放一些優(yōu)惠券和獎(jiǎng)品，以此來(lái)吸引用戶(hù)持續(xù)在該品臺(tái)進(jìn)行活躍，本文就詳細(xì)的介紹一下如何實(shí)現(xiàn)，感興趣的可以了解一下2023-09-09
這篇文章主要為大家詳細(xì)介紹了java利用Calendar類(lèi)打印日歷，文中示例代碼介紹的非常詳細(xì)，具有一定的參考價(jià)值，感興趣的小伙伴們可以參考一下2019-07-07
SpringBoot中整合JodConverter實(shí)現(xiàn)文件在線(xiàn)預(yù)覽功能
Spring Boot JodConverter是一個(gè)基于Spring Boot框架的文檔轉(zhuǎn)換工具,它使用JodConverter庫(kù)來(lái)實(shí)現(xiàn)文檔格式之間的轉(zhuǎn)換,本文主要介紹了SpringBoot中整合JodConverter實(shí)現(xiàn)文件在線(xiàn)預(yù)覽功能,需要的朋友可以參考下2024-04-04