WebSocket连接

说明： 本模块首批接口从API version 6开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

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

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

导入模块

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

完整示例

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

var defaultIpAddress = "ws://";
let ws = webSocket.createWebSocket();
ws.on('open', (err, value) = > {
    console.log("on open, status:" + value['status'] + ", message:" + value['message']);
    // 当收到on('open')事件时，可以通过send()方法与服务器进行通信
    ws.send("Hello, server!", (err, value) = > {
        if (!err) {
            console.log("send success");
        } else {
            console.log("send fail, err:" + JSON.stringify(err));
        }
    });
});
ws.on('message', (err, value) = > {
    console.log("on message, message:" + value);
    // 当收到服务器的`bye`消息时（此消息字段仅为示意，具体字段需要与服务器协商），主动断开连接
    if (value === 'bye') {
        ws.close((err, value) = > {
            if (!err) {
                console.log("close success");
            } else {
                console.log("close fail, err is " + JSON.stringify(err));
            }
        });
    }
});
ws.on('close', (err, value) = > {
    console.log("on close, code is " + value.code + ", reason is " + value.reason);
});
ws.on('error', (err) = > {
    console.log("on error, error:" + JSON.stringify(err));
});
ws.connect(defaultIpAddress, (err, value) = > {
    if (!err) {
        console.log("connect success");
    } else {
        console.log("connect fail, err:" + JSON.stringify(err));
    }
});

webSocket.createWebSocket

createWebSocket(): WebSocket

创建一个WebSocket，里面包括建立连接、关闭连接、发送数据和订阅/取消订阅WebSocket连接的打开事件、接收到服务器消息事件、关闭事件和错误事件。

系统能力 ：SystemCapability.Communication.NetStack

返回值：

类型	说明
[WebSocket]	返回一个WebSocket对象，里面包括connect、send、close、on和off方法。

示例：

let ws = webSocket.createWebSocket();

WebSocket

在调用WebSocket的方法前，需要先通过[webSocket.createWebSocket]创建一个WebSocket。

connect

connect(url: string, callback: AsyncCallback): void

根据URL地址，建立一个WebSocket连接，使用callback方式作为异步方法。

需要权限 ：ohos.permission.INTERNET

系统能力 ：SystemCapability.Communication.NetStack

参数：

参数名	类型	必填	说明
url	string	是	建立WebSocket连接的URL地址。
callback	AsyncCallback	是	回调函数。

示例：

let ws = webSocket.createWebSocket();
let url = "ws://"
ws.connect(url, (err, value) = > {
	if (!err) {
		console.log("connect success");
	} else {
		console.log("connect fail, err:" + JSON.stringify(err))
	}
});

connect

connect(url: string, options: WebSocketRequestOptions, callback: AsyncCallback): void

根据URL地址和header，建立一个WebSocket连接，使用callback方式作为异步方法。

需要权限 ：ohos.permission.INTERNET

系统能力 ：SystemCapability.Communication.NetStack

参数：

参数名	类型	必填	说明
url	string	是	建立WebSocket连接的URL地址。
options	WebSocketRequestOptions	是	参考[WebSocketRequestOptions]。
callback	AsyncCallback	是	回调函数。

示例：

let ws = webSocket.createWebSocket();
let url = "ws://"
ws.connect(url, {
	header: {
		"key": "value",
		"key2": "value2"
	}
}, (err, value) = > {
	if (!err) {
		console.log("connect success");
	} else {
		console.log("connect fail, err:" + JSON.stringify(err))
	}
});

connect

connect(url: string, options?: WebSocketRequestOptions): Promise

根据URL地址和header，建立一个WebSocket连接，使用Promise方式作为异步方法。

需要权限 ：ohos.permission.INTERNET

系统能力 ：SystemCapability.Communication.NetStack

参数：

参数名	类型	必填	说明
url	string	是	建立WebSocket连接的URL地址。
options	WebSocketRequestOptions	否	参考[WebSocketRequestOptions]。

返回值：

类型	说明
Promise	以Promise形式返回建立连接的结果。

示例：

let ws = webSocket.createWebSocket();
let url = "ws://"
let promise = ws.connect(url);
promise.then((value) = > {
	console.log("connect success")
}).catch((err) = > {
	console.log("connect fail, error:" + JSON.stringify(err))
});

send

send(data: string | ArrayBuffer, callback: AsyncCallback): void

通过WebSocket连接发送数据，使用callback方式作为异步方法。

需要权限 ：ohos.permission.INTERNET

系统能力 ：SystemCapability.Communication.NetStack

参数：

参数名	类型	必填	说明
data	string	ArrayBuffer 8+	是
callback	AsyncCallback	是	回调函数。

示例：

let ws = webSocket.createWebSocket();
let url = "ws://"
ws.connect(url, (err, value) = > {
	ws.send("Hello, server!", (err, value) = > {
		if (!err) {
			console.log("send success");
		} else {
			console.log("send fail, err:" + JSON.stringify(err))
		}
	});
});

send

send(data: string | ArrayBuffer): Promise

通过WebSocket连接发送数据，使用Promise方式作为异步方法。

需要权限 ：ohos.permission.INTERNET

系统能力 ：SystemCapability.Communication.NetStack

参数：

参数名	类型	必填	说明
data	string	ArrayBuffer 8+	是

返回值：

类型	说明
Promise	以Promise形式返回发送数据的结果。

示例：

let ws = webSocket.createWebSocket();
let url = "ws://"
ws.connect(url, (err, value) = > {
	let promise = ws.send("Hello, server!");
	promise.then((value) = > {
		console.log("send success")
	}).catch((err) = > {
		console.log("send fail, error:" + JSON.stringify(err))
	});
});

close

close(callback: AsyncCallback): void

关闭WebSocket连接，使用callback方式作为异步方法。

需要权限 ：ohos.permission.INTERNET

系统能力 ：SystemCapability.Communication.NetStack

参数：

参数名	类型	必填	说明
callback	AsyncCallback	是	回调函数。

示例：

let ws = webSocket.createWebSocket();
let url = "ws://"
ws.close((err, value) = > {
	if (!err) {
		console.log("close success")
	} else {
		console.log("close fail, err is " + JSON.stringify(err))
	}
});

close

close(options: WebSocketCloseOptions, callback: AsyncCallback): void

根据可选参数code和reason，关闭WebSocket连接，使用callback方式作为异步方法。

需要权限 ：ohos.permission.INTERNET

系统能力 ：SystemCapability.Communication.NetStack

参数：

参数名	类型	必填	说明
options	WebSocketCloseOptions	是	参考[WebSocketCloseOptions]。
callback	AsyncCallback	是	回调函数。

示例：

let ws = webSocket.createWebSocket();
let url = "ws://"
ws.close({
	code: 1000,
	reason: "your reason"
}, (err, value) = > {
	if (!err) {
		console.log("close success")
	} else {
		console.log("close fail, err is " + JSON.stringify(err))
	}
});

close

close(options?: WebSocketCloseOptions): Promise

根据可选参数code和reason，关闭WebSocket连接，使用Promise方式作为异步方法。

需要权限 ：ohos.permission.INTERNET

系统能力 ：SystemCapability.Communication.NetStack

参数：

参数名	类型	必填	说明
options	WebSocketCloseOptions	否	参考[WebSocketCloseOptions]。

返回值：

类型	说明
Promise	以Promise形式返回关闭连接的结果。

示例：

let ws = webSocket.createWebSocket();
let url = "ws://"
let promise = ws.close({
	code: 1000,
	reason: "your reason"
});
promise.then((value) = > {
	console.log("close success")
}).catch((err) = > {
	console.log("close fail, err is " + JSON.stringify(err))
});

on('open')

on(type: 'open', callback: AsyncCallback ): void

订阅WebSocket的打开事件，使用callback方式作为异步方法。

系统能力 ：SystemCapability.Communication.NetStack

参数：

参数名	类型	必填	说明
type	string	是	'open'：WebSocket的打开事件。
callback	AsyncCallback	是	回调函数。

示例：

let ws = webSocket.createWebSocket();
ws.on('open', (err, value) = > {
	console.log("on open, status:" + value['status'] + ", message:" + value['message']);
});

off('open')

off(type: 'open', callback?: AsyncCallback ): void

取消订阅WebSocket的打开事件，使用callback方式作为异步方法。

说明： 可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。

系统能力 ：SystemCapability.Communication.NetStack

参数：

参数名	类型	必填	说明
type	string	是	'open'：WebSocket的打开事件。
callback	AsyncCallback	否	回调函数。

示例：

let ws = webSocket.createWebSocket();
let callback1 = (err, value) = > {
	console.log("on open, status:" + value['status'] + ", message:" + value['message']);
}
ws.on('open', callback1);
// 可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅
ws.off('open', callback1);

on('message')

on(type: 'message', callback: AsyncCallback): void

订阅WebSocket的接收到服务器消息事件，使用callback方式作为异步方法。

说明： AsyncCallback中的数据可以是字符串(API 6)或ArrayBuffer(API 8)。

系统能力 ：SystemCapability.Communication.NetStack

参数：

参数名	类型	必填	说明
type	string	是	'message'：WebSocket的接收到服务器消息事件。
callback	AsyncCallback	是	回调函数。

示例：

let ws = webSocket.createWebSocket();
ws.on('message', (err, value) = > {
	console.log("on message, message:" + value);
});

off('message')

off(type: 'message', callback?: AsyncCallback): void

取消订阅WebSocket的接收到服务器消息事件，使用callback方式作为异步方法。

说明： AsyncCallback中的数据可以是字符串(API 6)或ArrayBuffer(API 8)。可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。

系统能力 ：SystemCapability.Communication.NetStack

参数：

参数名	类型	必填	说明
type	string	是	'message'：WebSocket的接收到服务器消息事件。
callback	AsyncCallback	否	回调函数。

示例：

let ws = webSocket.createWebSocket();
ws.off('message');

on('close')

on(type: 'close', callback: AsyncCallback<{ code: number, reason: string }>): void

订阅WebSocket的关闭事件，使用callback方式作为异步方法。

系统能力 ：SystemCapability.Communication.NetStack

参数：

参数名	类型	必填	说明
type	string	是	'close'：WebSocket的关闭事件。
callback	AsyncCallback<{ code: number, reason: string }>	是	回调函数。

示例：

let ws = webSocket.createWebSocket();
ws.on('close', (err, value) = > {
	console.log("on close, code is " + value.code + ", reason is " + value.reason);
});

off('close')

off(type: 'close', callback?: AsyncCallback<{ code: number, reason: string }>): void

取消订阅WebSocket的关闭事件，使用callback方式作为异步方法。

说明： 可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。

系统能力 ：SystemCapability.Communication.NetStack

参数：

参数名	类型	必填	说明
type	string	是	'close'：WebSocket的关闭事件。
callback	AsyncCallback<{ code: number, reason: string }>	否	回调函数。

示例：

let ws = webSocket.createWebSocket();
ws.off('close');

on('error')

on(type: 'error', callback: ErrorCallback): void

订阅WebSocket的Error事件，使用callback方式作为异步方法。

系统能力 ：SystemCapability.Communication.NetStack

参数：

参数名	类型	必填	说明
type	string	是	'error'：WebSocket的Error事件。
callback	ErrorCallback	是	回调函数。

示例：

let ws = webSocket.createWebSocket();
ws.on('error', (err) = > {
	console.log("on error, error:" + JSON.stringify(err))
});

off('error')

off(type: 'error', callback?: ErrorCallback): void

取消订阅WebSocket的Error事件，使用callback方式作为异步方法。

说明： 可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。

系统能力 ：SystemCapability.Communication.NetStack

参数：

参数名	类型	必填	说明
type	string	是	'error'：WebSocket的Error事件。
callback	ErrorCallback	否	回调函数。

示例：

let ws = webSocket.createWebSocket();
ws.off('error');

WebSocketRequestOptions

建立WebSocket连接时，可选参数的类型和说明。

系统能力 ：以下各项对应的系统能力均为SystemCapability.Communication.NetStack。

参数名	类型	必填	说明
header	Object	否	建立WebSocket连接可选参数，代表建立连接时携带的HTTP头信息。参数内容自定义，也可以不指定。

WebSocketCloseOptions

关闭WebSocket连接时，可选参数的类型和说明。

系统能力 ：以下各项对应的系统能力均为SystemCapability.Communication.NetStack。

参数名	类型	必填	说明
code	number	否	错误码，关闭WebSocket连接时的可选参数，可根据实际情况来填。默认值为1000。
reason	string	否	原因值，关闭WebSocket连接时的可选参数，可根据实际情况来填。默认值为空字符串（""）。

close错误码说明

发送给服务端的错误码可以自行定义，下面的列表仅供参考。

系统能力 ：以下各项对应的系统能力均为SystemCapability.Communication.NetStack。

值	说明
1000	正常关闭
1001	服务器主动关闭
1002	协议错误
1003	无法处理的数据类型
1004~1015	保留值

审核编辑黄宇

声明：本文内容及配图由入驻作者撰写或者入驻合作网站授权转载。文章观点仅代表作者本人，不代表电子发烧友网立场。文章及其配图仅供工程师学习之用，如有内容侵权或者其他违规问题，请联系本站处理。举报投诉

接口

接口

+关注

关注
33

文章
8580

浏览量
151046
网络管理

网络管理

+关注

关注
0

文章
120

浏览量
27670
WebSocket

WebSocket

+关注

关注
0

文章
29

浏览量
3745
鸿蒙

鸿蒙

+关注

关注
57

文章
2345

浏览量
42822

socket 和 WebSocket 的区别

在现代网络通信中，Socket和WebSocket是两种常见的通信协议。它们在实现网络通信、数据传输等方面发挥着重要作用。然而，它们之间存在一些关键的区别。 1. Socket（套接字） 1.1

发表于 11-12 14:33 •407次阅读

socket与WebSocket的区别与联系

）： Socket是一种通信端点，它在网络编程中用于实现不同主机之间的通信。Socket可以是TCP套接字或UDP套接字，分别对应于TCP（传输控制协议）和UDP（用户数据报协议）。 TCP套接字提供了可靠的、面向连接的通信服务，而UDP套接字则提供了不可靠的、无

发表于 11-04 09:19 •377次阅读

不可错过的Air780E之WebSocket应用示范！小白篇

咋们今天说的Air780E之WebSocket应用示范针对小白绝对是不可以错过的示例。

发表于 11-03 20:16 •816次阅读

不可错过的Air780E之<b class='flag-5'>WebSocket</b>应用示范！小白篇

ESP8266_RTOS_SDK 1.4.0中的“websocket_demo”不起作用是怎么回事？

新的SDK用户在这里。我刚刚尝试了昨天发布的 ESP8266_RTOS_SDK 1.4.0 中包含的示例“websocket_demo”。我唯一更改的是 websocket.c 中的 wifi 凭据

发表于 07-18 07:05

在websocket.c RTOS演示中缺少对wifi_connect（）的调用怎么办？

在 RTOS SDK 1.3 中，有一个名为 /examples/websocket_demo/websocket/websocket.c 的示例。在函数中有一个名为 websocket

发表于 07-18 06:37

请问websocket库怎么读取服务器发来的数据?

官方websocket库怎么读取服务器发来的数据?

发表于 06-25 06:40

鸿蒙开发网络管理：ohos.net.socket之Socket连接

绑定IP地址和端口，端口可以指定或由系统随机分配。使用Promise方式作为异步方法。

发表于 06-19 09:26 •394次阅读

鸿蒙开发网络管理：ohos.net.connection之网络连接管理

以下各项对应的系统能力均为SystemCapability.Communication.NetManager.Core。

发表于 06-18 09:20 •726次阅读

ESP32进行websocket通信接收数据出错的原因？

开发，支持一对一私聊和一对多公聊 W (104983) WEBSOCKET: Total payload length=277, data_len=277, current payload offset

发表于 06-14 07:42

鸿蒙原生应用开发-网络管理模块总述

一、网络管理模块主要提供以下功能： HTTP数据请求：通过HTTP发起一个数据请求。 WebSocket连接：使用WebSocket建立服务

发表于 04-08 09:45

鸿蒙原生应用开发-网络管理WebSocket连接

。使用该功能需要申请ohos.permission.INTERNET权限。具体接口说明如下表。三、开发步骤 1.导入需要的webSocket模块。 2.创建一个WebSocket

发表于 04-07 09:46

鸿蒙原生应用开发-网络管理Socket连接（二）

。 import socket from \'@ohos.net.socket\'; // 创建一个TCPSocket连接，返回一个TCPSocket对象。 let tcp

发表于 04-02 15:22

鸿蒙OS开发实例：【窥探网络请求】

HarmonyOS 平台中使用网络请求，需要引入 "@ohos.net.http", 并且需要在 module.json5 文件中申请网络权限, 即 “ohos.permission.

发表于 04-01 16:11 •773次阅读

恒讯科技带大家深入理解：WebSocket服务器的工作原理

WebSocket是一种在单个TCP连接上进行全双工通信的通信协议。它的设计目标是在Web浏览器和服务器之间提供低延迟、高效的双向通信。下面是深入理解WebSocket服务器工作原理的一些关键概念

发表于 01-29 16:48 •471次阅读

一文详解WebSocket协议

在效率和网络带宽利用率方面存在诸多问题。WebSocket协议应运而生，对外提供了简单的双向数据传输能力。

发表于 01-07 11:26 •7405次阅读

搜索历史

鸿蒙开发网络管理：ohos.net.webSocket WebSocket连接

WebSocket连接

导入模块

完整示例

webSocket.createWebSocket

WebSocket

connect

connect

connect

send

send

close

close

close

on('open')

off('open')

on('message')

off('message')

on('close')

off('close')

on('error')

off('error')

WebSocketRequestOptions

WebSocketCloseOptions

close错误码说明

评论