【鸿蒙next开发】网络服务:@ohos.net.webSocket (WebSocket连接)_鸿蒙arkts5.0(api12)开发,连接websocket失败header
往期鸿蒙5.0全套实战文章必看:(文中附带鸿蒙5.0全栈学习资料)
-
鸿蒙开发核心知识点,看这篇文章就够了
-
最新版!鸿蒙HarmonyOS Next应用开发实战学习路线
-
鸿蒙HarmonyOS NEXT开发技术最全学习路线指南
-
鸿蒙应用开发实战项目,看这一篇文章就够了(部分项目附源码)
@ohos.net.webSocket (WebSocket连接)
说明
本模块首批接口从API version 6开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
使用WebSocket建立服务器与客户端的双向连接,需要先通过createWebSocket方法创建WebSocket对象,然后通过connect方法连接到服务器。
当连接成功后,客户端会收到open事件的回调,之后客户端就可以通过send方法与服务器进行通信。
当服务器发信息给客户端时,客户端会收到message事件的回调。当客户端不要此连接时,可以通过调用close方法主动断开连接,之后客户端会收到close事件的回调。
若在上述任一过程中发生错误,客户端会收到error事件的回调。
导入模块
import { webSocket } from \'@kit.NetworkKit\';
完整示例
import { webSocket } from \'@kit.NetworkKit\';import { BusinessError } from \'@kit.BasicServicesKit\';let defaultIpAddress = \"ws://\";let ws = webSocket.createWebSocket();ws.on(\'open\', (err:BusinessError, value: Object) => { if (err != undefined) { console.log(JSON.stringify(err)); return; } // 当收到on(\'open\')事件时,可以通过send()方法与服务器进行通信 ws.send(\"Hello, server!\", (err: BusinessError, value: boolean) => { if (!err) { console.log(\"send success\"); } else { console.log(\"send fail, err:\" + JSON.stringify(err)); } });});ws.on(\'message\',(error: BusinessError, value: string | ArrayBuffer) => { console.log(\"on message, message:\" + value); // 当收到服务器的`bye`消息时(此消息字段仅为示意,具体字段需要与服务器协商),主动断开连接 if (value === \'bye\') { ws.close((err: BusinessError, value: boolean) => { if (!err) { console.log(\"close success\"); } else { console.log(\"close fail, err is \" + JSON.stringify(err)); } }); }});ws.on(\'close\', (err: BusinessError, value: webSocket.CloseResult) => { console.log(\"on close, code is \" + value.code + \", reason is \" + value.reason);});ws.on(\'error\', (err: BusinessError) => { console.log(\"on error, error:\" + JSON.stringify(err));});ws.connect(defaultIpAddress, { header:{ name1: \'value1\', name2: \'value2\', name3: \'value3\' }, proxy: { host: \'192.168.0.150\', port: 8888, exclusionList: [] }, protocol: \'my-protocol\', }, (err: BusinessError, value: boolean) => { if (!err) { console.log(\"connect success\"); } else { console.log(\"connect fail, err:\" + JSON.stringify(err)); } ws.close((err: BusinessError) => { if (!err) { console.log(\"close success\"); } else { console.log(\"close fail, err is \" + JSON.stringify(err)); } });});
webSocket.createWebSocket6+
createWebSocket(): WebSocket
创建一个WebSocket,里面包括建立连接、关闭连接、发送数据和订阅/取消订阅WebSocket连接的打开事件、接收到服务器消息事件、关闭事件和错误事件。
元服务API: 从API version 11开始,该接口支持在元服务中使用。
系统能力:SystemCapability.Communication.NetStack
返回值:
示例:
let ws: webSocket.WebSocket = webSocket.createWebSocket();
WebSocket6+
在调用WebSocket的方法前,需要先通过webSocket.createWebSocket创建一个WebSocket。
connect6+
connect(url: string, callback: AsyncCallback): void
根据URL地址,建立一个WebSocket连接,使用callback方式作为异步方法。
说明
可通过监听error事件获得该接口的执行结果,错误发生时会得到错误码:200。
需要权限:ohos.permission.INTERNET
元服务API: 从API version 11开始,该接口支持在元服务中使用。
系统能力:SystemCapability.Communication.NetStack
**注意:**URL地址长度不能超过1024个字符,否则会连接失败。
参数:
错误码:
说明
以上错误码的详细介绍。
示例:
import { webSocket } from \'@kit.NetworkKit\';import { BusinessError } from \'@kit.BasicServicesKit\';let ws = webSocket.createWebSocket();let url = \"ws://\";ws.connect(url, (err: BusinessError, value: boolean) => { if (!err) { console.log(\"connect success\"); } else { console.log(\"connect fail, err:\" + JSON.stringify(err)); }});
connect6+
connect(url: string, options: WebSocketRequestOptions, callback: AsyncCallback): void
根据URL地址和header,建立一个WebSocket连接,使用callback方式作为异步方法。
说明
可通过监听error事件获得该接口的执行结果,错误发生时会得到错误码:200。
需要权限:ohos.permission.INTERNET
元服务API: 从API version 11开始,该接口支持在元服务中使用。
系统能力:SystemCapability.Communication.NetStack
**注意:**URL地址长度不能超过1024个字符,否则会连接失败。
参数:
错误码:
说明
以上错误码的详细介绍。
示例:
import { webSocket } from \'@kit.NetworkKit\';import { BusinessError } from \'@kit.BasicServicesKit\';let ws = webSocket.createWebSocket();let options: webSocket.WebSocketRequestOptions | undefined;if (options !=undefined) { options.header = { name1: \"value1\", name2: \"value2\", name3: \"value3\" }; options.caPath = \"\";}let url = \"ws://\"ws.connect(url, options, (err: BusinessError, value: Object) => { if (!err) { console.log(\"connect success\"); } else { console.log(\"connect fail, err:\" + JSON.stringify(err)) }});
connect6+
connect(url: string, options?: WebSocketRequestOptions): Promise
根据URL地址和header,建立一个WebSocket连接,使用Promise方式作为异步方法。
说明
可通过监听error事件获得该接口的执行结果,错误发生时会得到错误码:200。
需要权限:ohos.permission.INTERNET
元服务API: 从API version 11开始,该接口支持在元服务中使用。
系统能力:SystemCapability.Communication.NetStack
**注意:**URL地址长度不能超过1024个字符,否则会连接失败。
参数:
返回值:
错误码:
说明
以上错误码的详细介绍。
示例:
import { webSocket } from \'@kit.NetworkKit\';let ws = webSocket.createWebSocket();let url = \"ws://\"let promise = ws.connect(url);promise.then((value: boolean) => { console.log(\"connect success\")}).catch((err:string) => { console.log(\"connect fail, error:\" + JSON.stringify(err))});
send6+
send(data: string | ArrayBuffer, callback: AsyncCallback): void
通过WebSocket连接发送数据,使用callback方式作为异步方法。
需要权限:ohos.permission.INTERNET
元服务API: 从API version 11开始,该接口支持在元服务中使用。
系统能力:SystemCapability.Communication.NetStack
参数:
发送的数据。
API 6及更早版本仅支持string类型。API 8起同时支持string和ArrayBuffer类型。
错误码:
示例:
import { webSocket } from \'@kit.NetworkKit\';import { BusinessError } from \'@kit.BasicServicesKit\';let ws = webSocket.createWebSocket();let url = \"ws://\"class OutValue { status: number = 0 message: string = \"\"}ws.connect(url, (err: BusinessError, value: boolean) => { if (!err) { console.log(\"connect success\"); } else { console.log(\"connect fail, err:\" + JSON.stringify(err)) }});ws.on(\'open\', (err: BusinessError, value: Object) => { console.log(\"on open, status:\" + (value as OutValue).status + \", message:\" + (value as OutValue).message); ws.send(\"Hello, server!\", (err: BusinessError, value: boolean) => { if (!err) { console.log(\"send success\"); } else { console.log(\"send fail, err:\" + JSON.stringify(err)) } });});
说明
send接口必须在监听到open事件后才可以调用。
send6+
send(data: string | ArrayBuffer): Promise
通过WebSocket连接发送数据,使用Promise方式作为异步方法。
需要权限:ohos.permission.INTERNET
元服务API: 从API version 11开始,该接口支持在元服务中使用。
系统能力:SystemCapability.Communication.NetStack
参数:
发送的数据。
API 6及更早版本仅支持string类型。API 8起同时支持string和ArrayBuffer类型。
返回值:
错误码:
示例:
import { webSocket } from \'@kit.NetworkKit\';import { BusinessError } from \'@kit.BasicServicesKit\';let ws = webSocket.createWebSocket();let url = \"ws://\"class OutValue { status: number = 0 message: string = \"\"}ws.connect(url, (err: BusinessError, value: boolean) => { if (!err) { console.log(\"connect success\"); } else { console.log(\"connect fail, err:\" + JSON.stringify(err)) }});ws.on(\'open\', (err: BusinessError, value: Object) => { console.log(\"on open, status:\" + (value as OutValue).status + \", message:\" + (value as OutValue).message); let promise = ws.send(\"Hello, server!\"); promise.then((value: boolean) => { console.log(\"send success\") }).catch((err:string) => { console.log(\"send fail, error:\" + JSON.stringify(err)) });});
说明
send接口必须在监听到open事件后才可以调用。
close6+
close(callback: AsyncCallback): void
关闭WebSocket连接,使用callback方式作为异步方法。
需要权限:ohos.permission.INTERNET
元服务API: 从API version 11开始,该接口支持在元服务中使用。
系统能力:SystemCapability.Communication.NetStack
参数:
错误码:
示例:
import { webSocket } from \'@kit.NetworkKit\';import { BusinessError } from \'@kit.BasicServicesKit\';let ws = webSocket.createWebSocket();ws.close((err: BusinessError) => { if (!err) { console.log(\"close success\") } else { console.log(\"close fail, err is \" + JSON.stringify(err)) }});
close6+
close(options: WebSocketCloseOptions, callback: AsyncCallback): void
根据可选参数code和reason,关闭WebSocket连接,使用callback方式作为异步方法。
需要权限:ohos.permission.INTERNET
元服务API: 从API version 11开始,该接口支持在元服务中使用。
系统能力:SystemCapability.Communication.NetStack
参数:
错误码:
示例:
import { webSocket } from \'@kit.NetworkKit\';import { BusinessError } from \'@kit.BasicServicesKit\';let ws = webSocket.createWebSocket();let options: webSocket.WebSocketCloseOptions | undefined;if (options != undefined) { options.code = 1000 options.reason = \"your reason\"}ws.close(options, (err: BusinessError) => { if (!err) { console.log(\"close success\") } else { console.log(\"close fail, err is \" + JSON.stringify(err)) }});
close6+
close(options?: WebSocketCloseOptions): Promise
根据可选参数code和reason,关闭WebSocket连接,使用Promise方式作为异步方法。
需要权限:ohos.permission.INTERNET
元服务API: 从API version 11开始,该接口支持在元服务中使用。
系统能力:SystemCapability.Communication.NetStack
参数:
返回值:
错误码:
示例:
import { webSocket } from \'@kit.NetworkKit\';let ws = webSocket.createWebSocket();let options: webSocket.WebSocketCloseOptions | undefined;if (options != undefined) { options.code = 1000 options.reason = \"your reason\"}let promise = ws.close();promise.then((value: boolean) => { console.log(\"close success\")}).catch((err:string) => { console.log(\"close fail, err is \" + JSON.stringify(err))});
on(\'open\')6+
on(type: \'open\', callback: AsyncCallback): void
订阅WebSocket的打开事件,使用callback方式作为异步方法。
元服务API: 从API version 11开始,该接口支持在元服务中使用。
系统能力:SystemCapability.Communication.NetStack
参数:
示例:
import { webSocket } from \'@kit.NetworkKit\';import { BusinessError, Callback } from \'@kit.BasicServicesKit\';let ws= webSocket.createWebSocket();class OutValue { status: number = 0 message: string = \"\"}ws.on(\'open\', (err: BusinessError, value: Object) => { console.log(\"on open, status:\" + (value as OutValue).status + \", message:\" + (value as OutValue).message);});
off(\'open\')6+
off(type: \'open\', callback?: AsyncCallback): void
取消订阅WebSocket的打开事件,使用callback方式作为异步方法。
说明
可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。
元服务API: 从API version 11开始,该接口支持在元服务中使用。
系统能力:SystemCapability.Communication.NetStack
参数:
示例:
import { webSocket } from \'@kit.NetworkKit\';import { BusinessError } from \'@kit.BasicServicesKit\';let ws = webSocket.createWebSocket();class OutValue { status: number = 0 message: string = \"\"}let callback1 = (err: BusinessError, value: Object) => { console.log(\"on open, status:\" + ((value as OutValue).status + \", message:\" + (value as OutValue).message));}ws.on(\'open\', callback1);// 可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅ws.off(\'open\', callback1);
on(\'message\')6+
on(type: \'message\', callback: AsyncCallback): void
订阅WebSocket的接收到服务器消息事件,使用callback方式作为异步方法。
说明
AsyncCallback中的数据可以是字符串(API 6)或ArrayBuffer(API 8)。
元服务API: 从API version 11开始,该接口支持在元服务中使用。
系统能力:SystemCapability.Communication.NetStack
参数:
示例:
import { webSocket } from \'@kit.NetworkKit\';import { BusinessError } from \'@kit.BasicServicesKit\';let ws = webSocket.createWebSocket();ws.on(\'message\', (err: BusinessError, value: string | ArrayBuffer) => { console.log(\"on message, message:\" + value);});
off(\'message\')6+
off(type: \'message\', callback?: AsyncCallback): void
取消订阅WebSocket的接收到服务器消息事件,使用callback方式作为异步方法。
说明
AsyncCallback中的数据可以是字符串(API 6)或ArrayBuffer(API 8)。
可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。
元服务API: 从API version 11开始,该接口支持在元服务中使用。
系统能力:SystemCapability.Communication.NetStack
参数:
示例:
import { webSocket } from \'@kit.NetworkKit\';let ws = webSocket.createWebSocket();ws.off(\'message\');
on(\'close\')6+
on(type: \'close\', callback: AsyncCallback): void
订阅WebSocket的关闭事件,使用callback方式作为异步方法。
元服务API: 从API version 11开始,该接口支持在元服务中使用。
系统能力:SystemCapability.Communication.NetStack
参数:
回调函数。
close:close错误码,reason:错误码说明
示例:
import { webSocket } from \'@kit.NetworkKit\';import { BusinessError } from \'@kit.BasicServicesKit\';let ws = webSocket.createWebSocket();ws.on(\'close\', (err: BusinessError, value: webSocket.CloseResult) => { console.log(\"on close, code is \" + value.code + \", reason is \" + value.reason);});
off(\'close\')6+
off(type: \'close\', callback?: AsyncCallback): void
取消订阅WebSocket的关闭事件,使用callback方式作为异步方法。
说明
可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。
元服务API: 从API version 11开始,该接口支持在元服务中使用。
系统能力:SystemCapability.Communication.NetStack
参数:
回调函数。
close:close错误码,reason:错误码说明
示例:
import { webSocket } from \'@kit.NetworkKit\';let ws = webSocket.createWebSocket();ws.off(\'close\');
on(\'error\')6+
on(type: \'error\', callback: ErrorCallback): void
订阅WebSocket的Error事件,使用callback方式作为异步方法。
元服务API: 从API version 11开始,该接口支持在元服务中使用。
系统能力:SystemCapability.Communication.NetStack
参数:
回调函数。
常见错误码:200
示例:
import { webSocket } from \'@kit.NetworkKit\';import { BusinessError } from \'@kit.BasicServicesKit\';let ws = webSocket.createWebSocket();ws.on(\'error\', (err: BusinessError) => { console.log(\"on error, error:\" + JSON.stringify(err))});
off(\'error\')6+
off(type: \'error\', callback?: ErrorCallback): void
取消订阅WebSocket的Error事件,使用callback方式作为异步方法。
说明
可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。
元服务API: 从API version 11开始,该接口支持在元服务中使用。
系统能力:SystemCapability.Communication.NetStack
参数:
示例:
import { webSocket } from \'@kit.NetworkKit\';let ws = webSocket.createWebSocket();ws.off(\'error\');
on(\'dataEnd\')11+
on(type: \'dataEnd\', callback: Callback): void
订阅WebSocket的数据接收结束事件,使用callback方式作为异步方法。
系统能力:SystemCapability.Communication.NetStack
参数:
示例:
import { webSocket } from \'@kit.NetworkKit\';let ws = webSocket.createWebSocket();ws.on(\'dataEnd\', () => { console.log(\"on dataEnd\")});
off(\'dataEnd\')11+
off(type: \'dataEnd\', callback?: Callback): void
取消订阅WebSocket的数据接收结束事件,使用callback方式作为异步方法。
说明
可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。
系统能力:SystemCapability.Communication.NetStack
参数:
示例:
import { webSocket } from \'@kit.NetworkKit\';let ws = webSocket.createWebSocket();ws.off(\'dataEnd\');
on(\'headerReceive\')12+
on(type: \'headerReceive\', callback: Callback): void
订阅HTTP Response Header事件,使用callback方式作为同步方法。
系统能力:SystemCapability.Communication.NetStack
参数:
示例:
import { webSocket } from \'@kit.NetworkKit\';let ws = webSocket.createWebSocket();ws.on(\'headerReceive\', (data) => { console.log(\"on headerReceive \" + JSON.stringify(data));});
off(\'headerReceive\')12+
off(type: \'headerReceive\', callback?: Callback): void
取消订阅HTTP Response Header事件,使用callback方式作为同步方法。
说明
可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。
系统能力:SystemCapability.Communication.NetStack
参数:
示例:
import { webSocket } from \'@kit.NetworkKit\';let ws = webSocket.createWebSocket();ws.off(\'headerReceive\');
WebSocketRequestOptions
建立WebSocket连接时,可选参数的类型和说明。
系统能力:SystemCapability.Communication.NetStack
建立WebSocket连接可选参数,代表建立连接时携带的HTTP头信息。参数内容自定义,也可以不指定。
元服务API: 从API version 11开始,该接口支持在元服务中使用。
ClientCert11+
客户端证书类型。
系统能力:SystemCapability.Communication.NetStack
ProxyConfiguration12+
type ProxyConfiguration = \'system\' | \'no-proxy\' | HttpProxy
网络代理配置信息
系统能力:SystemCapability.Communication.NetStack
WebSocketCloseOptions
关闭WebSocket连接时,可选参数的类型和说明。
元服务API: 从API version 11开始,该接口支持在元服务中使用。
系统能力:SystemCapability.Communication.NetStack
CloseResult10+
关闭WebSocket连接时,订阅close事件得到的关闭结果。
元服务API: 从API version 11开始,该接口支持在元服务中使用。
系统能力:SystemCapability.Communication.NetStack
ResponseHeaders12+
type ResponseHeaders = {[k: string]: string | string[] | undefined;}
服务器发送的响应头。
系统能力:SystemCapability.Communication.NetStack
close错误码说明
发送给服务端的错误码可以自行定义,下面的列表仅供参考。
系统能力:SystemCapability.Communication.NetStack
HttpProxy
type HttpProxy = connection.HttpProxy
网络全局代理配置信息。
系统能力:SystemCapability.Communication.NetStack