微信小程序實現WebSocket心跳重連

時間 2019-11-21

標籤微信程序實現 websocket 心跳简体版

原文原文鏈接

最近在開發小程序用到了WebSocket，小程序提供了相應的原生API，與H5的API使用方式上有一些區別，因此流行的H5的一些成熟的類庫使用起來有些困難，而原生API又存在一些缺陷，因此就本身實現了一套心跳重連機制。web

慣例，先簡單介紹一下Websocket。小程序

Websocket簡介

Websocket是什麼

WebSocket 是一種網絡通訊協議。RFC6455 定義了它的通訊標準。bash

WebSocket 是 HTML5 開始提供的一種在單個 TCP 鏈接上進行全雙工通信的協議。服務器

爲何須要Websocket

HTTP 協議是一種無狀態的、無鏈接的、單向的應用層協議。它採用了請求/響應模型。通訊請求只能由客戶端發起，服務端對請求作出應答處理。微信

因此當咱們想服務器主動給客戶端發送消息，HTTP是作不到的，咱們只能使用輪詢或者長輪詢來實現相似的功能，這樣的方式效率低而且浪費資源，爲了解決這樣的問題，WebSocket誕生了。websocket

小程序中的WebSocket

小程序WebSocket的API

把你給懶得！本身官網看去!網絡

爲何要作心跳重連

在使用原生WebSocket的時候，咱們常常會感受不太穩定，服務端發送的消息有時候客戶端接收不到，或者是客戶端發送的消息服務端接收不到，雖然WebSocket也提供了onError和onClose的方法，可是常常會有各類未知狀況致使斷開鏈接而並不觸發Error或Close事件。這樣就致使實際鏈接已經斷開了，而客戶端和服務端殊不知道，還在傻傻的等着消息來。app

因此咱們要解決的問題就很清晰了：socket

保證鏈接狀態，鏈接斷開時讓客戶端與服務端都能知道，進而重連。ui

上代碼

頁面載入後,咱們鏈接socket先

onLoad(){
    this.linkSocket()
  },
  linkSocket(){
    let that = this
    wx.connectSocket({
      url: app.globalData.wsUrl + 'websocket?' + this.data.taskId + '&' + this.data.userId,
      success() {
        console.log('鏈接成功')
        that.initEventHandle()
      }
    })
  },
複製代碼

綁定事件

而後調用initEventHandle來綁定各類各樣的事件

initEventHandle(){
    let that = this
    wx.onSocketMessage((res) => {
      //收到消息
    })
    wx.onSocketOpen(()=>{
      console.log('WebSocket鏈接打開')
    })
    wx.onSocketError(function (res) {
      console.log('WebSocket鏈接打開失敗')
    })
    wx.onSocketClose(function (res) {
      console.log('WebSocket 已關閉！')
    })
  },
複製代碼

這個先放在這咱們一會往裏填東西

斷線重連

reconnect(){
    if (this.lockReconnect) return;
    this.lockReconnect = true;
    clearTimeout(this.timer)
    if (this.data.limit<12){
      this.timer = setTimeout(() => {
        this.linkSocket();
        this.lockReconnect = false;
      }, 5000);
      this.setData({
        limit: this.data.limit+1
      })
    }
  },
複製代碼

咱們設置一個鎖和最大的重連次數，避免出現無限重連的狀況，爲了避免給服務器太大的壓力我這裏設置的是5秒重試一次，最多請求12次。

改造一下initEventHandle這樣咱們就能夠實現通常的觸發Error的斷線重連。

initEventHandle(){
    let that = this
    wx.onSocketMessage((res) => {
      //收到消息
    })
    wx.onSocketOpen(()=>{
      console.log('WebSocket鏈接打開')
    })
    wx.onSocketError((res)=>{ 
      console.log('WebSocket鏈接打開失敗')
      this.reconnect()
    })
    wx.onSocketClose((res)=> {
      console.log('WebSocket 已關閉！')
      this.reconnect()
    })
  },
複製代碼

關鍵的來的---心跳對象

先擼爲敬

let heartCheck = {
  timeout: 10000, 
  timeoutObj: null,
  serverTimeoutObj: null,
  reset: function () {
    clearTimeout(this.timeoutObj);
    clearTimeout(this.serverTimeoutObj);
    return this;
  },
  start: function () {
    this.timeoutObj = setTimeout(()=> {
      console.log("發送ping");
      wx.sendSocketMessage({
        data:"ping",
        // success(){
        //   console.log("發送ping成功");
        // }
      });
      this.serverTimeoutObj = setTimeout(() =>{
        wx.closeSocket(); 
      }, this.timeout);
    }, this.timeout);
  }
};
複製代碼

心跳對象內timeout爲每10秒發一次心跳,timeoutObj、serverTimeoutObj是清除定時器用的對象，reset方法重置定時器，start發送心跳。

繼續改造咱們的initEventHandle

initEventHandle(){
    let that = this
    wx.onSocketMessage((res) => {
      //收到消息
      if (res.data == "pong"){
        heartCheck.reset().start()
      }else{
        \\處理數據
      }
    })
    wx.onSocketOpen(()=>{
      console.log('WebSocket鏈接打開')
      heartCheck.reset().start()
    })
    wx.onSocketError((res)=>{ 
      console.log('WebSocket鏈接打開失敗')
      this.reconnect()
    })
    wx.onSocketClose((res)=> {
      console.log('WebSocket 已關閉！')
      this.reconnect()
    })
  },
複製代碼

打開鏈接的時候調用start開始心跳,每隔10秒向服務端發送消息"ping",服務端接收到消息後給咱們回個話"pong",就好像微信聊天。

在嗎?

在

在嗎?

在

在嗎?

滾

別看在嗎很煩，至少能肯定大家倆仍是好友，要不他把你拉黑了你還不知道（有點跑題了）

若是超過10秒服務端還沒回復「pong」，則認爲鏈接斷開的

我擦，敢刪我好友，我這東北爺們的暴脾氣這能忍？我把你也刪了。。。。。。。。。。。而後趕忙從新申請好友

這是暴脾氣的客戶端直接把鏈接關閉，調用closeSocket，但是一關閉咱們的onSocketClose事件又去重連了（渣男）

至此，心跳重連實現完畢