1，前言

最近在做IOT的項目，里面有個小程序要用到webSocket，借這個機會，封裝了一個uniapp小程序適用的Socket類，包括斷線重連，心跳檢測等等，具體實現如下。

2，代碼實現

class webSocketClass {
  constructor(url, time) {
    this.url = url
    this.data = null
    this.isCreate = false // WebSocket 是否創建成功
    this.isConnect = false // 是否已經連接
    this.isInitiative = false // 是否主動斷開
    this.timeoutNumber = time // 心跳檢測間隔
    this.heartbeatTimer = null // 心跳檢測定時器
    this.reconnectTimer = null // 斷線重連定時器
    this.socketExamples = null // websocket實例
    this.againTime = 3 // 重連等待時間(單位秒)
  }

  // 初始化websocket連接
  initSocket() {
    const _this = this
    this.socketExamples = uni.connectSocket({
      url: _this.url,
      header: {
        'content-type': 'application/json'
      },
      success: (res) => {
        _this.isCreate = true
        console.log(res)
      },
      fail: (rej) => {
        console.error(rej)
        _this.isCreate = false
      }
    })
    this.createSocket()
  }

  // 創建websocket連接
  createSocket() {
    if (this.isCreate) {
      console.log('WebSocket 開始初始化')
      // 監聽 WebSocket 連接打開事件
      try {
        this.socketExamples.onOpen(() => {
          console.log('WebSocket 連接成功')
          this.isConnect = true
          clearInterval(this.heartbeatTimer)
          clearTimeout(this.reconnectTimer)
          // 打開心跳檢測
          this.heartbeatCheck()
        })
        // 監聽 WebSocket 接受到服務器的消息事件
        this.socketExamples.onMessage((res) => {
          console.log('收到消息')
          uni.$emit('message', res)
        })
        // 監聽 WebSocket 連接關閉事件
        this.socketExamples.onClose(() => {
          console.log('WebSocket 關閉了')
          this.isConnect = false
          this.reconnect()
        })
        // 監聽 WebSocket 錯誤事件
        this.socketExamples.onError((res) => {
          console.log('WebSocket 出錯了')
          console.log(res)
          this.isInitiative = false
        })
      } catch (error) {
        console.warn(error)
      }
    } else {
      console.warn('WebSocket 初始化失敗!')
    }
  }

  // 發送消息
  sendMsg(value) {
    const param = JSON.stringify(value)
    return new Promise((resolve, reject) => {
      this.socketExamples.send({
        data: param,
        success() {
          console.log('消息發送成功')
          resolve(true)
        },
        fail(error) {
          console.log('消息發送失敗')
          reject(error)
        }
      })
    })
  }

  // 開啟心跳檢測
  heartbeatCheck() {
    console.log('開啟心跳')
    this.data = { state: 1, method: 'heartbeat' }
    this.heartbeatTimer = setInterval(() => {
      this.sendMsg(this.data)
    }, this.timeoutNumber * 1000)
  }

  // 重新連接
  reconnect() {
    // 停止發送心跳
    clearTimeout(this.reconnectTimer)
    clearInterval(this.heartbeatTimer)
    // 如果不是人為關閉的話，進行重連
    if (!this.isInitiative) {
      this.reconnectTimer = setTimeout(() => {
        this.initSocket()
      }, this.againTime * 1000)
    }
  }

  // 關閉 WebSocket 連接
  closeSocket(reason = '關閉') {
    const _this = this
    this.socketExamples.close({
      reason,
      success() {
        _this.data = null
        _this.isCreate = false
        _this.isConnect = false
        _this.isInitiative = true
        _this.socketExamples = null
        clearInterval(_this.heartbeatTimer)
        clearTimeout(_this.reconnectTimer)
        console.log('關閉 WebSocket 成功')
      },
      fail() {
        console.log('關閉 WebSocket 失敗')
      }
    })
  }
}

export default webSocketClass

3，使用

直接實例化封裝的socket類，調用initSocket初始化就行了，當收到消息的時候，會觸發全局$emit事件，只需要使用$on監聽message事件就行。

3.1，初始化

我這邊在globalData里面定義了socketObj全局變量，在首頁onShow生命周期里面判斷當前是否已經初始化了socket實例，再進行操作。

home.vue

import WebSocketClass from '../../utils/webSocket'
const app = getApp()

onShow() {
  // 如果已登陸，則啟用WebSocket
    if (app.globalData.user && app.globalData.user.sToken) {
      // 如果已經有sockt實例
      if (app.globalData.socketObj) {
        // 如果sockt實例未連接
        if (!app.globalData.socketObj.isConnect) {
          app.globalData.socketObj.initSocket()
        }
      } else {
        // 如果沒有sockt實例，則創建
        const data = app.globalData.user
        const path = `/websocket/notify/${data.userId}`
        app.globalData.socketObj = new WebSocketClass(
          `${app.globalData.socketUrl}${path}?token=${data.userToken}&refreshToken=${data.sToken}`,
          60
        )
        app.globalData.socketObj.initSocket()
      }
    }
}

3.2，發送消息

methods: {
  sendMessage() {
    const param = { value: '我是一個消息' }
    app.globalData.socketObj.sendMsg(param)
  }
}

3.3，接收消息

// 開啟監聽
onLoad() {
  uni.$on('message', this.getMessage)
},
// 頁面卸載時取消監聽
onUnload() {
  uni.$off('message', this.getMessage)
},
methods: {
  // 接收到消息的回調
  getMessage(msg) {
    console.log(msg)
  }
}

3.4，斷線重連

斷線會自動重連。

推薦測試工具：websokcet在線測試工具