SpringBoot+SseEmitter和Vue3+EventSource實現實時數據推送

更新時間：2025年03月04日 08:33:29 作者：麥當勞不要薯條

本文主要介紹了SpringBoot+SseEmitter和Vue3+EventSource實現實時數據推送,文中通過示例代碼介紹的非常詳細,對大家的學習或者工作具有一定的參考學習價值,需要的朋友們下面隨著小編來一起學習學習吧

EventSource 的優(yōu)點

簡單易用：EventSource 使用簡單，基于標準的 HTTP 協議，無需復雜的握手過程。
自動重連：EventSource 具有內置的重連機制，確保連接中斷后自動重新連接。
輕量級：EventSource 使用長輪詢機制，消耗的資源相對較少，適合低帶寬環(huán)境。
跨域支持：EventSource 允許在跨域環(huán)境下進行通信，通過適當的響應頭授權來自不同域的客戶端連接。

1、SpringBoot實現SseEmitter

1.1簡易業(yè)務層

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("后端發(fā)送消息：" + 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 }) // 后端接口，要配置允許跨域屬性
    // 與事件源的連接剛打開時觸發(fā)
    evtSource.onopen = function(e){
      console.log(e);
    }

    // 當從事件源接收到數據時觸發(fā)
    evtSource.onmessage = function(e){
      console.log(e);
    }
    // 與事件源的連接無法打開時觸發(fā)
    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"接口發(fā)送消息

在這里插入圖片描述

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