SpringBoot+SseEmitter和Vue3+EventSource实现实时数据推送

 更新时间:2025年03月04日 08:33:29   作者:麦当劳不要薯条  
本文主要介绍了SpringBoot+SseEmitter和Vue3+EventSource实现实时数据推送,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧

EventSource 的优点

  • 简单易用:EventSource 使用简单,基于标准的 HTTP 协议,无需复杂的握手过程。
  • 自动重连:EventSource 具有内置的重连机制,确保连接中断后自动重新连接。
  • 轻量级:EventSource 使用长轮询机制,消耗的资源相对较少,适合低带宽环境。
  • 跨域支持:EventSource 允许在跨域环境下进行通信,通过适当的响应头授权来自不同域的客户端连接。

1、SpringBoot实现SseEmitter

1.1简易业务层

import org.springframework.http.MediaType;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.servlet.mvc.method.annotation.SseEmitter;

import java.io.IOException;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;

/**
 * Author tm
 * Date 2023/9/25
 * Version 1.0
 */
@RestController
@RequestMapping(path = "/sysTest/see")
public class SseControllerTest {
    private static Map<String, SseEmitter> sseCache = new ConcurrentHashMap<>();


    /**
     * 前端传递标识,生成唯一的消息通道
     */
    @GetMapping(path = "subscribe", produces = {MediaType.TEXT_EVENT_STREAM_VALUE})
    public SseEmitter push(String id) throws IOException {
        // 超时时间设置为3s,用于演示客户端自动重连
        SseEmitter sseEmitter = new SseEmitter(30000L);
        // 设置前端的重试时间为1s
        sseEmitter.send(SseEmitter.event().reconnectTime(1000).data("连接成功"));
        sseCache.put(id, sseEmitter);
        System.out.println("add " + id);
        sseEmitter.onTimeout(() -> {
            System.out.println(id + "超时");
            sseCache.remove(id);
        });
        sseEmitter.onCompletion(() -> System.out.println("完成!!!"));
        return sseEmitter;
    }

    /**
     * 根据标识传递信息
     */
    @GetMapping(path = "push")
    public String push(String id, String content) throws IOException {
        SseEmitter sseEmitter = sseCache.get(id);
        if (sseEmitter != null) {
            sseEmitter.send(SseEmitter.event().name("msg").data("后端发送消息:" + content));
        }
        return "over";
    }

    /**
     * 根据标识移除SseEmitter
     */
    @GetMapping(path = "over")
    public String over(String id) {
        SseEmitter sseEmitter = sseCache.get(id);
        if (sseEmitter != null) {
            sseEmitter.complete();
            sseCache.remove(id);
        }
        return "over";
    }
}

2、Vue3对接EventSource

const  initEventSource = ()=>{
  if (typeof (EventSource) !== 'undefined') {
    const evtSource = new EventSource('https://xxx.xxx.x.x/sysTest/see/subscribe?id=002', { withCredentials: true }) // 后端接口,要配置允许跨域属性
    // 与事件源的连接刚打开时触发
    evtSource.onopen = function(e){
      console.log(e);
    }

    // 当从事件源接收到数据时触发
    evtSource.onmessage = function(e){
      console.log(e);
    }
    // 与事件源的连接无法打开时触发
    evtSource.onerror = function(e){
      console.log(e);
      evtSource.close(); // 关闭连接
    }
    // 也可以侦听命名事件,即自定义的事件
    evtSource.addEventListener('msg', function(e) {
      console.log(e.data)
    })
  } else {
    console.log('当前浏览器不支持使用EventSource接收服务器推送事件!');
  }

  
}

3、测试、验证、使用

使用postMan调用接口测试

3.1、 postMan调用后端"push"接口发送消息

在这里插入图片描述

3.2、前端实时接收到数据

在这里插入图片描述

4、踩坑

4.1、nginx对于EventSource连接要特殊处理

#eventSource
location /es/ {
    proxy_pass  http://请求地址/;
    #必须要设置当前Connection 属性
    proxy_set_header Connection '';
    proxy_http_version 1.1;
    chunked_transfer_encoding off;
    proxy_buffering off;
    proxy_cache off;
}

4.2、连接通道接口类型一定要设置MediaType.TEXT_EVENT_STREAM_VALUE

在这里插入图片描述

4.3、 跨越问题,项目地址和接口地址需要在同一域名下

在这里插入图片描述

4.4 、EventSource监听事件的类型需要与后端发送的类型一致

在这里插入图片描述

在这里插入图片描述

到此这篇关于SpringBoot+SseEmitter和Vue3+EventSource实现实时数据推送的文章就介绍到这了,更多相关SpringBoot 实时数据推送内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家! 

相关文章

  • 浅谈一下Servlet的定义以及运行原理

    浅谈一下Servlet的定义以及运行原理

    相信有很多刚入行的朋友会疑惑Servlet到底是个什么意思,那么这篇文章就来浅谈一下到底什么是Servlet,以及Servlet的原理与如何写一个Servlet,,需要的朋友可以参考下
    2023-03-03
  • java线程安全锁ReentrantReadWriteLock原理分析readLock

    java线程安全锁ReentrantReadWriteLock原理分析readLock

    这篇文章主要为大家介绍了java线程安全锁ReentrantReadWriteLock原理分析readLock,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2022-10-10
  • Mybatis SqlSession案例详解

    Mybatis SqlSession案例详解

    这篇文章主要介绍了Mybatis SqlSession详解,本文我们讲了如何创建SqlSession的几个步骤,最后我们获得一个DefaultSqlSession对象,里面包含了执行器Executor和配置对象Configuration,需要的朋友可以参考下
    2023-04-04
  • SpringBoot内存数据导出成Excel的实现方法

    SpringBoot内存数据导出成Excel的实现方法

    这篇文章主要给大家介绍了关于SpringBoot内存数据导出成Excel的实现方法,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-12-12
  • Spring框架实现文件上传功能

    Spring框架实现文件上传功能

    这篇文章主要为大家详细介绍了Spring框架实现文件上传功能,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2017-11-11
  • Java二叉树的四种遍历方式详解

    Java二叉树的四种遍历方式详解

    这篇文章主要介绍了Java二叉树的四种遍历,二叉树的遍历可以分为前序、中序、后序、层次遍历,需要的朋友可以参考下
    2021-11-11
  • SpringBoot自动配置原理详解

    SpringBoot自动配置原理详解

    SpringBoot的诞生就是为了简化Spring中繁琐的XML配置,其本质依然还是Spring框架,使用SpringBoot之后可以不使用任何XML配置来启动一个服务,使得我们在使用微服务架构时可以更加快速的建立一个应用。本文将为具体介绍一下SpringBoot的原理,需要的可以参考一下
    2021-12-12
  • SpringBoot集成Druid配置(yaml版本配置文件)详解

    SpringBoot集成Druid配置(yaml版本配置文件)详解

    这篇文章主要介绍了SpringBoot集成Druid配置(yaml版本配置文件),本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2020-12-12
  • Java精确抽取网页发布时间

    Java精确抽取网页发布时间

    这篇文章主要为大家详细介绍了Java精确抽取网页发布时间的相关资料,尽量做到精确无误,感兴趣的小伙伴们可以参考一下
    2016-06-06
  • 使用Java实现读取手机文件名称

    使用Java实现读取手机文件名称

    这篇文章主要为大家详细介绍了如何使用Java实现读取手机文件名称,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下
    2024-03-03

最新评论