AI 助理
文档备案控制台
开发者社区 开发与运维 文章 正文

基于若依(SpringBoot前后分离版-vue)的WebSocket消息推送实现

2023-08-01 7791
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
简介： 基于若依(SpringBoot前后分离版-vue)的WebSocket消息推送实现

引言

自己写了个小项目游戏报价器，想在更新系统的时候可以提前在系统弹窗提示用户，注意系统更新。

第一想到的就是WebSocket了，在更新前，提前发布公告，通过WebSocket推送到web客户端界面。

WebSocket是一种通信协议，可在单个TCP连接上进行全双工通信。WebSocket使得客户端和服务器之间的数据交换变得更加简单，允许服务端主动向客户端推送数据。在WebSocket API中，浏览器和服务器只需要完成一次握手，两者之间就可以建立持久性的连接，并进行双向数据传输。

具体实现方法如下：

添加依赖

版本自定，我用的最新版。

<!-- SpringBoot Websocket -->
<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-websocket</artifactId>
  <version>2.2.13.RELEASE</version>
</dependency>

取消Websocket鉴权认证

如果你没有用到若依，并且接口访问没有鉴权仅仅是测试使用，可以跳过这一步。

如果你用的是若依的前后分离版 需要到spring security配置中修改，具体文件位置为framework模块-config-SecurityConfig.java-configure方法。

添加如下代码：

.antMatchers("/websocket/**").anonymous()

511dd7fa8f5d422eb488e74de5754913.png

  • 如果你是若依前后不分离版本应该用的是Shiro，需要在ShiroConfig.java中操作。

在对应取消鉴权认证的位置添加如下代码：

filterChainDefinitionMap.put("/websocket/**", "anon");

添加配置

我是在framework模块新建了一个websocket包。

包内的代码如下：

package com.rdjxx.framework.websocket;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.socket.server.standard.ServerEndpointExporter;
/**
 * websocket 配置
 * 
 * @author fm
 */
@Configuration
public class WebSocketConfig
{
    @Bean
    public ServerEndpointExporter serverEndpointExporter()
    {
        return new ServerEndpointExporter();
    }
}

package com.rdjxx.framework.websocket;
import java.util.concurrent.Semaphore;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
 * 信号量相关处理
 * 
 * @author fm
 */
public class SemaphoreUtils
{
    /**
     * SemaphoreUtils 日志控制器
     */
    private static final Logger LOGGER = LoggerFactory.getLogger(SemaphoreUtils.class);
    /**
     * 获取信号量
     * 
     * @param semaphore
     * @return
     */
    public static boolean tryAcquire(Semaphore semaphore)
    {
        boolean flag = false;
        try
        {
            flag = semaphore.tryAcquire();
        }
        catch (Exception e)
        {
            LOGGER.error("获取信号量异常", e);
        }
        return flag;
    }
    /**
     * 释放信号量
     * 
     * @param semaphore
     */
    public static void release(Semaphore semaphore)
    {
        try
        {
            semaphore.release();
        }
        catch (Exception e)
        {
            LOGGER.error("释放信号量异常", e);
        }
    }
}

package com.rdjxx.framework.websocket;
import java.util.List;
import java.util.concurrent.Semaphore;
import javax.websocket.OnClose;
import javax.websocket.OnError;
import javax.websocket.OnMessage;
import javax.websocket.OnOpen;
import javax.websocket.Session;
import javax.websocket.server.ServerEndpoint;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;
/**
 * websocket 消息处理
 *
 * @author fm
 */
@Component
@ServerEndpoint("/websocket/message")
public class WebSocketServer
{
    /**
     * WebSocketServer 日志控制器
     */
    private static final Logger LOGGER = LoggerFactory.getLogger(WebSocketServer.class);
    /**
     * 默认最多允许同时在线人数100
     */
    public static int socketMaxOnlineCount = 1000;
    private static Semaphore socketSemaphore = new Semaphore(socketMaxOnlineCount);
    /**
     * 连接建立成功调用的方法
     */
    @OnOpen
    public void onOpen(Session session) throws Exception
    {
        boolean semaphoreFlag = false;
        // 尝试获取信号量
        semaphoreFlag = SemaphoreUtils.tryAcquire(socketSemaphore);
        if (!semaphoreFlag)
        {
            // 未获取到信号量
            LOGGER.error("\n 当前在线人数超过限制数- {}", socketMaxOnlineCount);
//            WebSocketUsers.sendMessageToUserByText(session, "当前在线人数超过限制数：" + socketMaxOnlineCount);
            session.close();
        }
        else
        {
            // 添加用户
            WebSocketUsers.put(session.getId(), session);
            //LOGGER.info("\n 建立连接 - {}", session);
            //LOGGER.info("\n 当前人数 - {}", WebSocketUsers.getUsers().size());
            // WebSocketUsers.sendMessageToUserByText(session, "连接成功");
        }
    }
    /**
     * 连接关闭时处理
     */
    @OnClose
    public void onClose(Session session)
    {
        //LOGGER.info("\n 关闭连接 - {}", session);
        // 移除用户
        WebSocketUsers.remove(session.getId());
        // 获取到信号量则需释放
        SemaphoreUtils.release(socketSemaphore);
    }
    /**
     * 抛出异常时处理
     */
    @OnError
    public void onError(Session session, Throwable exception) throws Exception
    {
        if (session.isOpen())
        {
            // 关闭连接
            session.close();
        }
        String sessionId = session.getId();
        //LOGGER.info("\n 连接异常 - {}", sessionId);
        //LOGGER.info("\n 异常信息 - {}", exception);
        // 移出用户
        WebSocketUsers.remove(sessionId);
        // 获取到信号量则需释放
        SemaphoreUtils.release(socketSemaphore);
    }
    /**
     * 服务器接收到客户端消息时调用的方法
     */
    @OnMessage
    public void onMessage(String message, Session session)
    {
        String msg = message.replace("你", "我").replace("吗", "");
        WebSocketUsers.sendMessageToUserByText(session, msg);
    }
}

package com.rdjxx.framework.websocket;
import java.io.IOException;
import java.util.Collection;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.ConcurrentHashMap;
import javax.websocket.Session;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
 * websocket 客户端用户集
 * 
 * @author fm
 */
public class WebSocketUsers
{
    /**
     * WebSocketUsers 日志控制器
     */
    private static final Logger LOGGER = LoggerFactory.getLogger(WebSocketUsers.class);
    /**
     * 用户集
     */
    private static Map<String, Session> USERS = new ConcurrentHashMap<String, Session>();
    /**
     * 存储用户
     *
     * @param key 唯一键
     * @param session 用户信息
     */
    public static void put(String key, Session session)
    {
        USERS.put(key, session);
    }
    /**
     * 移除用户
     *
     * @param session 用户信息
     *
     * @return 移除结果
     */
    public static boolean remove(Session session)
    {
        String key = null;
        boolean flag = USERS.containsValue(session);
        if (flag)
        {
            Set<Map.Entry<String, Session>> entries = USERS.entrySet();
            for (Map.Entry<String, Session> entry : entries)
            {
                Session value = entry.getValue();
                if (value.equals(session))
                {
                    key = entry.getKey();
                    break;
                }
            }
        }
        else
        {
            return true;
        }
        return remove(key);
    }
    /**
     * 移出用户
     *
     * @param key 键
     */
    public static boolean remove(String key)
    {
        //LOGGER.info("\n 正在移出用户 - {}", key);
        Session remove = USERS.remove(key);
        if (remove != null)
        {
            boolean containsValue = USERS.containsValue(remove);
            //LOGGER.info("\n 移出结果 - {}", containsValue ? "失败" : "成功");
            return containsValue;
        }
        else
        {
            return true;
        }
    }
    /**
     * 获取在线用户列表
     *
     * @return 返回用户集合
     */
    public static Map<String, Session> getUsers()
    {
        return USERS;
    }
    /**
     * 群发消息文本消息
     *
     * @param message 消息内容
     */
    public static void sendMessageToUsersByText(String message)
    {
        Collection<Session> values = USERS.values();
        for (Session value : values)
        {
            sendMessageToUserByText(value, message);
        }
    }
    /**
     * 发送文本消息
     *
     */
    public static void sendMessageToUserByText(Session session, String message)
    {
        if (session != null)
        {
            try
            {
                session.getBasicRemote().sendText(message);
            }
            catch (IOException e)
            {
                LOGGER.error("\n[发送消息异常]", e);
            }
        }
        else
        {
            //LOGGER.info("\n[你已离线]");
        }
    }
}

前端

<template>
  <div class="navbar">
    <hamburger id="hamburger-container" :is-active="sidebar.opened" class="hamburger-container"
               @toggleClick="toggleSideBar"/>
    <breadcrumb id="breadcrumb-container" class="breadcrumb-container" v-if="!topNav"/>
    <top-nav id="topmenu-container" class="topmenu-container" v-if="topNav"/>
    <div class="right-menu">
      <template v-if="device!=='mobile'">
        <screenfull id="screenfull" class="right-menu-item hover-effect"/>
        <el-tooltip content="布局大小" effect="dark" placement="bottom">
          <size-select id="size-select" class="right-menu-item hover-effect"/>
        </el-tooltip>
      </template>
      <el-dropdown class="avatar-container right-menu-item hover-effect" trigger="click">
        <div class="avatar-wrapper">
          <img :src="avatar" class="user-avatar">
          <i class="el-icon-caret-bottom"/>
        </div>
        <el-dropdown-menu slot="dropdown">
          <router-link to="/user/profile">
            <el-dropdown-item>个人中心</el-dropdown-item>
          </router-link>
          <el-dropdown-item @click.native="setting = true">
            <span>布局设置</span>
          </el-dropdown-item>
          <el-dropdown-item divided @click.native="logout">
            <span>退出登录</span>
          </el-dropdown-item>
        </el-dropdown-menu>
      </el-dropdown>
    </div>
  </div>
</template>
<script>
import {mapGetters} from 'vuex'
import Breadcrumb from '@/components/Breadcrumb'
import TopNav from '@/components/TopNav'
import Hamburger from '@/components/Hamburger'
import Screenfull from '@/components/Screenfull'
import SizeSelect from '@/components/SizeSelect'
import Search from '@/components/HeaderSearch'
import RuoYiGit from '@/components/RuoYi/Git'
import RuoYiDoc from '@/components/RuoYi/Doc'
import {Notification} from "element-ui";
import {getNoticeListTop3} from "@/api/system/navbar";
export default {
  data() {
    return {
      url: "ws://localhost:8087/websocket/message",
      message: "",
      text_content: "",
      ws: null,
    };
  },
  components: {
    Breadcrumb,
    TopNav,
    Hamburger,
    Screenfull,
    SizeSelect,
    Search,
    RuoYiGit,
    RuoYiDoc
  },
  computed: {
    ...mapGetters([
      'sidebar',
      'avatar',
      'device'
    ]),
    setting: {
      get() {
        return this.$store.state.settings.showSettings
      },
      set(val) {
        this.$store.dispatch('settings/changeSetting', {
          key: 'showSettings',
          value: val
        })
      }
    },
    topNav: {
      get() {
        return this.$store.state.settings.topNav
      }
    }
  },
  mounted() {
    this.notice();
    const wsuri = this.url;
    this.ws = new WebSocket(wsuri);
    const self = this;
    this.ws.onopen = function (event) {
      //self.text_content = self.text_content + "已经打开连接!" + "\n";
    };
    this.ws.onmessage = function (event) {
      //self.text_content = event.data + "\n";
      var messageBody = JSON.parse(event.data);
      Notification.info({
        title: "通知",
        dangerouslyUseHTMLString: true,
        message: messageBody.noticeContent,
        duration: 0,
        offset: 40,
        onClick: function () {
          //self.warnDetailByWarnid(messageBody.warnId); //自定义回调,message为传的参数
          // 点击跳转的页面
        },
      });
    };
    this.ws.onclose = function (event) {
      //self.text_content = self.text_content + "已经关闭连接!" + "\n";
    };
  },
  methods: {
    notice() {
      getNoticeListTop3().then(response => {
        for (let i = 0; i < response.length; i++) {
          let messageBody = response[i];
          setTimeout(() => {
            this.notificationInfo(messageBody);
          }, 100);
        }
      })
    },
    notificationInfo(messageBody) {
      Notification.info({
        title: "通知",
        dangerouslyUseHTMLString: true,
        message: messageBody.noticeContent,
        duration: 0,
        offset: 40,
        onClick: function () {
          //self.warnDetailByWarnid(messageBody.warnId); //自定义回调,message为传的参数
          // 点击跳转的页面
        },
      });
    },
    // join() {
    //
    // },
    exit() {
      if (this.ws) {
        this.ws.close();
        this.ws = null;
      }
    },
    send() {
      if (this.ws) {
        this.ws.send(this.message);
      } else {
        alert("未连接到服务器");
      }
    },
    warnDetailByWarnid(warnid) {
      // 跳转预警详情页面
      this.$router.push({
        path: "/XXX/XXX",
        query: {
          warnid: warnid,
        },
      });
    },
    toggleSideBar() {
      this.$store.dispatch('app/toggleSideBar')
    },
    async logout() {
      this.$confirm('确定注销并退出系统吗？', '提示', {
        confirmButtonText: '确定',
        cancelButtonText: '取消',
        type: 'warning'
      }).then(() => {
        this.$store.dispatch('LogOut').then(() => {
          location.href = '/index';
        })
      }).catch(() => {
      });
    }
  }
}
</script>
<style lang="scss" scoped>
.navbar {
  height: 50px;
  overflow: hidden;
  position: relative;
  background: #fff;
  box-shadow: 0 1px 4px rgba(0, 21, 41, .08);
  .hamburger-container {
    line-height: 46px;
    height: 100%;
    float: left;
    cursor: pointer;
    transition: background .3s;
    -webkit-tap-highlight-color: transparent;
    &:hover {
      background: rgba(0, 0, 0, .025)
    }
  }
  .breadcrumb-container {
    float: left;
  }
  .topmenu-container {
    position: absolute;
    left: 50px;
  }
  .errLog-container {
    display: inline-block;
    vertical-align: top;
  }
  .right-menu {
    float: right;
    height: 100%;
    line-height: 50px;
    &:focus {
      outline: none;
    }
    .right-menu-item {
      display: inline-block;
      padding: 0 8px;
      height: 100%;
      font-size: 18px;
      color: #5a5e66;
      vertical-align: text-bottom;
      &.hover-effect {
        cursor: pointer;
        transition: background .3s;
        &:hover {
          background: rgba(0, 0, 0, .025)
        }
      }
    }
    .avatar-container {
      margin-right: 30px;
      .avatar-wrapper {
        margin-top: 5px;
        position: relative;
        .user-avatar {
          cursor: pointer;
          width: 40px;
          height: 40px;
          border-radius: 10px;
        }
        .el-icon-caret-bottom {
          cursor: pointer;
          position: absolute;
          right: -20px;
          top: 25px;
          font-size: 12px;
        }
      }
    }
  }
}
</style>

import request from '@/utils/request'
// 获取前三个通知用于平时展示
export function getNoticeListTop3(query) {
  return request({
    url: '/system/notice/listTop3/',
    method: 'get',
    params: query
  })
}


文章标签：
Java
JavaScript
前端开发
网络协议
Spring
安全
API
关键词：
Spring boot vue
Spring Boot消息推送
springboot消息推送
Spring Boot webSocket
springboot WebSocket
七维大脑
目录
相关文章
智物科技库
|
9月前
|
人工智能 前端开发 JavaScript
SpringBoot实现网页消息推送的5种方法
本文详细介绍了在SpringBoot中实现网页消息推送的几种主流方案，包括短轮询、长轮询、SSE（Server-Sent Events）、WebSocket以及STOMP。每种方案各有优缺点，适用于不同的场景需求。短轮询简单易实现但效率低；长轮询提升了实时性但仍有限制；SSE适合单向通信且轻量高效；WebSocket支持全双工通信，适合高实时性要求的场景；STOMP基于WebSocket，提供更高级的消息传递功能。通过对比分析，开发者可根据业务需求、性能要求及浏览器兼容性选择最适合的技术方案，同时可结合多种技术实现优雅降级，优化用户体验。
智物科技库
1747 57
最好zzz
|
开发框架 前端开发 网络协议
Spring Boot结合Netty和WebSocket，实现后台向前端实时推送信息
【10月更文挑战第18天】 在现代互联网应用中，实时通信变得越来越重要。WebSocket作为一种在单个TCP连接上进行全双工通信的协议，为客户端和服务器之间的实时数据传输提供了一种高效的解决方案。Netty作为一个高性能、事件驱动的NIO框架，它基于Java NIO实现了异步和事件驱动的网络应用程序。Spring Boot是一个基于Spring框架的微服务开发框架，它提供了许多开箱即用的功能和简化配置的机制。本文将详细介绍如何使用Spring Boot集成Netty和WebSocket，实现后台向前端推送信息的功能。
最好zzz
3515 1
pickstar-33775
|
9月前
|
Java
SpringBoot快速搭建WebSocket服务端和客户端
由于工作需要,研究了SpringBoot搭建WebSocket双向通信的过程,其他的教程看了许多,感觉讲得太复杂,很容易弄乱,这里我只展示快速搭建过程。
pickstar-33775
2564 1
WanderInk-20107
|
10月前
|
JavaScript 前端开发 Java
Spring Boot 与 Vue.js 前后端分离中的数据交互机制
本文深入探讨了Spring Boot与Vue.js在前后端分离架构下的数据交互机制。通过对比传统`model.addAttribute()`方法与RESTful API的设计，分析了两者在耦合性、灵活性及可扩展性方面的差异。Spring Boot以RESTful API提供数据服务，Vue.js借助Axios消费API并动态渲染页面，实现了职责分明的解耦架构。该模式显著提升了系统的灵活性和维护性，适用于复杂应用场景如论坛、商城系统等，为现代Web开发提供了重要参考。
WanderInk-20107
1055 0
大数据文摘
|
12月前
|
消息中间件 XML 前端开发
springBoot集成websocket实时消息推送
本文介绍了如何在Spring Boot项目中集成WebSocket实现实时消息推送。首先，通过引入`spring-boot-starter-websocket`依赖，配置`WebSocketConfig`类来启用WebSocket支持。接着，创建`WebSocketTest`服务器类，处理连接、消息收发及错误等事件，并使用`ConcurrentHashMap`管理用户连接。最后，前端通过JavaScript建立WebSocket连接，监听消息并进行相应处理。此方案适用于需要实时通信的应用场景，如聊天室、通知系统等。
大数据文摘
2091 2
程序员皮皮林
|
前端开发 Java C++
RSocket vs WebSocket：Spring Boot 3.3 中的两大实时通信利器
本文介绍了在 Spring Boot 3.3 中使用 RSocket 和 WebSocket 实现实时通信的方法。RSocket 是一种高效的网络通信协议，支持多种通信模式，适用于微服务和流式数据传输。WebSocket 则是一种标准协议，支持全双工通信，适合实时数据更新场景。文章通过一个完整的示例，展示了如何配置项目、实现前后端交互和消息传递，并提供了详细的代码示例。通过这些技术，可以大幅提升系统的响应速度和处理效率。
程序员皮皮林
687 5
星兽
|
7月前
|
Java Spring 容器
SpringBoot自动配置的原理是什么?
Spring Boot自动配置核心在于@EnableAutoConfiguration注解，它通过@Import导入配置选择器，加载META-INF/spring.factories中定义的自动配置类。这些类根据@Conditional系列注解判断是否生效。但Spring Boot 3.0后已弃用spring.factories，改用新格式的.imports文件进行配置。
星兽
1145 0
2G冲浪词条
|
8月前
|
人工智能 Java 测试技术
Spring Boot 集成 JUnit 单元测试
本文介绍了在Spring Boot中使用JUnit 5进行单元测试的常用方法与技巧，包括添加依赖、编写测试类、使用@SpringBootTest参数、自动装配测试模块（如JSON、MVC、WebFlux、JDBC等），以及@MockBean和@SpyBean的应用。内容实用，适合Java开发者参考学习。
2G冲浪词条
916 0
凉凉心.
|
4月前
|
JavaScript Java Maven
【SpringBoot（二）】带你认识Yaml配置文件类型、SpringMVC的资源访问路径 和 静态资源配置的原理！
SpringBoot专栏第二章，从本章开始正式进入SpringBoot的WEB阶段开发，本章先带你认识yaml配置文件和资源的路径配置原理，以方便在后面的文章中打下基础
凉凉心.
446 3
凉凉心.
|
4月前
|
Java 测试技术 数据库连接
【SpringBoot（四）】还不懂文件上传？JUnit使用？本文带你了解SpringBoot的文件上传、异常处理、组件注入等知识！并且带你领悟JUnit单元测试的使用！
Spring专栏第四章，本文带你上手 SpringBoot 的文件上传、异常处理、组件注入等功能 并且为你演示Junit5的基础上手体验
凉凉心.
961 2

热门文章

最新文章

  • 1
    设计一个百万级的消息推送系统
  • 2
    阿里云消息推送服务
  • 3
    Netty-SocketIO：最好用的Java版即时消息推送
  • 4
    MQTT C Client实现消息推送（入门指南）
  • 5
    微信模板消息推送遇到的坑
  • 6
    APP消息推送到达率评估方案
  • 7
    java ,apns, javapns ios消息推送 吐槽
  • 8
    SpringBoot助力！轻松实现微信模版消息推送
  • 9
    iOS小技能：消息推送扩展的使用
  • 10
    uniapp小程序订阅消息推送+Thinkphp5后端代码教程示例
  • 1
    基于 Spring AI Alibaba + Nacos 的分布式 Multi-Agent 构建指南
    3424
  • 2
    Spring AI Alibaba Admin 开源！以数据为中心的 Agent 开发平台
    5478
  • 3
    Spring Boot自动装配
    515
  • 4
    【Spring Boot实战】EasyPoi神技：一篇搞定“一对多+图片”导入！
    1133
  • 5
    《深入理解Spring》性能监控与优化——构建高性能应用的艺术
    356
  • 6
    《深入理解Spring》单元测试——高质量代码的守护神
    387
  • 7
    《深入理解Spring》定时任务——自动化调度的时间管理者
    608
  • 8
    《深入理解Spring》事务管理——数据一致性的守护者
    352
  • 9
    《深入理解Spring》过滤器（Filter）——Web请求的第一道防线
    702
  • 10
    《深入理解Spring》拦截器（Interceptor）——请求处理的艺术
    401

    • 相关课程

    更多
  • SpringBoot实战教程
  • SpringBoot快速掌握 - 核心技术
  • SpringBoot快速掌握 - 高级应用
  • Vue.js 入门与实战
  • Vue.js完全自学手册图文教程
  • Springboot项目云开发快速迁移

    • 相关电子书

    更多
  • Vue.js 在前端服务化上的探索与实践
  • Vue.js在前端服务化上的实践与探索
  • 低代码开发师（初级）实战教程
    • 下一篇
    第五届伏魔挑战赛如约来袭，诚邀各路高手来战！