Vue websocket封装实现方法详解

 更新时间:2022年09月29日 09:57:09   作者:37 degrees Celsius  
项目中需要使用websocke,这个是我自己修修改改好多次之后用得最顺手的一版,分享一下。这个封装需要搭配vuex使用,因为收到的数据都保存在vuex中了,真的绝绝子好用,解决了我一大堆问题

1.封装的ws.js文件

let global_callback = null
let socket = '' // 存储 WebSocket 连接.
let timeoutObj = null  // 心跳定时器
let serverTimoutObj = null // 服务超时定时关闭
let lockReconnect = false // 是否真正建立了连接
let timeoutnum = null // 重新连接的定时器,  没连接上会一直重连,设置延迟避免请求过多
const socketConfig = {
  url: '',
  retryTimeout: 20000 // 心跳时间 暂定20s
}
export const sendWebsocket = function (agentData, callback) {
  global_callback = callback
  socketOnSend(agentData)
}
export const initWebSocket = function (url) {
  let weburl = url || socketConfig.url
  if (window.WebSocket) { return }
  if (!socket) {
    socket = new WebSocket(weburl)
    socketOnOpen()
    socketOnClose()
    socketOnError()
    socketOnMessage()
  }
}
/**
 * 关闭websocket函数
 */
export const closeWebsocket = function () {
  if (socket) {
    socket.close()
  }
  clearTimeout(timeoutObj)
  clearTimeout(serverTimoutObj)
}
function socketOnSend(data) {
  socket.send(data)
}
function socketOnOpen() {
  socket.onopen = () => {
    console.log('socket连接成功')
    start()
  }
}
// 开启心跳
function start() {
  timeoutObj && clearTimeout(timeoutObj)
  serverTimoutObj && clearTimeout(serverTimoutObj)
  timeoutObj = setTimeout(() => {
    // 这里发送一个心跳,后端收到后返回一个心跳消息
    if (socket.readyState === 1) {
      // 如果连接正常  给后端发送指定消息
      socket.send('')
      console.log('发送消息')
    } else {
      // 重连
      reconnect()
    }
    serverTimoutObj = setTimeout(() => {
      // 超时关闭连接
      socket.close()
    }, socketConfig.retryTimeout);
  }, socketConfig.retryTimeout);
}
// 重连
function reconnect() {
  if (lockReconnect) {
    return
  }
  lockReconnect = true
  timeoutnum && clearTimeout(timeoutnum)
  timeoutnum = setTimeout(() => {
    initWebSocket()
    lockReconnect = false
  }, 5000);
}
function socketOnClose() {
  socket.onclose = () => {
    console.log('socket已经关闭')
  }
}
function socketOnError() {
  socket.onerror = () => {
    reconnect()
    console.log('socket 连接失败')
  }
}
function socketOnMessage() {
  socket.onmessage = (e) => {
    global_callback(e.data)
    reset()
  }
}
// 重置心跳
function reset() {
  // 清除时间
  clearTimeout(timeoutObj)
  clearTimeout(serverTimoutObj)
  // 重启心跳
  start()
}

这里的封装export了三个方法

  • initWebSocket 用来初始化websock,可传入url
  • sendWebsocket 用来发送数据
  • closeWebsocket 用来关闭连接

2.使用方法

文件存放路径: /src/utils/ws.js

所需文件中按需引入

 1.首先需要再项目中进行初始化,如果你的项目有登陆的话,则你可以再home.vue里面进行引入:
 ```vue
 import { initWebSocket } from ‘@/utils/ws.js’
 ···
 eport default {
      created () {
         initWebSocket ()
     } 
 }
 ```

 2. 然后在你需要获取实时数据的地方进行引入并调用 sendWebsocket 
 ```vue
 import { sendWebsocket } from ‘@/utils/ws.js’
 ···
 eport default {
      created () {
         sendWebsocket (this.onWebSocketMessage)
     },
     methods: {
         onWebSocketMessage(data) {}
     }
 }
 ```

关闭websock

 import { closeSock} from "@/api/socket";
 export default {
 	destoryed () {
 		closeSock()
 	}
 }

到此这篇关于Vue websocket封装实现方法详解的文章就介绍到这了,更多相关Vue websocket封装内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • Vue的生命周期一起来看看

    Vue的生命周期一起来看看

    这篇文章主要为大家详细介绍了Vue的生命周期,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下,希望能够给你带来帮助
    2022-02-02
  • Vue实现剪贴板复制功能

    Vue实现剪贴板复制功能

    这篇文章主要介绍了Vue实现剪贴板复制功能,本文给大家介绍的非常详细,具有一定的参考借鉴价值,需要的朋友可以参考下
    2019-12-12
  • Javascript对象及Proxy工作原理详解

    Javascript对象及Proxy工作原理详解

    这篇文章主要为大家介绍了Javascript对象及Proxy工作原理详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2022-08-08
  • vue3.0如何修改浏览器标题(静态)

    vue3.0如何修改浏览器标题(静态)

    这篇文章主要介绍了vue3.0如何修改浏览器标题(静态),具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-09-09
  • vue todo-list组件发布到npm上的方法

    vue todo-list组件发布到npm上的方法

    这篇文章主要介绍了vue todo-list组件发布到npm上的方法,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2018-04-04
  • vue使用Vue.extend创建全局toast组件实例

    vue使用Vue.extend创建全局toast组件实例

    这篇文章主要介绍了vue使用Vue.extend创建全局toast组件实例,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2023-03-03
  • vue-content-loader内容加载器的使用方法

    vue-content-loader内容加载器的使用方法

    这篇文章主要介绍了vue-content-loader内容加载器的使用方法,本文分步骤给大家介绍的非常详细,具有一定的参考借鉴价值,需要的朋友可以参考下
    2018-08-08
  • vue中解决微信html5原生ios虚拟键返回不刷新问题

    vue中解决微信html5原生ios虚拟键返回不刷新问题

    这篇文章主要介绍了vue中解决微信html5原生ios虚拟键返回不刷新问题,本文给大家分享解决方法,通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2020-10-10
  • Vue-router跳转和location.href的区别及说明

    Vue-router跳转和location.href的区别及说明

    Vue Router是Vue.js官方的路由管理器,它允许我们通过定义路由来管理应用程序的不同视图和状态,Vue路由跳转主要有以下几种方式:<router-link>标签、this.$router.push方法、this.$router.replace方法和this.$router.go方法
    2025-01-01
  • 关于vue src路径动态拼接的小知识

    关于vue src路径动态拼接的小知识

    这篇文章主要介绍了vue src路径动态拼接的小知识,具有很好的参考价值,希望对大家有所帮助。
    2022-04-04

最新评论