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

白偉業發表於2019-03-03
微信小程式Web

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

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

Websocket簡介

Websocket是什麼

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

WebSocket 是 HTML5 開始提供的一種在單個 TCP 連線上進行全雙工通訊的協議。

為什麼需要Websocket

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

所以當我們想伺服器主動給客戶端傳送訊息，HTTP是做不到的，我們只能使用輪詢或者長輪詢來實現類似的功能，這樣的方式效率低並且浪費資源，為了解決這樣的問題，WebSocket誕生了。

小程式中的WebSocket

小程式WebSocket的API

把你給懶得！自己官網看去!

為什麼要做心跳重連

在使用原生WebSocket的時候，我們經常會感覺不太穩定，服務端傳送的訊息有時候客戶端接收不到，或者是客戶端傳送的訊息服務端接收不到，雖然WebSocket也提供了onError和onClose的方法，但是經常會有各種未知情況導致斷開連線而並不觸發Error或Close事件。這樣就導致實際連線已經斷開了，而客戶端和服務端卻不知道，還在傻傻的等著訊息來。

所以我們要解決的問題就很清晰了：

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

上程式碼

頁面載入後,我們連線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事件又去重連了（渣男）

至此，心跳重連實現完畢

總結

Socket心跳重連在H5中可以有類似的實現，也有成熟的第三方庫，比如說stomp+websocket+sockjs可以實現更加完整的更相容的socket連線方案,可以下次給大家分享(看我心情)。

如果覺得還行就點個贊鼓勵一下我。

如果覺得寫得什麼垃圾，點個贊懲罰一下我把。

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

相關文章