SpringBoot使用WebSocket实现前后端交互的操作方法

 更新时间:2022年04月07日 15:02:36   作者:heaven096  
springboot使用websocket有两种方式,一种是实现简单的websocket,另外一种是实现STOMP协议,本篇讲述如何使用springboot实现简单的websocket,需要的朋友可以参考下

背景

我们都知道http协议只能在浏览器单方面向服务器发起请求时获得响应,然而服务器不能主动向浏览器推送消息,想要实现浏览器的主动推送目前有两种主流的实现方式:

  • 轮询:缺点很多,但是实现简单
  • websocket: 在浏览器和服务器之间建立TCP连接,实现全双工通信
  • springboot使用websocket有两种方式,一种是实现简单的websocket,另外一种是实现STOMP协议。本篇讲述如何使用springboot实现简单的websocket。

实现

一、导入依赖

直接在pom.xml中导入依赖。

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

二、新建WebSocket配置类,注入Bean

首先注入一个ServerEndpointExporterBean,该Bean会自动注册使用@ServerEndpoint注解申请的websocket endpoint,代码如下:

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

三、新建WebSocket服务端,在其中处理websocket逻辑

@Component  //注册到容器中
@ServerEndpoint("/webSocket")  //接收websocket请求路径
@Slf4j
public class WebSocket {
    //当前连接(每个websocket连入都会创建一个WebSocket实例)
    private Session session;
    //定义一个websocket容器存储session,即存放所有在线的socket连接
    private static CopyOnWriteArraySet<WebSocket> webSocketSet = new CopyOnWriteArraySet<>();
    //处理连接建立
    @OnOpen
    public void opOpen(Session session){
        this.session = session;
        log.info("【有新的客户端连接了】:{}",session.getId());
        webSocketSet.add(this);  //将新用户加入在线组
        log.info("【websocket消息】有新的连接,总数:{}",webSocketSet.size());
    }
    //处理连接关闭
    @OnClose
    public void Onclose(){
        webSocketSet.remove(this);
        log.info("【websocket消息】连接断开,总数:{}",webSocketSet.size());
    //接受消息
    @OnMessage
    public void onMessage(String message){
        log.info("【websocket消息】收到客户端发来的消息:{}",message);
    // 群发消息
    public void sendMessage(String message) {
        for (WebSocket webSocket : webSocketSet) {
            log.info("【websocket消息】广播群发消息,message={}",message);
            try {
                webSocket.session.getBasicRemote().sendText(message);
            }catch (Exception e){
                e.printStackTrace();
            }
        }
}

四、客户端实现,可以借助FreeMarker模板工具直接写在ftl文件里。

由于部分浏览器可能不支持,可以先测试,代码如下:

<script>
    var websocket = null;
    if('WebSocket' in window){
        websocket = new WebSocket('ws://localhost:8080/webSocket');
    }else{
        alert('当前浏览器不支持websocket消息通知');
    }
    //连接成功建立的回调方法
    websocket.onopen = function (event) {
        console.log("ws建立连接成功");
    //连接关闭的回调方法
    websocket.onclose = function (event) {
        console.log("ws连接关闭");
    //接收到消息的回调方法
    websocket.onmessage = function (event) {
        /*setMessageInnerHTML(event.data);*/
       // alert("ws接收返回消息:"+event.data);
        console.log("服务器返回消息: " + event.data);
        //弹窗提醒(要用到JQuary,所以要先引入JQuary)   播放音乐
        $('#mymodal').modal('show')
    //连接发生错误的回调方法
    websocket.onerror = function(event){
        alert('websocket通信发生错误!')
    //监听窗口关闭事件,当窗口关闭时,主动去关闭websocket连接,防止连接还没断开就关闭窗口,server端会抛异常。
    window.onbeforeunload = function() {
        websocket.close();
    </script>

五、测试

(项目实现客户创建新订单之后,前台发出提醒)

@Autowired
private WebSocket webSocket;
@Override
    @Transactional
    public OrderDTO create(OrderDTO orderDTO) {//创建订单
        。。。。(具体代码省略)
       //创建新订单  发送websocket消息
        webSocket.sendMessage(orderDTO.getOrderId());
        return orderDTO;
    }

添加新订单:

接收到websocket消息

到此这篇关于SpringBoot使用WebSocket实现前后端交互的操作方法的文章就介绍到这了,更多相关SpringBoot前后端交互内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • spring boot中配置hikari连接池属性方式

    spring boot中配置hikari连接池属性方式

    这篇文章主要介绍了spring boot中配置hikari连接池属性方式,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-10-10
  • Shiro与Springboot整合开发的基本步骤过程详解

    Shiro与Springboot整合开发的基本步骤过程详解

    这篇文章主要介绍了Shiro与Springboot整合开发的基本步骤,本文结合实例代码给大家介绍整合过程,感兴趣的朋友跟随小编一起看看吧
    2023-06-06
  • 解决Maven静态资源过滤问题

    解决Maven静态资源过滤问题

    在我们使用Maven构建项目的时候,会默认过滤掉静态资源,所以,需要手动来配置,本文就介绍一下Maven静态资源过滤的问题解决,感兴趣的可以了解一下
    2021-06-06
  • 适用于Java程序员的10道XML面试题 新鲜出炉

    适用于Java程序员的10道XML面试题 新鲜出炉

    这篇文章主要为大家详细介绍了Java程序员的10道XML面试题,感兴趣的小伙伴们可以参考一下
    2016-07-07
  • SpringSecurity框架下实现CSRF跨站攻击防御的方法

    SpringSecurity框架下实现CSRF跨站攻击防御的方法

    CSRF是一种网络攻击方式,也可以说是一种安全漏洞,这种安全漏洞在web开发中广泛存在。这篇文章主要介绍了SpringSecurity框架下实现CSRF跨站攻击防御,需要的朋友可以参考下
    2019-12-12
  • SpringBoot使用Redis缓存MySql的方法步骤

    SpringBoot使用Redis缓存MySql的方法步骤

    本文主要介绍了SpringBoot使用Redis缓存MySql的方法步骤,文中通过示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2022-02-02
  • MapReduce核心思想图文详解

    MapReduce核心思想图文详解

    今天小编就为大家分享一篇关于MapReduce核心思想图文详解,小编觉得内容挺不错的,现在分享给大家,具有很好的参考价值,需要的朋友一起跟随小编来看看吧
    2019-01-01
  • SpringBoot 集成短信和邮件的配置示例详解

    SpringBoot 集成短信和邮件的配置示例详解

    这篇文章主要介绍了SpringBoot 集成短信和邮件的相关知识,项目中使用lombok插件和swagger依赖,无相关依赖的请自行修改,本文通过实例代码给大家介绍的非常详细,需要的朋友可以参考下
    2022-04-04
  • 详解Java设计模式编程中的策略模式

    详解Java设计模式编程中的策略模式

    这篇文章主要介绍了详解Java设计模式编程中的策略模式,策略模式强调对对象的封装使用,比如文中举的锦囊妙计的例子便很生动,需要的朋友可以参考下
    2016-02-02
  • SpringMVC的REST风格的四种请求方式总结

    SpringMVC的REST风格的四种请求方式总结

    下面小编就为大家带来一篇SpringMVC的REST风格的四种请求方式总结。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-08-08

最新评论