SpringBoot整合websocket实现群聊

深藏阁楼爱情的钟 2022-10-17 15:54 198阅读 0赞

![9da020e258e05a02969e4d3d47d49ea5.png][]

### 实现思路 ###

![194492077710d3f9ccd9752b86fd6373.png][]

发送者向服务器发送大家早上好。其它客户端可以收到对应消息。

### 项目展示 ###

![6bcf1dfce6a0d0e99d45d26d8301c3a4.png][]

通过springboot引入websocket，实现群聊，通过在线websocket测试进行展示。

### 核心代码 ###

pom引入jar

<parent>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-parent</artifactId>
            <version>2.3.10.RELEASE</version>
            <relativePath/> 
        </parent>
        <properties>
            <java.version>1.8</java.version>
        </properties>
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
            </dependency>
            <dependency>
                <groupId>org.apache.commons</groupId>
                <artifactId>commons-lang3</artifactId>
            </dependency>
    
            <dependency>
                <groupId>org.projectlombok</groupId>
                <artifactId>lombok</artifactId>
                <version>1.18.12</version>
            </dependency>
    
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-websocket</artifactId>
            </dependency>
            <dependency>
                <groupId>com.alibaba</groupId>
                <artifactId>fastjson</artifactId>
                <version>1.2.62</version>
            </dependency>
        </dependencies>

使用springboot 2.3.10.RELEASE版本；java8

### WebSocketConfig配置类 ###

@Configuration
    public class WebSocketConfig
    {
       @Bean
       public ServerEndpointExporter serverEndpointExporter()  {
          return new ServerEndpointExporter();
       }
    }

websocket有4个注解，解释如下

*  @OnOpen 有新连接
 *  @OnMessage 有新消息时
 *  @OnClose 关闭连接
 *  @OnError 连接异常

对于这个4个注解，配置在方法上即可。

### WebsocketServerEndpoint接收类 ###

@Slf4j
    @Controller
    @ServerEndpoint ("/")
    public class WebsocketServerEndpoint
    {
       @OnOpen
       public void onOpen(Session session, EndpointConfig config) {
          log.info("[onOpen][session({}) 接入]", session);
          WebSocketUtil.broadcast (session.getId ()+"上线了");
          WebSocketUtil.addSession (session);
       }
       @OnMessage
       public void onMessage(Session session, String message) {
          WebSocketUtil.broadcast (message);
          log.info("[onOpen][session({}) 接收到一条消息({})]", session, message); // 生产环境下，请设置成 debug 级别
       }
       @OnClose
       public void onClose(Session session, CloseReason closeReason) {
          WebSocketUtil.removeSession (session);
          WebSocketUtil.broadcast (session.getId ()+"下线了");
          log.info("[onClose][session({}) 连接关闭。关闭原因是({})}]", session, closeReason);
       }
       @OnError
       public void onError(Session session, Throwable throwable) {
          log.info("[onClose][session({}) 发生异常]", session, throwable);
       }
    }

### WebSocketUtil工具类。 ###

@Slf4j
    public class WebSocketUtil
    {
    
    
        // ========== 会话相关 ==========
    
        /**
         * Session 与用户的映射
         */
        private static final Map<String, Session> SESSION_USER_MAP = new ConcurrentHashMap<> ();
    
        /**
         * 添加 Session 。在这个方法中，会添加用户和 Session 之间的映射
         *
         * @param session Session
         */
        public static void addSession(Session session) {
            // 更新 SESSION_USER_MAP
            SESSION_USER_MAP.put(session.getId (), session);
        }
    
        /**
         * 移除 Session 。
         *
         * @param session Session
         */
        public static void removeSession(Session session) {
            // 从 SESSION_USER_MAP 中移除
              SESSION_USER_MAP.remove(session.getId ());
    
        }
    
        // ========== 消息相关 ==========
    
        /**
         * 广播发送消息给所有在线用户
         *
         * @param message 消息体
         * @param <T> 消息类型
         */
        public static <T extends Message> void broadcast(String message) {
            // 创建消息
    //        String messageText = buildTextMessage(type, message);
            // 遍历 SESSION_USER_MAP ，进行逐个发送
            for (String sessionId : SESSION_USER_MAP.keySet()) {
                sendTextMessage(SESSION_USER_MAP.get (sessionId), message);
            }
        }
    
        /**
         * 发送消息给单个用户的 Session
         *
         * @param session Session
         * @param type 消息类型
         * @param message 消息体
         * @param <T> 消息类型
         */
        public static <T extends Message> void send(Session session, String type, T message) {
            // 创建消息
            String messageText = buildTextMessage(type, message);
            // 遍历给单个 Session ，进行逐个发送
            sendTextMessage(session, messageText);
        }
    
    
        /**
         * 构建完整的消息
         *
         * @param type 消息类型
         * @param message 消息体
         * @param <T> 消息类型
         * @return 消息
         */
        private static <T extends Message> String buildTextMessage(String type, T message) {
            JSONObject messageObject = new JSONObject();
            messageObject.put("type", type);
            messageObject.put("body", message);
            return messageObject.toString();
        }
    
        /**
         * 真正发送消息
         *
         * @param session Session
         * @param messageText 消息
         */
        private static void sendTextMessage(Session session, String messageText) {
            if (session == null) {
                log.error("[sendTextMessage][session 为 null]");
                return;
            }
            RemoteEndpoint.Basic basic = session.getBasicRemote();
            if (basic == null) {
                log.error("[sendTextMessage][session 的  为 null]");
                return;
            }
            try {
                basic.sendText(messageText);
            } catch (IOException e) {
                log.error("[sendTextMessage][session({}) 发送消息{}) 发生异常",
                        session, messageText, e);
            }
        }
    
    }

在线websocket调试输入`ws://localhost:8080/`即可。

*（感谢阅读，希望对你所有帮助)*

*来源：blog.csdn.net/qq\_30285985/article/details/117357241*

推荐好文

[强大，10k+点赞的 SpringBoot 后台管理系统竟然出了详细教程！][10k_ SpringBoot]

[分享一套基于SpringBoot和Vue的企业级中后台开源项目，代码很规范！][SpringBoot_Vue]

[能挣钱的，开源 SpringBoot 商城系统，功能超全，超漂亮][SpringBoot]![0eb6fa268be126726bf42b3121c54e95.png][]

[9da020e258e05a02969e4d3d47d49ea5.png]: /images/20221014/d91e970c4044416bacdd0d0e96692812.png
[194492077710d3f9ccd9752b86fd6373.png]: /images/20221014/c27bb172be524d65b96068892ce0891f.png
[6bcf1dfce6a0d0e99d45d26d8301c3a4.png]: /images/20221014/baf0551696934913ab2750a73095afe8.png
[10k_ SpringBoot]: http://mp.weixin.qq.com/s?__biz=MzI4Njc5NjM1NQ%3D%3D&chksm=ebd5c411dca24d07446a4f22772cd12d2cc1143b62eb922a14500ae981cd57fb850ef74ca257&idx=2&mid=2247498557&scene=21&sn=84902d7030e174e152615d8fae3755cc#wechat_redirect
[SpringBoot_Vue]: http://mp.weixin.qq.com/s?__biz=MzU2MTI4MjI0MQ%3D%3D&chksm=fc799be6cb0e12f0b58479f8b031bc5ae79efdca1880ff9b19f0a107c3a88c37b9596dc73203&idx=2&mid=2247497288&scene=21&sn=65d7111a19e920df1e9416959594b2f4#wechat_redirect
[SpringBoot]: http://mp.weixin.qq.com/s?__biz=MzU2MTI4MjI0MQ%3D%3D&chksm=fc799a9ccb0e138a64a2671f31b8d4be1b3c061a288f7b0d1d4af02a60c45a72231446b91e00&idx=2&mid=2247497522&scene=21&sn=c5b4e596be4ac7d7f293e7e2f0ea0769#wechat_redirect
[0eb6fa268be126726bf42b3121c54e95.png]: /images/20221014/604b02e2524144c7bb74c8be9a8357fe.png