vue3+ts前端封装EventSource并在请求头添加token的方法

 更新时间:2024年12月21日 15:54:21   作者:全能全知者  
这篇文章主要介绍了vue3+ts前端封装EventSource并在请求头添加token,本文将介绍如何使用 event-source-polyfill 来解决这个问题,需要的朋友可以参考下

vue3+ts前端封装 EventSource 并在请求头添加 token

背景介绍

在前端开发中,我们经常需要使用 Server-Sent Events (SSE) 来实现服务器向客户端推送数据。但原生的 EventSource 不支持在请求头中添加自定义字段,这使得我们无法添加 token 等认证信息。本文将介绍如何使用 event-source-polyfill 来解决这个问题。

环境准备

首先需要安装 event-source-polyfill 依赖:

npm install event-source-polyfill
# 或
yarn add event-source-polyfill
# 或
pnpm install event-source-polyfill

如果是ts项目,同时还需要安装对应的类型声明文件:

npm install @types/event-source-polyfill -D
# 或  
yarn add @types/event-source-polyfill -D
# 或
pnpm install @types/event-source-polyfill -D

封装 SSE 连接方法

在 http 工具类中,我们可以这样封装 SSE 连接:
http.ts

import { EventSourcePolyfill } from 'event-source-polyfill'
import store from '@/store'
import type { StateAll } from '@/store'
interface SSEOptions {
  onMessage?: (data: any) => void
  onError?: (error: any) => void 
  onOpen?: () => void
}
// 创建 SSE 连接
function createSSEConnection(url: string, options?: SSEOptions) {
  // 从 store 中获取 token
  const token = (store.state as StateAll).user.token
  // 创建 EventSource 实例,添加 token
  const eventSource = new EventSourcePolyfill(BASE_URL + url, {
    headers: {
      'Authorization': token
    }
  })
  // 连接成功回调
  eventSource.addEventListener('open', () => {
    console.log('SSE连接成功')
    options?.onOpen?.()
  })
  // 接收消息回调
  eventSource.addEventListener('message', (event: any) => {
    try {
      const data = JSON.parse(event.data)
      options?.onMessage?.(data)
    } catch (error) {
      console.error('解析消息失败:', error)
      options?.onMessage?.([])
    }
  })
  // 错误处理
  eventSource.addEventListener('error', (error: any) => {
    console.error('SSE连接错误:', error)
    // token 失效处理
    if (error?.status === 401) {
      store.commit('user/clearToken')
      window.location.replace('/login')
      return
    }
    options?.onError?.(error)
  })
  return {
    eventSource,
    close: () => {
      eventSource.close()
    }
  }
}

使用示例

在组件中使用封装好的 SSE 连接:

const unreadMessages = ref<ElectricityMessage[]>([])
let sseConnection: { close: () => void } | null = null
// 建立 SSE 连接
sseConnection = http.createSSEConnection('messages/unread', {
  onOpen: () => {
    console.log('消息连接已建立')
  },
  onMessage: (data) => {
    unreadMessages.value = data
  },
  onError: (error) => {
    console.error('消息连接错误:', error)
  }
})
// 组件销毁时关闭连接
onUnmounted(() => {
  sseConnection?.close()
})

关键点说明

使用 event-source-polyfill 替代原生 EventSource,支持添加自定义请求头

  • 在创建连接时从 store 中获取 token 并添加到请求头
  • 处理连接成功、接收消息、错误等事件
  • 提供关闭连接的方法,在组件销毁时调用
  • 对 token 失效等特殊错误进行处理

注意事项

  • 确保后端支持 SSE 连接并正确处理 token
  • 注意在组件销毁时及时关闭连接,避免内存泄漏
  • 建议对接收到的消息做 try-catch 处理,避免解析失败导致程序崩溃
  • 可以根据实际需求扩展更多的事件处理和错误处理逻辑

通过以上封装,我们就可以在前端优雅地使用带有 token 认证的 SSE 连接了。这种方式既保证了安全性,又提供了良好的开发体验。

到此这篇关于vue3+ts前端封装EventSource并在请求头添加token的文章就介绍到这了,更多相关vue请求头添加token内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • 简单了解Vue computed属性及watch区别

    简单了解Vue computed属性及watch区别

    这篇文章主要介绍了通过实例解析Vue computed属性及watch区别,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-07-07
  • vue组件之全局注册和局部注册方式

    vue组件之全局注册和局部注册方式

    这篇文章主要介绍了vue组件之全局注册和局部注册方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2024-03-03
  • vue3中实现异步组件的方法实例

    vue3中实现异步组件的方法实例

    前端开发经常遇到异步的问题,请求函数、链接库等,下面这篇文章主要给大家介绍了关于vue3中实现异步组件的相关资料,文中通过实例代码介绍的非常详细,需要的朋友可以参考下
    2023-06-06
  • Vue3中多个弹窗同时出现的解决思路

    Vue3中多个弹窗同时出现的解决思路

    这篇文章主要介绍了Vue3中多个弹窗同时出现的解决思路,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2024-02-02
  • vue跨域解决方法

    vue跨域解决方法

    这篇文章主要介绍了vue跨域解决方法 ,需要的朋友可以参考下
    2017-10-10
  • vue-cli脚手架build目录下utils.js工具配置文件详解

    vue-cli脚手架build目录下utils.js工具配置文件详解

    这篇文章主要介绍了vue-cli脚手架build目录下utils.js工具配置文件详解,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2018-09-09
  • vue-Split实现面板分割

    vue-Split实现面板分割

    这篇文章主要为大家详细介绍了vue-Split实现面板分割,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2022-03-03
  • vue3输入无效路由跳转到指定error页面问题

    vue3输入无效路由跳转到指定error页面问题

    这篇文章主要介绍了vue3输入无效路由跳转到指定error页面问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2024-03-03
  • 浅谈关于.vue文件中style的scoped属性

    浅谈关于.vue文件中style的scoped属性

    本篇文章主要主要介绍了浅谈关于.vue文件中style的scoped属性,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-08-08
  • vue如何给页面增加url前缀

    vue如何给页面增加url前缀

    这篇文章主要介绍了vue如何给页面增加url前缀问题,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-12-12

最新评论