广告
返回顶部
首页 > 资讯 > 后端开发 > Python >springboot整合websocket实现群聊思路代码详解
  • 945
分享到

springboot整合websocket实现群聊思路代码详解

2024-04-02 19:04:59 945人浏览 独家记忆

Python 官方文档:入门教程 => 点击学习

摘要

实现思路 发送者向服务器发送大家早上好。其它客户端可以收到对应消息。 项目展示 通过SpringBoot引入websocket,实现群聊,通过在线WEBSocket测试进行展示。

实现思路

image-20210528112407993

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

项目展示

image-20210528111445032

通过SpringBoot引入websocket,实现群聊,通过在线WEBSocket测试进行展示。

核心代码

pom引入jar


<parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.3.10.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </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
{


    // ========== 会话相关 ==========

    
    private static final Map<String, Session> SESSION_USER_MAP = new ConcurrentHashMap<> ();

    
    public static void addSession(Session session) {
        // 更新 SESSION_USER_MAP
        SESSION_USER_MAP.put(session.getId (), session);
    }

    
    public static void removeSession(Session session) {
        // 从 SESSION_USER_MAP 中移除
          SESSION_USER_MAP.remove(session.getId ());

    }

    // ========== 消息相关 ==========

    
    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);
        }
    }

    
    public static <T extends Message> void send(Session session, String type, T message) {
        // 创建消息
        String messageText = buildTextMessage(type, message);
        // 遍历给单个 Session ,进行逐个发送
        sendTextMessage(session, messageText);
    }


    
    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();
    }

    
    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/即可。

以上就是springboot整合websocket实现群聊思路代码详解的详细内容,更多关于springboot整合websocket的资料请关注编程网其它相关文章!

--结束END--

本文标题: springboot整合websocket实现群聊思路代码详解

本文链接: https://www.lsjlt.com/news/127093.html(转载时请注明来源链接)

有问题或投稿请发送至: 邮箱/279061341@qq.com    QQ/279061341

本篇文章演示代码以及资料文档资料下载

下载Word文档到电脑,方便收藏和打印~

下载Word文档
猜你喜欢
软考高级职称资格查询
编程网,编程工程师的家园,是目前国内优秀的开源技术社区之一,形成了由开源软件库、代码分享、资讯、协作翻译、讨论区和博客等几大频道内容,为IT开发者提供了一个发现、使用、并交流开源技术的平台。
  • 官方手机版

  • 微信公众号

  • 商务合作