• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# WebSocket连接
2
3
4## 场景介绍
5
6使用WebSocket建立服务器与客户端的双向连接，需要先通过createWebSocket()方法创建WebSocket对象，然后通过connect()方法连接到服务器。当连接成功后，客户端会收到open事件的回调，之后客户端就可以通过send()方法与服务器进行通信。当服务器发信息给客户端时，客户端会收到message事件的回调。当客户端不要此连接时，可以通过调用close()方法主动断开连接，之后客户端会收到close事件的回调。
7
8若在上述任一过程中发生错误，客户端会收到error事件的回调。
9
10
11## 接口说明
12
13WebSocket连接功能主要由webSocket模块提供。使用该功能需要申请ohos.permission.INTERNET权限。具体接口说明如下表。
14
15| 接口名 | 功能描述 |
16| -------- | -------- |
17| createWebSocket() | 创建一个WebSocket连接。 |
18| connect() | 根据URL地址，建立一个WebSocket连接。 |
19| send() | 通过WebSocket连接发送数据。 |
20| close() | 关闭WebSocket连接。 |
21| on(type: 'open') | 订阅WebSocket的打开事件。 |
22| off(type: 'open') | 取消订阅WebSocket的打开事件。 |
23| on(type: 'message') | 订阅WebSocket的接收到服务器消息事件。 |
24| off(type: 'message') | 取消订阅WebSocket的接收到服务器消息事件。 |
25| on(type: 'close') | 订阅WebSocket的关闭事件。 |
26| off(type: 'close') | 取消订阅WebSocket的关闭事件 |
27| on(type: 'error') | 订阅WebSocket的Error事件。 |
28| off(type: 'error') | 取消订阅WebSocket的Error事件。 |
29
30
31## 开发步骤
32
331. 导入需要的webSocket模块。
34
352. 创建一个WebSocket连接，返回一个WebSocket对象。
36
373. （可选）订阅WebSocket的打开、消息接收、关闭、Error事件。
38
394. 根据URL地址，发起WebSocket连接。
40
415. 使用完WebSocket连接之后，主动断开连接。
42
43   ```js
44   import webSocket from '@ohos.net.webSocket';
45
46   var defaultIpAddress = "ws://";
47   let ws = webSocket.createWebSocket();
48   ws.on('open', (err, value) => {
49       console.log("on open, status:" + JSON.stringify(value));
50       // 当收到on('open')事件时，可以通过send()方法与服务器进行通信
51       ws.send("Hello, server!", (err, value) => {
52           if (!err) {
53               console.log("Message sent successfully");
54           } else {
55               console.log("Failed to send the message. Err:" + JSON.stringify(err));
56           }
57       });
58   });
59   ws.on('message', (err, value) => {
60       console.log("on message, message:" + value);
61       // 当收到服务器的`bye`消息时（此消息字段仅为示意，具体字段需要与服务器协商），主动断开连接
62       if (value === 'bye') {
63           ws.close((err, value) => {
64               if (!err) {
65                   console.log("Connection closed successfully");
66               } else {
67                   console.log("Failed to close the connection. Err: " + JSON.stringify(err));
68               }
69           });
70       }
71   });
72   ws.on('close', (err, value) => {
73       console.log("on close, code is " + value.code + ", reason is " + value.reason);
74   });
75   ws.on('error', (err) => {
76       console.log("on error, error:" + JSON.stringify(err));
77   });
78   ws.connect(defaultIpAddress, (err, value) => {
79       if (!err) {
80           console.log("Connected successfully");
81       } else {
82           console.log("Connection failed. Err:" + JSON.stringify(err));
83       }
84   });
85   ```
86
87## 相关实例
88
89针对WebSocket连接的开发，有以下相关实例可供参考：
90- [`WebSocket`：WebSocket（ArkTS）（API9）](https://gitee.com/openharmony/applications_app_samples/tree/OpenHarmony-3.2-Release/Network/WebSocket)