Vue3 + Ts + Vite项目 websoket封装使用

本文主要是介绍Vue3 + Ts + Vite项目 websoket封装使用，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

---

一、安装

npm

npm install websocket --save-dev

pnpm

pnpm install websocket --save-dev

---

二、封装

在 /src/utils 文件夹下创建 websocket.ts 文件，并放入如下代码

import { onUnmounted } from 'vue'//设置
interface SocketOptions {//心跳间隔heartbeatInterval?: number//超时重传reconnectInterval?: number//最大重传次数maxReconnectAttempts?: number
}class Socket {//路径url: stringws: WebSocket | null = nullopts: SocketOptions//重传次数reconnectAttempts: number = 0listeners: { [key: string]: Function[] } = {}//心跳间隔heartbeatInterval: number | null = null//构造函数constructor(url: string, opts: SocketOptions = {}) {this.url = urlthis.opts = {//心跳间隔heartbeatInterval: 30000,//超时重传reconnectInterval: 5000,//最大重传次数maxReconnectAttempts: 5,...opts}this.init()}//初始化init() {this.ws = new WebSocket(this.url)this.ws.onopen = this.onOpen.bind(this)this.ws.onmessage = this.onMessage.bind(this)this.ws.onerror = this.onError.bind(this)this.ws.onclose = this.onClose.bind(this)}//打开onOpen(event: Event) {console.log('WebSocket opened:', event)this.reconnectAttempts = 0this.startHeartbeat()this.emit('open', event)}//收到的WebSocket消息onMessage(event: MessageEvent) {// console.log('WebSocket message received:', event.data);this.emit('message', event.data)}//错误onError(event: Event) {console.error('WebSocket error:', event)this.emit('error', event)}//重连逻辑中，在连接失败后自动重新连接onClose(event: CloseEvent) {console.log('WebSocket closed:', event)this.stopHeartbeat()this.emit('close', event)//重连逻辑中，在连接失败后自动重新连接，但会限制重连的次数和每次重连之间的间隔时间if (this.opts.maxReconnectAttempts !== 0 && this.reconnectAttempts < this.opts.maxReconnectAttempts!) {setTimeout(() => {// console.log("我有错误了1111111111111111111111111111111111111");this.reconnectAttempts++this.init()}, this.opts.reconnectInterval)}}//开始心跳检测startHeartbeat() {if (!this.opts.heartbeatInterval) returnthis.heartbeatInterval = window.setInterval(() => {if (this.ws?.readyState === WebSocket.OPEN) {this.ws.send('ping')}}, this.opts.heartbeatInterval)}//停止心跳检测stopHeartbeat() {if (this.heartbeatInterval) {clearInterval(this.heartbeatInterval)this.heartbeatInterval = null}}//发送消息send(data: string) {if (this.ws?.readyState === WebSocket.OPEN) {this.ws.send(data)} else {console.error('WebSocket is not open. Cannot send:', data)}}//事件监听器注册功能的实现on(event: string, callback: Function) {if (!this.listeners[event]) {this.listeners[event] = []}this.listeners[event].push(callback)}//从事件监听器中移除off(event: string) {if (this.listeners[event]) {delete this.listeners[event]}}//在事件监听器中触发一个指定的事件emit(event: string, data: any) {this.listeners[event]?.forEach(callback => callback(data))}
}export function useSocket(url: string, opts?: SocketOptions) {const socket = new Socket(url, opts)onUnmounted(() => {socket.off('open')socket.off('message')socket.off('error')socket.off('close')socket.ws?.close() // 关闭WebSocket连接})return {socket,send: socket.send.bind(socket),on: socket.on.bind(socket),off: socket.off.bind(socket)}
}

---

三、请求地址配置

3.1 将接口地址放到 public

3.2 引入 ipconfig.js 文件

3.3 全局类型声明

declare global {/*** Window 的类型提示*/interface Window {__APP_INFO__: __APP_INFO__global_config: { wsURL: string }}
}

---

四、页面使用

4.1 引用

import { useSocket } from '@/utils/websocket'

4.2 注册

// 注意：此处 useSocket() 中用的就是我们配置的全局地址
// 开发结束，打包给后端，后端同时可以自行修改 ipconfig.js 文件中 websokect 地址，这样部署上线之后 websokect 也能正常运行
const { socket, on } = useSocket((window as any).global_config.wsURL)on('close', () => console.log('Socket closed!'))
//webSocket连接上服务器时
on('open', (event: any) => {console.log('webSocket连接上服务器时', event)
})
socket.on('message', (data: any) => {if (data) {// TODO: 此处拿到后端推送过来的数据，进行你后续的数据渲染逻辑console.log(JSON.parse(data))}
})

---

五、说明

这篇关于Vue3 + Ts + Vite项目 websoket封装使用的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！

---