使用WebSocket实现聊天中遇到的一些问题

小牛椰椰
·发布于 8 个月前

使用WebSocket实现聊天中遇到的一些问题

问题1---ChatMapper注入WebSocketServer始终失败

实际情况
因为想要实现可以私聊的那种功能，那么必须要保留历史信息，于是得要把聊天的信息存入数据库，于是想到使用ChatMapper里的save方法就可以实现了（mybatis-plus），于是有了如下的代码：

package com.xiaoniuyeye.cuitback.component;

import cn.hutool.json.JSONArray;
import cn.hutool.json.JSONObject;
import cn.hutool.json.JSONUtil;
import com.xiaoniuyeye.cuitback.entity.Chat;
import com.xiaoniuyeye.cuitback.mapper.ChatMapper;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;

import javax.annotation.Resource;
import javax.websocket.*;
import javax.websocket.server.PathParam;
import javax.websocket.server.ServerEndpoint;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;

@Component
@ServerEndpoint(value = "/imserver/{id}")
public class WebSocketServer {
    private static final Logger log = LoggerFactory.getLogger(WebSocketServer.class);
    private final ChatMapper chatMapper;

    @Autowired
    public WebSocketServer(ChatMapper chatMapper) {
        this.chatMapper = chatMapper;
        if (chatMapper == null) {
            log.error("ChatMapper注入失败");
        } else {
            log.info("ChatMapper注入成功");
            testChatMapper(); // 测试ChatMapper
        }
    }

    private void testChatMapper() {
        Chat chat = new Chat();
        chat.setSender("1008611");
        chat.setReceiver("1008602");
        chat.setMessage("Hello");
        chatMapper.save(chat);
    }

    public static final Map<String, Session> sessionMap = new ConcurrentHashMap<>();

    @OnOpen
    public void onOpen(Session session, @PathParam("id") String id) {
        sessionMap.put(id, session);
        log.info("有新用户加入，id={}, 当前在线人数为：{}", id, sessionMap.size());
        JSONObject result = new JSONObject();
        JSONArray array = new JSONArray();
        result.set("users", array);
        for (Object key : sessionMap.keySet()) {
            JSONObject jsonObject = new JSONObject();
            jsonObject.set("id", key);
            array.add(jsonObject);
        }
        sendAllMessage(JSONUtil.toJsonStr(result));
    }

    @OnClose
    public void onClose(Session session, @PathParam("id") String id) {
        sessionMap.remove(id);
        log.info("有一连接关闭，移除id={}的用户session, 当前在线人数为：{}", id, sessionMap.size());
    }

    @OnMessage
    public void onMessage(String message, Session session, @PathParam("id") String id) {
        log.info("服务端收到用户id={}的消息:{}", id, message);
        JSONObject obj = JSONUtil.parseObj(message);
        String toId = obj.getStr("to");
        String text = obj.getStr("text");

        Chat chat = new Chat();
        chat.setSender(id);
        chat.setReceiver(toId);
        chat.setMessage(text);
        chatMapper.save(chat);

        Session toSession = sessionMap.get(toId);
        if (toSession != null) {
            JSONObject jsonObject = new JSONObject();
            jsonObject.set("from", id);
            jsonObject.set("text", text);
            sendMessage(jsonObject.toString(), toSession);
            log.info("发送给用户id={}，消息：{}", toId, jsonObject.toString());
        } else {
            log.info("发送失败，未找到用户id={}的session", toId);
        }
    }

    @OnError
    public void onError(Session session, Throwable error) {
        log.error("发生错误");
        error.printStackTrace();
    }

    private void sendMessage(String message, Session toSession) {
        try {
            log.info("服务端给客户端[{}]发送消息{}", toSession.getId(), message);
            toSession.getBasicRemote().sendText(message);
        } catch (Exception e) {
            log.error("服务端发送消息给客户端失败", e);
        }
    }

    private void sendAllMessage(String message) {
        try {
            for (Session session : sessionMap.values()) {
                log.info("服务端给客户端[{}]发送消息{}", session.getId(), message);
                session.getBasicRemote().sendText(message);
            }
        } catch (Exception e) {
            log.error("服务端发送消息给客户端失败", e);
        }
    }
}

好了问题来了（这还是根据chatgpt改过一次了），先是爆
ERROR 15604 --- [nio-9090-exec-3] o.a.coyote.http11.Http11NioProtocol : Error reading request, ignored java.lang.IllegalArgumentException: javax.websocket.DeploymentException: Endpoint instance creation failed
查询得知大概意思是缺少无参构造函数，于是加上

// 无参构造函数
    public WebSocketServer() {
        // 如果需要在无参构造函数中进行初始化，请在这里添加代码
    }

好家伙，又来了一个新错误（空指针）
java.lang.NullPointerException at com.xiaoniuyeye.cuitback.component.WebSocketServer.onMessage(WebSocketServer.java:84)
这个时候就感觉应该是chatMapper为空了，于是做了一个判空处理

@OnMessage
    public void onMessage(String message, Session session, @PathParam("id") String id) {
        log.info("服务端收到用户id={}的消息:{}", id, message);
        if (chatMapper == null) {
            log.error("ChatMapper为null，无法保存消息。");
            return;
        }
        JSONObject obj = JSONUtil.parseObj(message);
        String toId = obj.getStr("to");
        String text = obj.getStr("text");

        Chat chat = new Chat();
        chat.setSender(id);
        chat.setReceiver(toId);
        chat.setMessage(text);
        chatMapper.save(chat);

        Session toSession = sessionMap.get(toId);
        if (toSession != null) {
            JSONObject jsonObject = new JSONObject();
            jsonObject.set("from", id);
            jsonObject.set("text", text);
            sendMessage(jsonObject.toString(), toSession);
            log.info("发送给用户id={}，消息：{}", toId, jsonObject.toString());
        } else {
            log.info("发送失败，未找到用户id={}的session", toId);
        }
    }

好家伙，然后就一直会触发log.error("ChatMapper为null，无法保存消息。");了，问题是我写了一个测试，而测试是可以正确执行的，这表明在构造函数中，chatMapper是成功注入的，搞不明白....
于是去chatgpt问了一下，
他的解释：

确实，您的测试实例成功执行了，这表明在构造函数中注入ChatMapper时是成功的。但是，在onMessage方法中再次检查ChatMapper时，它的值却为null，这可能是由于WebSocketServer实例的创建方式不同所导致的。
WebSocketServer类在WebSocket容器中的实例化方式不同于在Spring容器中的实例化方式。WebSocketServer类在WebSocket容器中通过反射实例化，因此它的构造函数可能不会由Spring容器调用，这导致了ChatMapper的值为null。
为了解决这个问题，您可以尝试将ChatMapper设置为静态变量，这样在WebSocketServer实例化时就可以直接访问ChatMapper，而不会因为实例化方式的不同而出现null值。

于是将ChatMapper设置为静态变量：

private static ChatMapper chatMapper; // ChatMapper设置为静态变量

问题解决！

SpringBoot
WebSocket
$ cd ..