若依框架（RuoYi）是一个基于Spring Boot和Spring Cloud的快速开发平台，因其简洁、高效的特点而备受开发者青睐。在实际项目中，实时通信需求非常常见，例如在线聊天、消息推送、状态同步等场景。通过整合WebSocket技术，可以实现高效的双向通信功能。本文将详细介绍如何在若依框架中整合WebSocket，以实现实时通信功能。
WebSocket是一种在单个TCP连接上进行全双工通信的协议。与传统的HTTP请求-响应模式不同，WebSocket允许服务器主动向客户端推送数据，从而实现了真正的实时通信。
在若依项目的pom.xml文件中添加WebSocket相关的依赖：
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-websocket</artifactId>
</dependency>
创建一个WebSocket配置类，用于定义WebSocket的端点和行为。
import org.springframework.context.annotation.Configuration;
import org.springframework.web.socket.config.annotation.EnableWebSocket;
import org.springframework.web.socket.config.annotation.WebSocketConfigurer;
import org.springframework.web.socket.config.annotation.WebSocketHandlerRegistry;
@Configuration
@EnableWebSocket
public class WebSocketConfig implements WebSocketConfigurer {
@Override
public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
// 注册WebSocket处理器，并设置跨域支持
registry.addHandler(new MyWebSocketHandler(), "/ws").setAllowedOrigins("*");
}
}
实现WebSocketHandler接口，处理WebSocket的生命周期事件（如连接、消息接收、断开等）。
import org.springframework.web.socket.TextMessage;
import org.springframework.web.socket.WebSocketSession;
import org.springframework.web.socket.handler.TextWebSocketHandler;
import java.io.IOException;
import java.util.concurrent.CopyOnWriteArraySet;
public class MyWebSocketHandler extends TextWebSocketHandler {
// 存储所有连接的客户端
private static final CopyOnWriteArraySet<WebSocketSession> sessions = new CopyOnWriteArraySet<>();
@Override
public void afterConnectionEstablished(WebSocketSession session) throws Exception {
// 当新客户端连接时，将其加入集合
sessions.add(session);
System.out.println("新客户端连接：" + session.getId());
}
@Override
protected void handleTextMessage(WebSocketSession session, TextMessage message) throws Exception {
// 处理接收到的消息
String payload = message.getPayload();
System.out.println("收到消息：" + payload);
// 广播消息给所有客户端
broadcastMessage(payload);
}
@Override
public void afterConnectionClosed(WebSocketSession session, CloseStatus status) throws Exception {
// 当客户端断开连接时，将其移除
sessions.remove(session);
System.out.println("客户端断开：" + session.getId());
}
private void broadcastMessage(String message) {
// 向所有连接的客户端发送消息
for (WebSocketSession session : sessions) {
try {
if (session.isOpen()) {
session.sendMessage(new TextMessage(message));
}
} catch (IOException e) {
e.printStackTrace();
}
}
}
}
以下是一个简单的HTML页面，用于测试WebSocket通信：
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>WebSocket Test</title>
</head>
<body>
<h1>WebSocket 实时通信</h1>
<input type="text" id="messageInput" placeholder="输入消息">
<button onclick="sendMessage()">发送消息</button>
<ul id="messages"></ul>
<script>
const socket = new WebSocket("ws://localhost:8080/ws");
socket.onopen = () => {
console.log("连接已建立");
};
socket.onmessage = (event) => {
const messages = document.getElementById("messages");
const message = document.createElement("li");
message.textContent = event.data;
messages.appendChild(message);
};
socket.onclose = () => {
console.log("连接已关闭");
};
function sendMessage() {
const input = document.getElementById("messageInput");
socket.send(input.value);
input.value = "";
}
</script>
</body>
</html>
为了提高系统的可扩展性和灵活性，可以使用JSON格式来传递消息。例如：
{
"type": "chat",
"content": "Hello, World!",
"sender": "user1"
}
在后端解析JSON消息时，可以使用ObjectMapper工具类：
ObjectMapper objectMapper = new ObjectMapper();
Map<String, Object> map = objectMapper.readValue(payload, Map.class);
String type = (String) map.get("type");
String content = (String) map.get("content");
在实际项目中，通常需要结合用户身份验证机制（如JWT或Session）来确保只有授权用户才能访问WebSocket服务。可以在afterConnectionEstablished方法中检查用户的身份信息。
对于高并发场景，可以引入消息队列（如Kafka或Redis）来解耦WebSocket服务与业务逻辑，提升系统的稳定性和性能。
以下是WebSocket通信的基本流程图：
sequenceDiagram
participant Client as 客户端
participant Server as 服务器
Client->>Server: 打开WebSocket连接
Server-->>Client: 连接成功
Client->>Server: 发送消息
Server-->>Client: 广播消息
Client->>Server: 断开连接