WebSocket vue

叁歲伎倆 2022-11-26 03:59 172阅读 0赞

## 本文转载于[此篇博客][Link 1] ##

## 一、在utils目录下创建websocket.js文件 ##

import { Message } from 'element-ui'
    import { getToken } from '@/utils/authToken' // 与后端的协商，websocket请求需要带上token参数
    let websock = null
    let messageCallback = null
    let errorCallback = null
    let wsUrl = ''
     
    // 接收ws后端返回的数据
    function websocketonmessage (e) { 
      messageCallback(JSON.parse(e.data))
    }
     
    /**
     * 发起websocket连接
     * @param {Object} agentData 需要向后台传递的参数数据
     */
    function websocketSend (agentData) {
      // 加延迟是为了尽量让ws连接状态变为OPEN   
      setTimeout(() => { 
        // 添加状态判断，当为OPEN时，发送消息
        if (websock.readyState === websock.OPEN) { // websock.OPEN = 1 
          // 发给后端的数据需要字符串化
          websock.send(JSON.stringify(agentData))
        }
        if (websock.readyState === websock.CLOSED) { // websock.CLOSED = 3 
          console.log('websock.readyState=3')
          Message.error('ws连接异常，请稍候重试')
          errorCallback()
        }
      }, 500)
    }
     
    // 关闭ws连接
    function websocketclose (e) {  
      // e.code === 1000  表示正常关闭。 无论为何目的而创建, 该链接都已成功完成任务。
      // e.code !== 1000  表示非正常关闭。
      if (e && e.code !== 1000) {
        Message.error('ws连接异常，请稍候重试')
        errorCallback()
      }
    }
    // 建立ws连接
    function websocketOpen (e) {
      // console.log('ws连接成功')
    }
     
    // 初始化weosocket
    function initWebSocket () { 
      if (typeof (WebSocket) === 'undefined') {
        Message.error('您的浏览器不支持WebSocket，无法获取数据')
        return false
      }
      
      const token = 'JWT=' + getToken()
      // ws请求完整地址
      const requstWsUrl = wsUrl + '?' + token
      websock = new WebSocket(requstWsUrl)
    
      websock.onmessage = function (e) {
        websocketonmessage(e)
      } 
      websock.onopen = function () {
        websocketOpen()
      }
      websock.onerror = function () {
        Message.error('ws连接异常，请稍候重试')
        errorCallback()
      }
      websock.onclose = function (e) {
        websocketclose(e)
      } 
    }
     
    /**
     * 发起websocket请求函数
     * @param {string} url ws连接地址
     * @param {Object} agentData 传给后台的参数
     * @param {function} successCallback 接收到ws数据，对数据进行处理的回调函数
     * @param {function} errCallback ws连接错误的回调函数
     */
    export function sendWebsocket (url, agentData, successCallback, errCallback) { 
      wsUrl = url
      initWebSocket()
      messageCallback = successCallback
      errorCallback = errCallback
      websocketSend(agentData)
    }
    
    /**
     * 关闭websocket函数
     */
    export function closeWebsocket () {
      if (websock) {
        websock.close() // 关闭websocket
        websock.onclose() // 关闭websocket
      }
    }

## 二、在vue组件中使用WebSocket封装好的功能 ##

<template>
      <div>
        <button @click="requstWs">点击发起websocket请求</button>
      </div>
    </template>
    <script>
    import { sendWebsocket, closeWebsocket } from '@/utils/websocket.js'
    
    export default {
      beforeDestroy () {
        // 页面销毁时关闭ws。因为有可能ws连接接收数据尚未完成，用户就跳转了页面
        // 在需要主动关闭ws的地方都可以调用该方法
        closeWebsocket()
      },
      methods: {
        // ws连接成功，后台返回的ws数据，组件要拿数据渲染页面等操作
        wsMessage (data) {
          const dataJson = data
          console.log(dataJson)
          // 这里写拿到数据后的业务代码
        },
        // ws连接失败，组件要执行的代码
        wsError () {
          // 比如取消页面的loading
        },
        requstWs () {
          // 防止用户多次连续点击发起请求，所以要先关闭上次的ws请求。
          closeWebsocket()
          // 跟后端协商，需要什么参数数据给后台
          const obj = {
            monitorUrl: 'xxxxxxxxxxxxx',
            userName: 'xxxxxxxxxx'
          }
          // 发起ws请求
          sendWebsocket('ws://test.ws.com', obj, this.wsMessage, this.wsError)
        }
      }
    }
    </script>

[Link 1]: https://blog.csdn.net/m0_38134431/article/details/105794108