vue2.0 websocket封装使用(心跳检测 + 自动重连)

1.先在项目中下载websocket库

npm install websocket -s

 2.封装一个websocket.js文件
// 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();
  }
};

//向服务器端发送消息
export const sendMsg = value => {
  wsObj.send(JSON.stringify(value));
};

// 创建ws函数
const createWebSoket = () => {
  //判断浏览器是否支持websocket
  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 => {
      heartCheck.start(); //开启心跳
      onWsOpen(event); //客户端与服务器端通信
    };

    // 监听服务器端返回的信息
    wsObj.onmessage = event => {
      onWsMessage(event); //接收数据,抛出
      heartCheck.reset(); //重置心跳
    };

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

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

//open事件 WebSocket连接成功时触发
const onWsOpen = event => {
  //  客户端与服务器端通信
  // 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);
  }
};

//message事件  接收到WebSocket服务器发送的消息时触发
const onWsMessage = event => {
  const jsonStr = event.data;
  // writeToScreen("onWsMessage接收到服务器的数据: ", jsonStr);
  messageCallback(jsonStr);
};

//close事件 WebSocket连接关闭时触发
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();
  }
};

//error事件 WebSocket连接出错时触发
const onWsError = event => {
  writeToScreen("onWsError: ", event.data);
  errorCallback(event);//抛出错误
};

//封装console.log()
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("重连完成");
  }, 5000);
};

// 从浏览器地址中获取对应参数
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: 15 * 1000,
  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 = { content: "心跳检测" };
        wsObj.send(JSON.stringify(datas));
      } catch (err) {
        writeToScreen("发送ping异常,重连");
        reconnect();
      }
      // console.log("内嵌定时器this.serverTimeoutObj: ", this.serverTimeoutObj);
      // 内嵌定时器
      this.serverTimeoutObj = setTimeout(() => {
        writeToScreen("没有收到后台的数据,重新连接");
        reconnect();
      }, this.timeout);
    }, this.timeout);
  },
};
3.在需要引用的vue文件中的引入使用
import { connectWebsocket, closeWebsocket, sendMsg } from "@/untils/websocket.js";
created () {
   this.initWebSocket();
 },
methods: {
    initWebSocket () {
      connectWebsocket("ws://124.222.224.186:8800", { w: 'S', }, (res) => {
      console.log("onWsMessage接收到服务器的数据: ", res)
      },
      (err) => {
        console.log("断开重连");
      })
    },
  destroyed () {
    closeWebsocket() //断开连接
  },
//发送消息
    sendMsg () {
      sendMsg(this.value);  //value是发送的值
      this.value = "";
    },
}
  • 4
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

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

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

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值