OpenHarmony开发记录-Websocket封装

 OpenHarmony开发记录-Websocket封装

介绍

本代码基于stage模型API9

场景介绍

使用WebSocket建立服务器与客户端的双向连接，需要先通过createWebSocket()方法创建WebSocket对象，然后通过connect()方法连接到服务器。当连接成功后，客户端会收到open事件的回调，之后客户端就可以通过send()方法与服务器进行通信。当服务器发信息给客户端时，客户端会收到message事件的回调。当客户端不要此连接时，可以通过调用close()方法主动断开连接，之后客户端会收到close事件的回调。

若在上述任一过程中发生错误，客户端会收到error事件的回调。

接口说明

WebSocket连接功能主要由webSocket模块提供。使用该功能需要申请ohos.permission.INTERNET权限。具体接口说明如下表。

接口名	功能描述
createWebSocket()	创建一个WebSocket连接。
connect()	根据URL地址，建立一个WebSocket连接。
send()	通过WebSocket连接发送数据。
close()	关闭WebSocket连接。
on(type: ‘open’)	订阅WebSocket的打开事件。
off(type: ‘open’)	取消订阅WebSocket的打开事件。
on(type: ‘message’)	订阅WebSocket的接收到服务器消息事件。
off(type: ‘message’)	取消订阅WebSocket的接收到服务器消息事件。
on(type: ‘close’)	订阅WebSocket的关闭事件。
off(type: ‘close’)	取消订阅WebSocket的关闭事件
on(type: ‘error’)	订阅WebSocket的Error事件。
off(type: ‘error’)	取消订阅WebSocket的Error事件。

开发步骤

1. 导入需要的webSocket模块。

2. 创建一个WebSocket连接，返回一个WebSocket对象。

3. （可选）订阅WebSocket的打开、消息接收、关闭、Error事件。

4. 根据URL地址，发起WebSocket连接。

5. 使用完WebSocket连接之后，主动断开连接。

废话不多说，直接上代码

// WebsocketUtil.ets

import webSocket from '@ohos.net.webSocket';
import Logger from './Logger'

export function WebsocketUtil(url: string, openCallback?: Function, msgCallback?: Function, closeCallback?: Function) {

  return new Promise((resolve, reject) => {
    let ws: webSocket.WebSocket = webSocket.createWebSocket();
    ws.on('open', (err, value: Object) => {
      if (err) {
        reject(err)
      }
      openCallback(value)
    });
    ws.on('message', (err, value: string | ArrayBuffer) => {
      if (err) {
        reject(err)
      }
      Logger.info("webSocketUtil", JSON.stringify(value))
      msgCallback(value)
    });
    ws.on('close', (err, value) => {
      if (err) {
        reject(err)
      }
      closeCallback(value)
    });
    ws.on('error', (err) => {
      if (err) {
        reject(err)
      }
      console.log("on error, error:" + JSON.stringify(err));
    });
    ws.connect(url, (err, value: boolean) => {
      if (err || !value) {
        reject(err)
      }
      Logger.info("webSocketUtil", JSON.stringify(value))
      resolve(ws)
    });
  })
}