前端Websocket的运用

前段时间因事情营业须要,简朴相识了一下Websocket的观点和前端的运用。总结以下:

观点:

Websocket是一种协定,经由过程客户端和服务器之间的久长的TCP通讯,使客户端和服务器之间能够随时交流数据。

运用场景:

因为http协定只能由客户端提议通讯,假如服务器有一连的状况变化,客户端要获知就异常贫苦。我们只能运用”轮询”:每隔一段时刻,就发出一个讯问,相识服务器有无新的信息。最典范的场景就是聊天室。Websocket在处理如许的需求上异常轻易。

申明:

  • 建立在 TCP 协定之上
  • 与 HTTP 协定有着优越的兼容性。默许端口也是80和443,而且握手阶段采纳 HTTP 协定,因而握手时不容易屏障,能经由过程种种 HTTP 代理服务器
  • 数据格式比较轻量,机能开支小,通讯高效
  • 能够发送文本,也能够发送二进制数据
  • 没有同源限定,客户端能够与恣意服务器通讯
  • 协定标识符是ws(假如加密,则为wss),服务器网址就是 URL。

API引见:

  • WebSocket组织函数: 新建WebSocket实例后,会建立客户端与服务端的WebSocket衔接
    let ws = new WebSocket(url)
  • WebSocket实例的当前状况:
    ws.readyState // 0: 'CONNECTING',示意正在衔接
                  // 1: 'OPEN', 示意衔接胜利,能够通讯了
                  // 2: 'CLOSING', 示意衔接正在封闭
                  // 3: 'CLOSED', 示意衔接已封闭,或许翻开衔接失利。
  • WebSocket实例的事宜:
    ws.onopen = function () {} // 指定衔接胜利后的回调函数
    ws.onclose = function () {} // 指定衔接封闭后的回调函数
    ws.onmessage = function () {} // 指定收到服务器数据后的回调函数
    ws.onerror = function () {} // 指定报错时的回调函数
  • WebSocket实例向背景推送音讯的要领:
    ws.send(message)

WebSocket运用实例

/* WebSocket封装
 * @param url: WebSocket接口地点与照顾参数必填
 * @param onOpenFunc: WebSocket的onopen回调函数,假如不须要可传null
 * @param onMessageFunc: WebSocket的onmessage回调函数,假如不须要可传null
 * @param onCloseFunc: WebSocket的onclose回调函数,假如不须要可传null
 * @param onErrorFunc: WebSocket的onerror回调函数,假如不须要可传null
 * @param heartMessage: 发送背景的心跳包参数,必填 (给服务端的心跳包就是按期给服务端发送音讯)
 * @param timer: 给背景传送心跳包的间隔时间,不传时运用默许值3000毫秒
 * @param isReconnect: 是不是断掉马上重连,不传true时不重连
*/
function useWebSocket (url, onOpenFunc, onMessageFunc, onCloseFunc, onErrorFunc, heartMessage, timer, isReconnect) {
  let isConnected = false // 设定已链接webSocket标记
  // websocket对象
  let ws = null
  // 建立并链接webSocket
  let connect = () => {
    // 假如未链接webSocket,则建立一个新的webSocket
    if (!isConnected) {
      ws = new WebSocket(url)
      isConnected = true
    }
  }
  // 向背景发送心跳音讯
  let heartCheck = () => {
    ws.send(JSON.stringify(heartMessage))
  }
  // 初始化事宜回调函数
  let initEventHandle = () => {
    ws.addEventListener('open', (e) => {
      console.log('onopen', e)
      // 给背景发心跳要求,在onmessage中获得音讯则申明链接一般
      heartCheck()
      // 假如传入了函数,实行onOpenFunc
      if (!onOpenFunc) {
        return false
      } else {
        onOpenFunc(e)
      }
    })
    ws.addEventListener('message', (e) => {
      console.log('onmessage', e)
      // 吸收到任何背景音讯都申明当前衔接是一般的
      if (!e) {
        console.log('get nothing from service')
        return false
      } else {
        // 假如获取到背景音讯,则timer毫秒后再次提议心跳要求给背景,检测是不是断连
        setTimeout(() => {
          heartCheck()
        }, !timer ? 3000 : timer)
      }
      // 假如传入了函数,实行onMessageFunc
      if (!onMessageFunc) {
        return false
      } else {
        onMessageFunc(e)
      }
    })
    ws.addEventListener('close', (e) => {
      console.log('onclose', e)
      // 假如传入了函数,实行onCloseFunc
      if (!onCloseFunc) {
        return false
      } else {
        onCloseFunc(e)
      }
      if (isReconnect) { // 假如断开马上重连标志为true
        // 从新链接webSocket
        connect()
      }
    })
    ws.addEventListener('error', (e) => {
      console.log('onerror', e)
      // 假如传入了函数,实行onErrorFunc
      if (!onErrorFunc) {
        return false
      } else {
        onErrorFunc(e)
      }
      if (isReconnect) { // 假如断开马上重连标志为true
        // 从新链接webSocket
        connect()
      }
    })
  }
  // 初始化webSocket
  (() => {
    // 1.建立并链接webSocket
    connect()
    // 2.初始化事宜回调函数
    initEventHandle()
    // 3.返回是不是已衔接
    return ws
  })()
}

// WebSocket函数运用实例
useWebSocket( url, // url
              null, // onopen回调
              (e) => { // onmessage回调
                let res = JSON.parse(e.data) // 后端返回的数据
                console.log(res)
              },
              null, // onclose回调
              null, // onerror回调
              { // 心跳包音讯
                "action": "9999",
                "eventType": "100",
                "requestId": ""
              },
              null, // 传送心跳包的间隔时间
              true // 断掉马上重连
)   

参考地点:
http://www.ruanyifeng.com/blo…

    原文作者:心然may
    原文地址: https://segmentfault.com/a/1190000016033681
    本文转自网络文章,转载此文章仅为分享知识,如有侵权,请联系博主进行删除。
点赞