Springboot整合Websocket遇到的坑_websocket session不支持序列化，无法存储至redis_Websocket相关问题总结(Session共享，用户多端登录等)

小灰灰 2023-10-01 20:24 12阅读 0赞

## Springboot整合Websocket遇到的坑 ##

### 一、使用Springboot内嵌的tomcat启动websocket ###

#### 1.添加ServerEndpointExporter配置bean ####

@Configuration
    public class WebSocketConfig {
        
    
        /**
         * 服务器节点
         *
         * 如果使用独立的servlet容器，而不是直接使用springboot的内置容器，就不要注入ServerEndpointExporter，因为它将由容器自己提供和管理
         * @return
         */
        @Bean
        public ServerEndpointExporter serverEndpointExporter() {
        
            return new ServerEndpointExporter();
        }
    
    }

#### 2.在接收连接的类加上@ServerEndpoint和@Component ####

@ServerEndpoint("/connect")
    @Component

### 二、使用外部tomcat容器启动websocket ###

#### 1.删除ServerEndpointExporter配置bean ####

#### 2.接收连接的类删除@Component ####

### 三、websocket关闭连接异常 ###

如果客户端关闭了websocket，但服务端没有监听到关闭事件，即onClose方法没有调用，这是会发生的情况

此时如果服务端向客户端推送消息，会出现异常告诉开发者：关闭了一个连接，并重新调用onClose方法

## websocket 分布式开发，websocket session不支持序列化，无法存储至redis ##

单websocket服务器在面对并发量很大时压力会很大，而且session储存在Map中，内存压力也会很大。于是考虑分布式。

但是分布式存在websocket session共享问题，于是考虑radis存储session，但是遇到websocket session不支持序列化，无法存储。

一番搜索后有了以下几个方案

1.  使用spring session自定义session.
2.  既然无法序列化session，那还是存储在Map中，各服务器通过发布订阅变相实现共享websocket session.

## Websocket相关问题总结(Session共享，用户多端登录等) ##

我们在使用websocket的时候其实主要面对的问题就是session共享的问题：

不管是基于Spring实现的Websocket的WebsocketSession

还是基于JDK实现的Session

亦或者基于netty实现的ChannelHandlerContext

用图来描述下场景吧：

![img][]

OK，大家看到这个图了，差不多应该明白了Session共享应该怎么处理了。其实原理很简单：

1、我们知道nginx有IP保持的功能，其实这个功能就能解决大部分场景的Session共享问题。 但是某些极限情况下还是会有问题，比如在浏览器没有关闭的情况下同一个用户更换了网络的情况导致IP变了，或者对于某些网络的IP是变动的情况下，就会出现Session找不到的情况。

2、基于上述nginx的原理我们可以进行优化，还是单例存储。那么要操作的时候，我告诉所有的服务端，你们去找这个用户的Session，并把消息带过去。那么相应的节点根据用户拿到Session了就可以进行处理了。

上面2点大概简单的描述了下Session共享的原理，那么有这么个场景，文字可能不太好表达，我们还是用图来说明：

![img][img 1]

一般出现多端情况也应该就上面2种情况，要么允许，要么不允许。我这里简单的说下不允许的处理流程。

建立连接的时候，先获取老的Session

Session oldSession = SOCK_MAP.get(baseStudentInfo.getId());

存在，则推送关闭消息，不存在告知其他节点去清楚。当然本节点的的Server要排除在外，这里就通过IP判断即可。

if(oldSession!=null) {
        
                oldSession.getBasicRemote().sendObject(close);
            }else{
        
                //关闭其他节点的的session
                authService.pushCloseMessage(close);
            }
            //替换
            SOCK_MAP.put(baseStudentInfo.getId(),session);

消息监听

String serverIp = IPUtils.getLocalhostIp();
                logger.info("当前IP："+serverIp);
                logger.info("content的IP："+wsMessage.getBody().getContent());
                //IP不相等，说明不是当前连接的服务端，关闭其他端口
                if(!serverIp.equals(wsMessage.getBody().getContent())){
        
                    //关闭session，并返回给前端
                    customerHandler.closeSession(wsMessage.getBody().getReceiver(), wsMessage);
                }

关闭的方法：

/**
         * 关闭Session
         * @param studentId
         * @param closeMessage
         */
        public void closeSession(Long studentId,WsMessage closeMessage){
        
            Session session = SOCK_MAP.get(studentId);
            if(session!=null) {
        
                try {
        
                    session.getBasicRemote().sendObject(closeMessage);
                    SOCK_MAP.remove(studentId);
                    //清除redis
                    logger.info("连接已关闭：" + studentId);
                } catch (Exception e) {
        
                    e.printStackTrace();
                    logger.error("关闭连接异常");
                }
            }
        }

这样基本就避免多端登录的问题，如果允许多端登录的时候只需要更改存储，更改发送消息变成群发即可。

[img]: https://img-blog.csdnimg.cn/20200310133600849.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3podXdlaV9jbGFyaw==,size_16,color_FFFFFF,t_70
[img 1]: https://img-blog.csdnimg.cn/20200310141636193.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3podXdlaV9jbGFyaw==,size_16,color_FFFFFF,t_70