@ohos.net.webSocket 模块可以建立 WebSocket 连接,实现与服务器之间的实时双向通信。WebSocket 提供了一种低延迟的通信方式,非常适合实时应用,如聊天应用、在线游戏等。
下面是使用 @ohos.net.webSocket 模块建立 WebSocket 连接的步骤:
1、添加权限
确保在 config.json 文件中添加了网络访问权限:
{
"name": "com.example.myapplication",
"applicableDevice": [
{
"deviceType": "phone",
"appPermissions": [
"ohos.permission.INTERNET"
]
}
],
...
}
2、导入模块
在你的 JavaScript 文件中,需要导入 @ohos.net.webSocket 模块:
import WebSocket from '@ohos.net.webSocket';
3、创建 WebSocket 客户端
接下来,创建一个 WebSocket 客户端实例,并设置连接参数。
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));
}
});
});
4、运行代码
调用 connectToWebSocket() 函数来启动 WebSocket 连接。
connectToWebSocket();
备注:
- 确保你的 WebSocket 服务器支持 HTTPS(即使用 wss:// 协议),因为大多数现代浏览器和平台要求 WebSocket 连接必须是安全的。
- 在实际应用中,你可能还需要处理重连逻辑、心跳包等,以保持连接的稳定性。
- 如果需要发送二进制数据,可以使用 sendBinary() 方法。