使用Spring Boot和WebSocket实现实时聊天功能

使用Spring Boot和WebSocket实现实时聊天功能

本文将介绍如何使用Spring Boot和WebSocket来实现一个简单的实时聊天功能。在这个示例中，我们将创建一个WebSocket服务器，用于处理客户端的连接、关闭、发送消息等操作。

1. 引入WebSocket依赖

首先，我们需要在项目中引入WebSocket的依赖。在pom.xml文件中添加以下依赖：

<dependency>
    <groupId>org.springframework.bootgroupId>
    <artifactId>spring-boot-starter-websocketartifactId>
dependency>

2. 配置WebSocket （WebSocketConfig.java）

接下来，我们创建一个WebSocketConfig类，用于配置WebSocket。在这个类中，我们需要注入一个ServerEndpointExporter，该Bean会自动注册使用@ServerEndpoint注解申明的websocket endpoint。

package com.ruoyi.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.socket.server.standard.ServerEndpointExporter;

@Configuration
public class WebSocketConfig {
   
    /**
     * 注入一个ServerEndpointExporter,该Bean会自动注册使用@ServerEndpoint注解申明的websocket endpoint
     */
    @Bean
    public ServerEndpointExporter serverEndpointExporter() {
   
        return new ServerEndpointExporter();
    }
}

3. 创建WebSocket服务器

然后，我们创建一个WebSocketServer类，用于处理客户端的连接、关闭、发送消息等操作。在这个类中，我们使用了@ServerEndpoint注解来声明一个WebSocket服务器端点，并使用@OnOpen、@OnClose、@OnMessage等注解来处理不同的WebSocket事件。

package com.ruoyi.component;

import cn.hutool.json.JSONArray;
import cn.hutool.json.JSONObject;
import cn.hutool.json.JSONUtil;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;
import javax.websocket.*;
import javax.websocket.server.PathParam;
import javax.websocket.server.ServerEndpoint;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;

/**
 * @author websocket服务
 */
@ServerEndpoint(value = "/imserver/{username}")
@Component
public class WebSocketServer {
   
    private static final Logger log = LoggerFactory.getLogger(WebSocketServer.class);
    /**
     * 记录当前在线连接数
     */
    public static final Map<String, Session> sessionMap = new ConcurrentHashMap<>();
    // ...省略其他代码...
}

4. 处理WebSocket事件

在这个类中，我们使用了一个ConcurrentHashMap来存储当前在线的客户端连接。当有新的客户端连接时，我们会将其添加到sessionMap中，并发送当前在线用户列表给新连接的客户端。当有客户端断开连接时，我们会将其从sessionMap中移除，并更新在线用户列表。当收到客户端发送的消息时，我们会根据消息内容将消息转发给指定的客户端。

5. 完整的 WebSocketServer.java 代码

package com.ruoyi.component;

import cn.hutool.json.JSONArray;
import cn.hutool.json.JSONObject;
import cn.hutool.json.JSONUtil;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;
import javax.websocket.*;
import javax.websocket.server.PathParam;
import javax.websocket.server.ServerEndpoint;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;

/**
 * @author websocket服务
 */
@Server