快應用 使用WebSocket

了解如何使用 WebSocket

通過本節(jié)，你將學會：

• 創(chuàng)建連接
• 向服務器發(fā)送數據
• 接收服務器發(fā)送的消息
• 關閉連接

使用方法

創(chuàng)建連接

為了使用 WebSocket 協(xié)議通信，你需要需先通過?websocketfactory.create()?創(chuàng)建一個 WebSocket 對象；這將會自動地嘗試建立與服務器的連接。

ws = websocketfactory.create({
  url: 'wss://echo.websocket.org',
  header: {
    'content-type': 'application/json'
  },
  protocols: ['protocol']
})

參數說明：

向服務器發(fā)送數據

一旦你的連接打開完成，你就可以向服務器發(fā)送數據了。對每一個要發(fā)送的消息使用 ?WebSocket? 對象的 ?send()? 方法：

ws.send({
  data:'send message',
  success:function(){
    console.log(`send success`)
  },
  fail:function(){
    console.log(`send fail`)
  }
})

接收服務器發(fā)送的消息

WebSockets 是一個基于事件的 API；收到消息的時候，一個 "message" 消息會被發(fā)送到 onmessage 函數。為了開始監(jiān)聽傳入數據，可以進行如下操作：

ws.onmessage = function (data) {
  console.log(`message is ${data.data}`)
}

關閉連接

當你不需要再用 WebSocket 連接了,調用 ?WebSocket? 對象的 ?close()?方法：

ws.close({
  code:1000,
  reason:'close as normal',
  success:function(){
    console.log(`close success`)
  },
  fail:function(){
    console.log(`close fail`)
  }
})

參數說明：

示例代碼如下：

<template>
  <div class="doc-page">
    <div class="item-container">
      <input type="button" class="btn" onclick="create" value="創(chuàng)建websocket實例" />
      <input type="text" class="input-text" onchange="handleChange" placeholder="請輸入" />
      <input type="button" class="btn" onclick="send" value="發(fā)送消息" />
      <input type="button" class="btn" onclick="close" value="關閉連接" />
    </div>
  </div>
</template>

<script>
  import prompt from '@system.prompt'
  import websocketfactory from '@system.websocketfactory'

  let ws = null
  let isOpen = false
  export default {
    private: {
      message: ''
    },
    create() {
      //創(chuàng)建websocket實例
      ws = websocketfactory.create({
        url: 'wss://echo.websocket.org',
        header: {
          'content-type': 'application/json'
        },
        protocols: ['protocol']
      })

      //連接打開事件的監(jiān)聽
      ws.onopen = function () {
        isOpen = true
        prompt.showToast({
          message: 'connect open'
        })
      }

      //消息事件的監(jiān)聽
      ws.onmessage = function (data) {
        prompt.showToast({
          message: `message is ${data.data}`
        })
      }

      //錯誤事件的監(jiān)聽
      ws.onerror = function () {
        prompt.showToast({
          message: 'error'
        })
      }

      //關閉連接事件的監(jiān)聽
      ws.onclose = function (data) {
        prompt.showToast({
          message: 'onclose:data.code = '+data.code+', data.reason = '+data.reason+', data.wasClean = '+data.wasClean
        })
      }
    },
    handleChange(e) {
      this.message = e.value
    },
    //發(fā)送消息
    send() {
      isOpen && ws.send({
        data: this.message,
        success: function () {
          prompt.showToast({
            message: 'send success'
          })
        },
        fail: function () {
          prompt.showToast({
            message: 'send fail'
          })
        }
      })
    },
    //關閉連接
    close() {
      isOpen && ws.close({
        success: function () {
          isOpen = false
          prompt.showToast({
            message: 'close success'
          })
        },
        fail: function () {
          prompt.showToast({
            message: 'close fail'
          })
        }
      })
    }
  }
</script>

多實例

WebSocket 支持創(chuàng)建多個實例，如果開發(fā)者要創(chuàng)建多個 WebSocket 實例，需要調用多次?websocketfactory.create()?方法，并自行管理創(chuàng)建的 WebSocket 對象。