小程序websocket心跳库(websocket-heartbeat-miniprogram)

小程序websocket心跳库（websocket-heartbeat-miniprogram）是一个专为微信小程序开发的websocket心跳保活库。本库基于wx.socket组件进行二次封装，使得小程序能够稳定地通过websocket进行双向实时通信。本库提供了websocket的连接建立、websocket的发送数据、websocket的心跳保活、websocket的断开重连等功能，同时也提供了针对小程序场景下的一些特殊处理，如小程序后台运行时的心跳处理等。

使用本库需要引入websocket-heartbeat-miniprogram.js文件，并在小程序中注册socket组件，在需要使用websocket的页面中引用相关函数后即可正常使用。

下面将从具体使用场景和示例来详细讲解websocket心跳库的使用：

1. 连接websocket和发送数据

首先需要在小程序页面中引入websocket-heartbeat-miniprogram.js文件：

const websocket = require('../../utils/websocket-heartbeat-miniprogram.js')

在需要连接websocket的地方实例化websocket：

websocket.connectWebSocket(url, {
  success: res => {
    console.log('websocket连接成功', res)
  },
  fail: err => {
    console.log('websocket连接失败', err)
  }
})

其中url为要连接的websocket地址。连接成功后可以通过websocket.send()方法发送数据：

websocket.send('hello, websocket')

1. 心跳保活和断开重连

如果websocket连接长时间未进行通信，通常情况下websocket会自动断开（如nginx默认的60s断开时间），为了确保websocket始终能够保持连接，我们可以定期发送心跳包来保持连接。websocket-heartbeat-miniprogram库提供了startHeartbeat()函数来启动心跳保活功能：

websocket.startHeartbeat()

此时websocket会每隔30s自动发送一次心跳包。另外，如果websocket被意外断开，websocket-heartbeat-miniprogram库也提供了reconnect()函数来发起断开重连：

websocket.reconnect()

示例1：在小程序中使用websocket进行实时通信，实现双方聊天功能

在小程序中使用websocket进行实时通信可以实现双方聊天等功能。具体实现方法如下：

1. 在小程序页面中引入websocket-heartbeat-miniprogram.js文件：

const websocket = require('../../utils/websocket-heartbeat-miniprogram.js')

1. 在onLoad()中实例化websocket：

onLoad: function() {
  websocket.connectWebSocket('ws://localhost:8080', {
    success: res => {
      console.log('websocket连接成功', res)
    },
    fail: err => {
      console.log('websocket连接失败', err)
    }
  })
}

1. 在页面中提供一个输入框和一个发送按钮，在点击发送按钮时通过websocket发送输入框中的内容：

bindSendMessage: function(event) {
  const message = event.detail.value
  websocket.send(message)
  this.setData({
    message: ''
  })
}

1. 在页面中监听websocket的message事件，即可收到websocket发送过来的消息并显示在页面上：

websocket.onMessage(function(res) {
  const message = res.data
  const messages = that.data.messages
  messages.push(message)
  that.setData({
    messages: messages
  })
})

示例2：在小程序中使用websocket实现实时股票行情推送功能

在一些股票类小程序中，需要实时推送股票行情。可以通过websocket实现此功能。具体实现方法如下：

1. 在小程序页面中引入websocket-heartbeat-miniprogram.js文件：

const websocket = require('../../utils/websocket-heartbeat-miniprogram.js')

1. 在onLoad()中实例化websocket：

onLoad: function() {
  websocket.connectWebSocket('wss://websocket.example.com', {
    success: res => {
      console.log('websocket连接成功', res)
    },
    fail: err => {
      console.log('websocket连接失败', err)
    }
  })
}

1. 在页面中监听websocket的message事件，即可收到websocket发送过来的股票行情数据并实时更新到页面上：

websocket.onMessage(function(res) {
  const data = JSON.parse(res.data)
  const stock = that.data.stock
  stock.price = data.price
  stock.percent = data.percent
  that.setData({
    stock: stock
  })
})

1. 在页面中使用wx.request()请求股票初始数据，并将初始数据赋值给页面中的stock变量，即可在页面上显示股票的初始数据：

wx.request({
  url: 'https://stock.example.com/stock',
  success: function(res) {
    const stock = res.data
    that.setData({
      stock: stock
    })
  }
})

1. 启动心跳保持机制，防止websocket长时间未通信被断开：

websocket.startHeartbeat()