文章详情

短信预约-IT技能 免费直播动态提醒

请输入下面的图形验证码

提交验证

短信预约提醒成功

SpringBoot怎么整合WebSocket实现后端向前端发送消息

2023-07-05 09:42

关注

这篇文章主要讲解了“SpringBoot怎么整合WebSocket实现后端向前端发送消息”,文中的讲解内容简单清晰,易于学习与理解,下面请大家跟着小编的思路慢慢深入,一起来研究和学习“SpringBoot怎么整合WebSocket实现后端向前端发送消息”吧!

一、什么是 websocket 接口

使用 websocket 建立长连接,服务端和客户端可以互相通信,服务端只要有数据更新,就可以主动推给客户端。

WebSocket 使得客户端和服务器之间的数据交换变得更加简单,允许服务端主动向客户端推送数据。在 WebSocket API 中,浏览器和服务器只需要完成一次握手,两者之间就直接可以创建持久性的连接,并进行双向数据传输。
在 WebSocket API 中,浏览器和服务器只需要做一个握手的动作,然后,浏览器和服务器之间就形成了一条快速通道。两者之间就直接可以数据互相传送。

二、适用场景

在业务开发过程中碰到一些异步处理(微信支付、支付宝支付的支付通知),跨应用的消息传递。

当业务执行完毕后,需要将成功的信息投递给前端。一般情况下都是前端调用后端的http/https接口获取数据,后端想要主动推送消息给前端就需要使用到WebSocket进行前后端的通信。

三、示例代码

3.1、添加pom.xml依赖

<!-- websocket--><dependency>    <groupId>org.springframework.boot</groupId>    <artifactId>spring-boot-starter-websocket</artifactId></dependency>

3.2、创建WebSokcet配置类

@Configurationpublic class WebSocketConfig {    @Bean    public ServerEndpointExporter serverEndpointExporter(){        return new ServerEndpointExporter();    }}3.3、创建WebSokcet工具类 @ServerEndpoint(value = "/websocket")@Componentpublic class WebSocketServer {    private final static Logger log = LoggerFactory.getLogger(WebSocketServer.class);     //静态变量,用来记录当前在线连接数。应该把它设计成线程安全的。    private static int onlineCount = 0;    //concurrent包的线程安全Set,用来存放每个客户端对应的MyWebSocket对象。    private static CopyOnWriteArraySet<WebSocketServer> webSocketSet = new CopyOnWriteArraySet<WebSocketServer>();     //与某个客户端的连接会话,需要通过它来给客户端发送数据    private Session session;         @OnOpen    public void onOpen(Session session) {        this.session = session;        //加入set中        webSocketSet.add(this);        //在线数加1        addOnlineCount();        log.info("有新连接加入!当前在线人数为" + getOnlineCount());        try {            MsgResponseVo userMsgResponseVo = new MsgResponseVo();            userMsgResponseVo.setMsg("SUCCESS");            WebSocketServer.sendInfo(JSON.toJSONString(userMsgResponseVo));        } catch (IOException e) {            log.error("websocket IO异常");        }    }         @OnClose    public void onClose() {        //从set中删除        webSocketSet.remove(this);        //在线数减1        subOnlineCount();        log.info("有一连接关闭!当前在线人数为" + getOnlineCount());    }         @OnMessage    public void onMessage(String message, Session session) {        log.info("来自客户端的消息:" + message);         //群发消息        for (WebSocketServer item : webSocketSet) {            try {                item.sendMessage(message);            } catch (IOException e) {                e.printStackTrace();            }        }    }         @OnError    public void onError(Session session, Throwable error) {        log.error("发生错误");        error.printStackTrace();    }     public void sendMessage(String message) throws IOException {        this.session.getBasicRemote().sendText(message);    }         public static void sendInfo(String message) throws IOException {        log.info(message);        for (WebSocketServer item : webSocketSet) {            try {                item.sendMessage(message);            } catch (IOException e) {                continue;            }        }    }     public static synchronized int getOnlineCount() {        return onlineCount;    }     public static synchronized void addOnlineCount() {        WebSocketServer.onlineCount++;    }     public static synchronized void subOnlineCount() {        WebSocketServer.onlineCount--;    }}

3.3、创建测试发送消息接口

 @GetMapping("/testWebSocket")    public ApiRestResponse testWebSocket() throws IOException {        //消息体        MsgResponseVo technicianMsgResponseVo = new MsgResponseVo();        technicianMsgResponseVo.setRole("Technician");        technicianMsgResponseVo.setRoleId(1);        technicianMsgResponseVo.setMsg("您的订单已取消");        technicianMsgResponseVo.setMsgStatus("CANCEL_ORDER");        technicianMsgResponseVo.setOrderNo("test");        //发送消息        WebSocketServer.sendInfo(JSON.toJSONString(technicianMsgResponseVo));        return ApiRestResponse.success();    }}

3.4、测试webSocket

在网站中输入ws://ip:端口/webSocket工具类的前缀(ws://127.0.0.1:8080/websocket)

SpringBoot怎么整合WebSocket实现后端向前端发送消息

3.5、前端使用WebSocket监听后端WebSocket地址 ,接收到消息后做下一步业务处理。

感谢各位的阅读,以上就是“SpringBoot怎么整合WebSocket实现后端向前端发送消息”的内容了,经过本文的学习后,相信大家对SpringBoot怎么整合WebSocket实现后端向前端发送消息这一问题有了更深刻的体会,具体使用情况还需要大家实践验证。这里是编程网,小编将为大家推送更多相关知识点的文章,欢迎关注!

阅读原文内容投诉

免责声明:

① 本站未注明“稿件来源”的信息均来自网络整理。其文字、图片和音视频稿件的所属权归原作者所有。本站收集整理出于非商业性的教育和科研之目的,并不意味着本站赞同其观点或证实其内容的真实性。仅作为临时的测试数据,供内部测试之用。本站并未授权任何人以任何方式主动获取本站任何信息。

② 本站未注明“稿件来源”的临时测试数据将在测试完成后最终做删除处理。有问题或投稿请发送至: 邮箱/279061341@qq.com QQ/279061341

软考中级精品资料免费领

  • 历年真题答案解析
  • 备考技巧名师总结
  • 高频考点精准押题
  • 2024年上半年信息系统项目管理师第二批次真题及答案解析(完整版)

    难度     807人已做
    查看
  • 【考后总结】2024年5月26日信息系统项目管理师第2批次考情分析

    难度     351人已做
    查看
  • 【考后总结】2024年5月25日信息系统项目管理师第1批次考情分析

    难度     314人已做
    查看
  • 2024年上半年软考高项第一、二批次真题考点汇总(完整版)

    难度     433人已做
    查看
  • 2024年上半年系统架构设计师考试综合知识真题

    难度     221人已做
    查看

相关文章

发现更多好内容

猜你喜欢

AI推送时光机
位置:首页-资讯-后端开发
咦!没有更多了?去看看其它编程学习网 内容吧
首页课程
资料下载
问答资讯