鸿蒙WebSocket的使用竟如此简单

使用WebSocket建立服务器与客户端的双向连接，需要先通过createWebSocket()方法创建WebSocket对象，然后通过connect()方法连接到服务器。当连接成功后，客户端会收到open事件的回调，之后客户端就可以通过send()方法与服务器进行通信。当服务器发信息给客户端时，客户端会收到message事件的回调。当客户端不要此连接时，可以通过调用close()方法主动断开连接，之后客户端会收到close事件的回调。
若在上述任一过程中发生错误，客户端会收到error事件的回调。
websocket支持心跳检测机制，在客户端和服务端建立WebSocket连接之后，每间隔一段时间会客户端会发送Ping帧给服务器，服务器收到后应立即回复Pong帧。
接口说明

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事件
  

开发步骤

• 导入需要的webSocket模块
  
• 创建一个WebSocket连接，返回一个WebSocket对象
  
• （可选）订阅WebSocket的打开、消息接收、关闭、Error事件
  
• 根据URL地址，发起WebSocket连接
  
• 使用完WebSocket连接之后，主动断开连接
  

示例代码

1. import { webSocket } from '@kit.NetworkKit';
2. import { BusinessError } from '@kit.BasicServicesKit';
4. let defaultIpAddress = "ws://";
5. let ws = webSocket.createWebSocket();
6. ws.on('open', (err: BusinessError, value: Object) => {
7.   console.log("on open, status:" + JSON.stringify(value));
8.   // 当收到on('open')事件时，可以通过send()方法与服务器进行通信
9.   ws.send("Hello, server!", (err: BusinessError, value: boolean) => {
10.     if (!err) {
11.       console.log("Message send successfully");
12.     } else {
13.       console.log("Failed to send the message. Err:" + JSON.stringify(err));
14.     }
15.   });
16. });
17. ws.on('message', (err: BusinessError, value: string | ArrayBuffer) => {
18.   console.log("on message, message:" + value);
19.   // 当收到服务器的`bye`消息时（此消息字段仅为示意，具体字段需要与服务器协商），主动断开连接
20.   if (value === 'bye') {
21.     ws.close((err: BusinessError, value: boolean) => {
22.       if (!err) {
23.         console.log("Connection closed successfully");
24.       } else {
25.         console.log("Failed to close the connection. Err: " + JSON.stringify(err));
26.       }
27.     });
28.   }
29. });
30. ws.on('close', (err: BusinessError, value: webSocket.CloseResult) => {
31.   console.log("on close, code is " + value.code + ", reason is " + value.reason);
32. });
33. ws.on('error', (err: BusinessError) => {
34.   console.log("on error, error:" + JSON.stringify(err));
35. });
36. ws.connect(defaultIpAddress, (err: BusinessError, value: boolean) => {
37.   if (!err) {
38.     console.log("Connected successfully");
39.   } else {
40.     console.log("Connection failed. Err:" + JSON.stringify(err));
41.   }
42. });

复制代码

来源：程序园用户自行投稿发布，如果侵权，请联系站长删除
免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！