vue项目中引入Websocket

       第一步  创建ws  

            下面是创建 Websocket ,连接 ,心跳检查的方法

通过  typeof (WebSocket) === 'undefined' 来判断浏览器是否支持WebSocket,当前浏览器基本都支持WebSocket。

// websocket实例
let wsObj = null;
// ws连接地址
let wsUrl = null;
// let userId = null;
// 是否执行重连 true/不执行 ; false/执行
let lockReconnect = false;
// 重连定时器
let wsCreateHandler = null;
// 连接成功,执行回调函数
let messageCallback = null;
// 连接失败,执行回调函数
let errorCallback = null;
// 发送给后台的数据
let sendDatas = {};


/**
 * 发起websocket请求函数
 * @param {string} url ws连接地址
 * @param {Object} agentData 传给后台的参数
 * @param {function} successCallback 接收到ws数据,对数据进行处理的回调函数
 * @param {function} errCallback ws连接错误的回调函数
 */
export const connectWebsocket = (url, agentData, successCallback, errCallback) => {
  wsUrl = url;
  createWebSoket();
  messageCallback = successCallback;
  errorCallback = errCallback;
  sendDatas = agentData;
}

// 手动关闭websocket (这里手动关闭会执行onclose事件)
export const closeWebsocket = () => {
  if (wsObj) {
    writeToScreen('手动关闭websocket');
    wsObj.close() // 关闭websocket
    // wsObj.onclose() // 关闭websocket(如果上面的关闭不生效就加上这一条)
    // 关闭重连
    lockReconnect = true;
    wsCreateHandler && clearTimeout(wsCreateHandler);
    // 关闭心跳检查
    heartCheck.stop();
  }
}

// 创建ws函数
const createWebSoket = () => {
  if (typeof (WebSocket) === 'undefined') {
    writeToScreen("您的浏览器不支持WebSocket,无法获取数据");
    return false
  }
  // const host = window.location.host;
  // userId = GetQueryString("userId");
  // wsUrl = "ws://" + host + "/websoket" + userId;

  try {
    wsObj = new WebSocket(wsUrl);
    initWsEventHandle();
  } catch (e) {
    writeToScreen("连接异常,开始重连");
    reconnect();
  }
}

const initWsEventHandle = () => {
  try {
    // 连接成功
    wsObj.onopen = (event) => {
      onWsOpen(event);
      heartCheck.start();
    }

    // 监听服务器端返回的信息
    wsObj.onmessage = (event) => {
      onWsMessage(event);
      heartCheck.start();
    }

    wsObj.onclose = (event) => {
      writeToScreen('onclose执行关闭事件');
      onWsClose(event);
    }

    wsObj.onerror = (event) => {
      writeToScreen('onerror执行error事件,开始重连');
      onWsError(event);
      reconnect();
    }
  } catch (err) {
    writeToScreen('绑定事件没有成功,开始重连');
    reconnect();
  }
}

const onWsOpen = (event) => {
  writeToScreen('CONNECT');
  // // 客户端与服务器端通信
  // wsObj.send('我发送消息给服务端');
  // 添加状态判断,当为OPEN时,发送消息
  if (wsObj.readyState === wsObj.OPEN) { // wsObj.OPEN = 1 
    // 发给后端的数据需要字符串化
    wsObj.send(JSON.stringify(sendDatas));
  }
  if (wsObj.readyState === wsObj.CLOSED) { // wsObj.CLOSED = 3 
    writeToScreen('wsObj.readyState=3, ws连接异常,开始重连');
    reconnect();
    errorCallback(event);
  }
}
const onWsMessage = (event) => {
  const jsonStr = event.data;
  writeToScreen('onWsMessage接收到服务器的数据: ', jsonStr);
  messageCallback(jsonStr);
}
const onWsClose = (event) => {
  writeToScreen('DISCONNECT');
  // e.code === 1000  表示正常关闭。 无论为何目的而创建, 该链接都已成功完成任务。
  // e.code !== 1000  表示非正常关闭。
  console.log('onclose event: ', event)
  if (event && event.code !== 1000) {
    writeToScreen('非正常关闭');
    errorCallback(event);
    // 如果不是手动关闭,这里的重连会执行;如果调用了手动关闭函数,这里重连不会执行
    reconnect();
  }
}
const onWsError = (event) => {
  writeToScreen('onWsError: ', event.data);
  errorCallback(event);
}

const writeToScreen = (massage) => {
  console.log(massage);
}

// 重连函数
const reconnect = () => {
  if (lockReconnect) {
    return;
  }
  writeToScreen('3秒后重连');
  lockReconnect = true;
  // 没连接上会一直重连,设置延迟避免请求过多
  wsCreateHandler && clearTimeout(wsCreateHandler);
  wsCreateHandler = setTimeout(() => {
    writeToScreen('重连...' + wsUrl);
    createWebSoket();
    lockReconnect = false;
    writeToScreen('重连完成');
  }, 3000);
}

// 从浏览器地址中获取对应参数
const GetQueryString = (name) => {
  let reg = new RegExp("(^|&)" + name + "=([^&]*)(&|$)", "i");
  // 获取url中 ? 符后的字符串并正则匹配
  let r = window.location.search.substr(1).match(reg);
  let context = "";
  r && (context = r[2]);
  reg = null;
  r = null;
  return context;
}


// 心跳检查(看看websocket是否还在正常连接中)
let heartCheck = {
  timeout: 15000,
  timeoutObj: null,
  serverTimeoutObj: null,
  // 重启
  reset() {
    clearTimeout(this.timeoutObj);
    clearTimeout(this.serverTimeoutObj);
    this.start();
  },
  // 停止
  stop() {
    clearTimeout(this.timeoutObj);
    clearTimeout(this.serverTimeoutObj);
  },
  // 开启定时器
  start() {
    this.timeoutObj && clearTimeout(this.timeoutObj);
    this.serverTimeoutObj && clearTimeout(this.serverTimeoutObj);
    // 15s之内如果没有收到后台的消息,则认为是连接断开了,需要重连
    this.timeoutObj = setTimeout(() => {
      writeToScreen("心跳检查,发送ping到后台");
      try {
        const datas = { ping: true };
        wsObj.send(JSON.stringify(datas));
      } catch (err) {
        writeToScreen("发送ping异常");
      }
      console.log("内嵌定时器this.serverTimeoutObj: ", this.serverTimeoutObj)
      // 内嵌定时器
      this.serverTimeoutObj = setTimeout(() => {
        writeToScreen("没有收到后台的数据,重新连接");
        reconnect();
      }, this.timeout)
    }, this.timeout)
  }
}

        第二步  Vue引入

               局部引入

        

import { connectWebsocket, closeWebsocket } from '../../utils/websocket'

        发起连接 

        

connectWebsocket(
          // 测试地址
          'ws://127.0.0.1:9901/client/1',
          // 传递给后台的数据
          'openexe',
          // { openexe: 'openexe' },
          // 成功拿到后台返回的数据的回调函数
          (data) => {
            console.log('成功的回调函数, 接收到的data数据: ', data)
          },
          // websocket连接失败的回调函数
          (err) => {
            console.log('失败的回调函数', err)
          }
        )

  • 2
    点赞
  • 20
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
Vue 项目配置 WebSocket 需要进行以下步骤: 1. 安装 WebSocket 库 可以选择安装 `ws` 或 `socket.io-client` 库,这里以 `ws` 为例,在项目根目录下执行以下命令安装: ``` npm install ws --save ``` 2. 创建 WebSocket 实例 在需要使用 WebSocket 的组件引入 `ws` 库并创建 WebSocket 实例,如下所示: ```javascript import WebSocket from 'ws'; // 创建 WebSocket 实例 const ws = new WebSocket('ws://localhost:3000'); ``` 其,`ws://localhost:3000` 是 WebSocket 服务器的地址和端口号,可以根据实际情况进行修改。 3. 监听 WebSocket 事件 可以监听 WebSocket 的 `open`、`message`、`close` 和 `error` 事件,进行相应的操作。例如: ```javascript // 监听 WebSocket 的 open 事件 ws.on('open', () => { console.log('WebSocket 已连接'); }); // 监听 WebSocket 的 message 事件 ws.on('message', (data) => { console.log('接收到服务器发送的数据:', data); }); // 监听 WebSocket 的 close 事件 ws.on('close', () => { console.log('WebSocket 已关闭'); }); // 监听 WebSocket 的 error 事件 ws.on('error', (error) => { console.log('WebSocket 连接发生错误:', error); }); ``` 4. 发送和接收数据 可以使用 WebSocket 实例的 `send()` 方法向服务器发送数据,例如: ```javascript // 发送数据到服务器 ws.send('hello server!'); ``` 在 `message` 事件接收服务器发送的数据,例如: ```javascript // 监听 WebSocket 的 message 事件 ws.on('message', (data) => { console.log('接收到服务器发送的数据:', data); }); ``` 以上就是在 Vue 项目配置 WebSocket 的基本步骤。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值