前端實現(xiàn)簡單的sse封裝方式(React hook Vue3)

更新時間：2024年08月29日 09:27:25 作者：bigHead-

這篇文章主要介紹了前端實現(xiàn)簡單的sse封裝方式(React hook Vue3),具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教

什么是SSE？

所謂的SSE(Sever-Sent Event)，就是瀏覽器向服務器發(fā)送了一個HTTP請求，保持長連接，服務器不斷單向地向瀏覽器推送“信息”，這么做是為了節(jié)省網(wǎng)絡資源，不用一直發(fā)請求，建立新連接。

優(yōu)點：SSE和WebSocket相比，最大的優(yōu)勢是便利，服務端不需要第三方組件，開發(fā)難度低，SSE和輪詢相比它不用處理很多請求，不用每次建立新連接，延遲低。
缺點：如果客戶端有很多需要保持很多長連接，這回占用大量內(nèi)存和連接數(shù)。

封裝簡單的SSE，以React hook為例

可參考簡單的websocket封裝

新建sse.ts文件

import {useState, useRef, useEffect} from 'react'

const useSSE = (url: string) => {
    const source = useRef<EventSource | null>(null)
    //接收到的sse數(shù)據(jù)
    const [sseData, setSseData] = useState({})

    // sse狀態(tài)
    const [sseReadyState, setSseReadyState] = useState({
        key: 0,
        value: '正在鏈接中',
    })

    const creatSource = () => {
        const stateArr = [
            {key: 0, value: '正在鏈接中'},
            {key: 1, value: '已經(jīng)鏈接并且可以通訊'},
            {key: 2, value: '連接已關閉或者沒有鏈接成功'},
        ]

        try {
            source.current = new EventSource(url)
            source.current.onopen = (_e) => {
                setSseReadyState(stateArr[source.current?.readyState ?? 0])
            }

            source.current.onerror = (e) => {
                setSseReadyState(stateArr[source.current?.readyState ?? 0])
            }
            source.current.onmessage = (e) => {
                setSseData({...JSON.parse(e.data)})
            }
        } catch (error) {
            console.log(error)
        }
    }

    const sourceInit = () => {
        if (!source.current || source.current.readyState === 2) {
            creatSource()
        }
    }

    //  關閉 WebSocket
    const closeSource = () => {
        source.current?.close()
    }

    //重連
    const reconnectSSE = () => {
        try {
            closeSource()
            source.current = null
            creatSource()
        } catch (e) {
            console.log(e)
        }
    }

    useEffect(() => {
        sourceInit()
    },[])

    return {
        sseData,
        sseReadyState,
        closeSource,
        reconnectSSE,
    }
}
export default useSSE

這里一共暴露出四個參數(shù)。

分別是 sseData（接收到的 sse數(shù)據(jù)）、sseReadyState（當前 sse狀態(tài)）、closeSource（關閉 sse）、reconnectSSE（重連）。

通過這幾個簡單的參數(shù)能夠覆蓋一般場景的需要。

下面代碼為使用方法

import React, { useState, useEffect } from 'react'
import useWebsocket from '../../tools/webSocket'
export default function () {
	const {sseData,sseReadyState, closeSource,reconnectSSE} = useSSE(url)

	useEffect(() => {
        console.log( '當前狀態(tài)'，sseReadyState)
    },[sseReadyState])

	useEffect(() => {
        console.log( '接收到的數(shù)據(jù)'，sseData)
    }, [sseData])
}

使用vue3實現(xiàn)

import { ref } from "vue";

const useSSE = (url: string) => {
  const source = ref<EventSource | null>(null);

  //接收到的sse數(shù)據(jù)
  const sseData = ref({});

  // sse狀態(tài)
  const readyState = ref({ key: 0, value: "正在鏈接中" });

  const creatSource = () => {
    const stateArr = [
      { key: 0, value: "正在鏈接中" },
      { key: 1, value: "已經(jīng)鏈接并且可以通訊" },
      { key: 2, value: "連接已關閉或者沒有鏈接成功" },
    ];

    try {
      source.value= new EventSource(url);
      source.value.onopen = (e) => {
        readyState.value = stateArr[source.value?.readyState ?? 0];
      };

      source.value.onerror = (e) => {
        readyState.value = stateArr[source.value?.readyState ?? 0];
      };
      source.value.onmessage = (e) => {
        e.data && (sseData.value = { ...JSON.parse(e.data) });
      };
    } catch (error) {
      console.log(error);
    }
  };

  const sourceInit = () => {
    if (!source.value|| source.value.readyState === 2) {
      creatSource();
    }
  };

  //  關閉 WebSocket
  const closeSource = () => {
    source.value?.close();
  };

  //重連
  const reconnectSSE = () => {
    try {
      closeSource();
      source.value= null;
      creatSource();
    } catch (e) {
      console.log(e);
    }
  };

  return {
    sseData,
    readyState,
    sourceInit,
    closeSource,
    reconnectSSE,
  };
};
export default useSSE;