HarmonyOS 使用WebSocket访问网络

今人不见古时月,今月曾经照古人

38人浏览 · 2026-02-11 17:49:50

今人不见古时月,今月曾经照古人 · 2026-02-11 17:49:50 发布

场景介绍

WebSocket是一种网络通信协议，它允许客户端和服务器之间建立一个持久的连接，并在该连接上进行全双工通信，连接之后客户端和服务器端可以同时主动发送数据，这是WebSocket和传统的HTTP协议最大的区别，HTTP以单向通信为主，客户端发起请求，服务器端响应数据，一次传输之后，连接会断开。一般情况下，HTTP适用于一次性数据获取（如网页内容加载），Websocket适用于实时性要求高的场景下（如在线聊天、实时游戏），以避免频繁建立连接提升用户体验。

该模块给第三方应用提供webSocket客户端和服务端能力，实现客户端与服务端的双向连接，目前服务端仅支持智慧屏使用。

客户端：使用WebSocket建立服务器与客户端的双向连接，需要先通过createWebSocket()方法创建WebSocket对象，然后通过connect()方法连接到服务器。当连接成功后，客户端会收到open事件的回调，之后客户端就可以通过send()方法与服务器进行通信。当服务器发信息给客户端时，客户端会收到message事件的回调。当客户端想要取消此连接时，通过调用close()方法主动断开连接后，客户端会收到close事件的回调。若在上述任一过程中发生错误，客户端会收到error事件的回调。

服务端：（目前服务端仅支持智慧屏使用）使用WebSocket建立服务器与客户端的双向连接，需要先通过createWebSocketServer()方法创建WebSocketServer对象，然后通过start()方法启动服务器，监听客户端申请建链的消息。当连接成功后，服务端会收到connect事件的回调，之后服务端可以通过send()方法与客户端进行通信，可以通过listAllConnections()方法列举出当前与服务端建链的所有客户端信息。当客户端给服务端发消息时，服务端会收到messageReceive事件回调。当服务端想断开某个与客户端的连接时，可以通过调用close()方法主动断开与某个客户端的连接，之后服务端会收到close事件的回调。当服务端想停止service时，可以调用stop()方法。若在上述任一过程中发生错误，服务端会收到error事件的回调。

说明

websocket支持心跳检测机制，在客户端和服务端建立webSocket连接之后，从连接建立或者客户端收到Pong帧开始计时，每间隔pingInterval秒客户端会发送Ping帧给服务器。服务器若支持websocket协议则会在收到Ping帧后自动回复Pong帧，表示连接正常，若服务端异常或服务端不支持websocket协议则不会回复Pong帧；若Ping帧发出去后，pongTimeout秒内没有收到Pong帧，则会主动断开连接。支持开发者关闭心跳检测机制，自定义pingInterval与pongTimeout，详情请参考WebsocketRequestOptions。

服务端从API version 19开始支持。

client端开发步骤

导入webSocket以及错误码模块。
1. import { webSocket } from '@kit.NetworkKit';
2. import { BusinessError } from '@kit.BasicServicesKit';
3. import { hilog } from '@kit.PerformanceAnalysisKit';
创建WebSocket连接，返回一个WebSocket对象。
1. let defaultIpAddress = 'wss://echo.websocket.org'; // WebSocket地址
2. let ws: webSocket.WebSocket = webSocket.createWebSocket();
订阅WebSocket的打开、消息接收、关闭、Error事件（可选），当收到on('open')事件时，可以通过send()方法与服务器进行通信，当收到服务器的bye消息时（此消息字段仅为示意，具体字段需要与服务器协商），主动断开连接。
1. ws.on('open', (err: BusinessError, value: Object) => {
2. hilog.info(0x0000, 'testTag', 'on open, status:' + JSON.stringify(value));
3. // 当收到on('open')事件时，可以通过send()方法与服务器进行通信。
4. // ...
5. });
7. ws.on('message', (err: BusinessError, value: string | ArrayBuffer) => {
8. // ...
9. hilog.info(0x0000, 'testTag', 'on message, message:' + value);
10. // 当收到服务器的`bye`消息时（此消息字段仅为示意，具体字段需要与服务器协商），主动断开连接。
11. if (value === 'bye') {
12. ws!.close((err: BusinessError) => {
13. if (!err) {
14. // ...
15. hilog.info(0x0000, 'testTag', `WebSocket closed successfully`);
16. } else {
17. // ...
18. hilog.error(0x0000, 'testTag', `WebSocket closing failed: ` + JSON.stringify(err));
19. }
20. });
21. }
22. })
24. ws.on('close', (err: BusinessError, value: webSocket.CloseResult) => {
25. hilog.info(0x0000, 'testTag', 'on close, code is ' + value.code + ', reason is ' + value.reason);
26. // ...
27. });
29. ws.on('error', (err: BusinessError) => {
30. // ...
31. hilog.error(0x0000, 'testTag', 'WebSocket error: ' + JSON.stringify(err));
32. });
根据URL地址，发起WebSocket连接。
1. ws.connect(defaultIpAddress, (err: BusinessError, value: boolean) => {
2. if (!err) {
3. hilog.info(0x0000, 'testTag', 'Connected successfully');
4. } else {
5. // ...
6. hilog.error(0x0000, 'testTag', `WebSocket connection failed: ` + JSON.stringify(err));
7. }
8. });
收到on('open')的回调事件后，可通过send()方法向服务器发送数据。
1. ws.send('Hello, server!', (err: BusinessError, value: boolean) => {
2. if (!err) {
3. // ...
4. hilog.info(0x0000, 'testTag', 'Message sent successfully');
5. } else {
6. // ...
7. hilog.error(0x0000, 'testTag', `Message sending failed: ` + JSON.stringify(err));
8. }
9. });

server端开发步骤

导入webSocket以及错误码模块。
1. import { webSocket } from '@kit.NetworkKit';
2. import { BusinessError } from '@kit.BasicServicesKit';
3. import { hilog } from '@kit.PerformanceAnalysisKit';
创建WebSocketServer对象。
1. let localServer: webSocket.WebSocketServer;
2. localServer = webSocket.createWebSocketServer();
订阅WebSocketServer的客户端连接事件、消息接收事件、关闭事件、Error事件（可选），在收到客户端连接事件后，服务端可以通过send()方法与客户端进行通信，当收到客户端的"bye"消息时（此消息字段仅为示意，具体字段需要与客户端协商），主动断开连接。
1. localServer.on('connect', async (connection: webSocket.WebSocketConnection) => {
2. hilog.info(0x0000, 'testTag', `New client connected! Client ip: ${connection.clientIP}, Client port: ${connection.clientPort}`);
3. // 当收到on('connect')事件时，可以通过send()方法与客户端进行通信。
4. localServer.send("Hello, I'm server!", connection).then((success: boolean) => {
5. if (success) {
6. hilog.info(0x0000, 'testTag', 'message send successfully');
7. } else {
8. hilog.error(0x0000, 'testTag', 'message send failed');
9. }
10. }).catch((error: BusinessError) => {
11. hilog.error(0x0000, 'testTag', `message send failed, Code: ${error.code}, message: ${error.message}`);
12. });
13. });
15. localServer.on('messageReceive', (message: webSocket.WebSocketMessage) => {
16. try {
17. hilog.info(0x0000, 'testTag', `on message received, client: ${message.clientConnection}, data: ${message.data}`);
18. // 当收到客户端的"bye"消息时（此消息字段仅为示意，具体字段需要与客户端协商），主动断开连接。
19. if (message.data === 'bye') {
20. localServer.close(message.clientConnection).then((success: boolean) => {
21. if (success) {
22. hilog.info(0x0000, 'testTag', 'close client successfully');
23. } else {
24. hilog.error(0x0000, 'testTag', 'close client failed');
25. }
26. });
27. }
28. } catch (error) {
29. hilog.error(0x0000, 'testTag', `on messageReceive failed. Code: ${error.code}, message: ${error.message}`);
30. }
31. });
33. localServer.on('close', (clientConnection: webSocket.WebSocketConnection, closeReason: webSocket.CloseResult) => {
34. hilog.info(0x0000, 'testTag', `client close, client: ${clientConnection}, closeReason: Code: ${closeReason.code}, reason: ${closeReason.reason}`);
35. });
37. localServer.on('error', (error: BusinessError) => {
38. hilog.error(0x0000, 'testTag', `error. Code: ${error.code}, message: ${error.message}`);
39. });
配置config参数启动server端服务。
1. let config: webSocket.WebSocketServerConfig = {
2. // 监听端口。
3. serverPort: 8080,
4. maxConcurrentClientsNumber: 10,
5. maxConnectionsForOneClient: 10,
6. }
7. localServer.start(config).then((success: boolean) => {
8. if (success) {
9. hilog.info(0x0000, 'testTag', 'WebSocket server started successfully');
10. } else {
11. hilog.error(0x0000, 'testTag', 'Failed to start WebSocket server');
12. }
13. }).catch((error: BusinessError) => {
14. hilog.error(0x0000, 'testTag', `Failed to start. Code: ${error.code}, message: ${error.message}`);
15. });
服务端监听所有客户端连接状态（可选）。
1. let connections: webSocket.WebSocketConnection[] = [];
3. // ...
4. try {
5. connections = await localServer.listAllConnections();
6. if (connections.length === 0) {
7. hilog.info(0x0000, 'testTag', 'client list is empty');
8. // ...
9. } else {
10. hilog.info(0x0000, 'testTag', `client list cnt: ${connections.length}, client connections list is: ${connections}`);
11. }
12. } catch (error) {
13. hilog.error(0x0000, 'testTag', `Failed to listAllConnections. Code: ${error.code}, message: ${error.message}`);
14. // ...
15. }
需要关闭WebSocketServer端服务器时，可以通过stop()停止服务。
1. localServer.stop().then((success: boolean) => {
2. if (success) {
3. hilog.info(0x0000, 'testTag', 'server stop service successfully');
4. // ...
5. } else {
6. hilog.error(0x0000, 'testTag', 'server stop service failed');
7. // ...
8. }
9. });