HarmonyOS网络管理开发 |
您所在的位置:网站首页 › 鸿蒙网络掉线 › HarmonyOS网络管理开发 |
HarmonyOS网络管理开发—HTTP与WebSocket一、网络管理开发概述 网络管理模块主要提供以下功能: ● HTTP数据请求:通过HTTP发起一个数据请求。 ● WebSocket连接:使用WebSocket建立服务器与客户端的双向连接。 ● Socket连接:通过Socket进行数据传输。 约束与限制使用网络管理模块的相关功能时,需要请求相应的权限。 权限名 说明 ohos.permission.GET_NETWORK_INFO 获取网络连接信息。 ohos.permission.SET_NETWORK_INFO 修改网络连接状态。 ohos.permission.INTERNET 允许程序打开网络套接字,进行网络连接。 二、 HTTP数据请求场景介绍应用通过HTTP发起一个数据请求,支持常见的GET、POST、OPTIONS、HEAD、PUT、DELETE、TRACE、CONNECT方法。 接口说明HTTP数据请求功能主要由http模块提供。 使用该功能需要申请ohos.permission.INTERNET权限。 权限申请请参考访问控制(权限)开发指导。 涉及的接口如下表,具体的接口说明请参考API文档。 接口名 功能描述 createHttp() 创建一个http请求。 request() 根据URL地址,发起HTTP网络请求。 destroy() 中断请求任务。 on(type: 'headersReceive') 订阅HTTP Response Header 事件。 off(type: 'headersReceive') 取消订阅HTTP Response Header 事件。 once('headersReceive')8+ 订阅HTTP Response Header 事件,但是只触发一次。 request接口开发步骤1. 从@ohos.net.http.d.ts中导入http命名空间。 2. 调用createHttp()方法,创建一个HttpRequest对象。 3. 调用该对象的on()方法,订阅http响应头事件,此接口会比request请求先返回。可以根据业务需要订阅此消息。 4. 调用该对象的request()方法,传入http请求的url地址和可选参数,发起网络请求。 5. 按照实际业务需要,解析返回结果。 6. 调用该对象的off()方法,取消订阅http响应头事件。 7. 当该请求使用完毕时,调用destroy()方法主动销毁。 // 引入包名 import http from '@ohos.net.http'; // 每一个httpRequest对应一个HTTP请求任务,不可复用 let httpRequest = http.createHttp(); // 用于订阅HTTP响应头,此接口会比request请求先返回。可以根据业务需要订阅此消息 // 从API 8开始,使用on('headersReceive', Callback)替代on('headerReceive', AsyncCallback)。 8+ httpRequest.on('headersReceive', (header) => { console.info('header: ' + JSON.stringify(header)); }); httpRequest.request( // 填写HTTP请求的URL地址,可以带参数也可以不带参数。URL地址需要开发者自定义。请求的参数可以在extraData中指定 "EXAMPLE_URL", { method: http.RequestMethod.POST, // 可选,默认为http.RequestMethod.GET // 开发者根据自身业务需要添加header字段 header: { 'Content-Type': 'application/json' }, // 当使用POST请求时此字段用于传递内容 extraData: { "data": "data to send", }, expectDataType: http.HttpDataType.STRING, // 可选,指定返回数据的类型 usingCache: true, // 可选,默认为true priority: 1, // 可选,默认为1 connectTimeout: 60000, // 可选,默认为60000ms readTimeout: 60000, // 可选,默认为60000ms usingProtocol: http.HttpProtocol.HTTP1_1, // 可选,协议类型默认值由系统自动指定 }, (err, data) => { if (!err) { // data.result为HTTP响应内容,可根据业务需要进行解析 console.info('Result:' + JSON.stringify(data.result)); console.info('code:' + JSON.stringify(data.responseCode)); // data.header为HTTP响应头,可根据业务需要进行解析 console.info('header:' + JSON.stringify(data.header)); console.info('cookies:' + JSON.stringify(data.cookies)); // 8+ } else { console.info('error:' + JSON.stringify(err)); // 取消订阅HTTP响应头事件 httpRequest.off('headersReceive'); // 当该请求使用完毕时,调用destroy方法主动销毁 httpRequest.destroy(); } } ); 三、 WebSocket连接场景介绍使用WebSocket建立服务器与客户端的双向连接,需要先通过createWebSocket()方法创建WebSocket对象,然后通过connect()方法连接到服务器。当连接成功后,客户端会收到open事件的回调,之后客户端就可以通过send()方法与服务器进行通信。当服务器发信息给客户端时,客户端会收到message事件的回调。当客户端不要此连接时,可以通过调用close()方法主动断开连接,之后客户端会收到close事件的回调。 若在上述任一过程中发生错误,客户端会收到error事件的回调。 接口说明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事件。 开发步骤1. 导入需要的webSocket模块。 2. 创建一个WebSocket连接,返回一个WebSocket对象。 3. (可选)订阅WebSocket的打开、消息接收、关闭、Error事件。 4. 根据URL地址,发起WebSocket连接。 5. 使用完WebSocket连接之后,主动断开连接。 import webSocket from '@ohos.net.webSocket'; var defaultIpAddress = "ws://"; let ws = webSocket.createWebSocket(); ws.on('open', (err, value) => { console.log("on open, status:" + JSON.stringify(value)); // 当收到on('open')事件时,可以通过send()方法与服务器进行通信 ws.send("Hello, server!", (err, value) => { if (!err) { console.log("Message sent successfully"); } else { console.log("Failed to send the message. Err:" + JSON.stringify(err)); } }); }); ws.on('message', (err, value) => { console.log("on message, message:" + value); // 当收到服务器的`bye`消息时(此消息字段仅为示意,具体字段需要与服务器协商),主动断开连接 if (value === 'bye') { ws.close((err, value) => { if (!err) { console.log("Connection closed successfully"); } else { console.log("Failed to close the connection. Err: " + JSON.stringify(err)); } }); } }); ws.on('close', (err, value) => { console.log("on close, code is " + value.code + ", reason is " + value.reason); }); ws.on('error', (err) => { console.log("on error, error:" + JSON.stringify(err)); }); ws.connect(defaultIpAddress, (err, value) => { if (!err) { console.log("Connected successfully"); } else { console.log("Connection failed. Err:" + JSON.stringify(err)); } }); |
CopyRight 2018-2019 办公设备维修网 版权所有 豫ICP备15022753号-3 |