1# HTTP数据请求 2 3## 场景介绍 4 5应用通过HTTP发起一个数据请求，支持常见的GET、POST、OPTIONS、HEAD、PUT、DELETE、TRACE、CONNECT方法。 6 7## 接口说明 8 9HTTP数据请求功能主要由http模块提供。 10 11使用该功能需要申请ohos.permission.INTERNET权限。 12 13权限申请请参考[声明权限](../security/AccessToken/declare-permissions.md)。 14 15涉及的接口如下表，具体的接口说明请参考[API文档](../reference/apis-network-kit/js-apis-http.md)。 16 17| 接口名 | 描述 | 18| ----------------------------------------- | ----------------------------------- | 19| createHttp() | 创建一个http请求。 | 20| request() | 根据URL地址，发起HTTP网络请求。 | 21| requestInStream()<sup>10+</sup> | 根据URL地址，发起HTTP网络请求并返回流式响应。 | 22| destroy() | 中断请求任务。 | 23| on(type: 'headersReceive') | 订阅HTTP Response Header 事件。 | 24| off(type: 'headersReceive') | 取消订阅HTTP Response Header 事件。 | 25| once\('headersReceive'\)<sup>8+</sup> | 订阅HTTP Response Header 事件，但是只触发一次。| 26| on\('dataReceive'\)<sup>10+</sup> | 订阅HTTP流式响应数据接收事件。 | 27| off\('dataReceive'\)<sup>10+</sup> | 取消订阅HTTP流式响应数据接收事件。 | 28| on\('dataEnd'\)<sup>10+</sup> | 订阅HTTP流式响应数据接收完毕事件。 | 29| off\('dataEnd'\)<sup>10+</sup> | 取消订阅HTTP流式响应数据接收完毕事件。 | 30| on\('dataReceiveProgress'\)<sup>10+</sup> | 订阅HTTP流式响应数据接收进度事件。 | 31| off\('dataReceiveProgress'\)<sup>10+</sup> | 取消订阅HTTP流式响应数据接收进度事件。 | 32| on\('dataSendProgress'\)<sup>11+</sup> | 订阅HTTP网络请求数据发送进度事件。 | 33| off\('dataSendProgress'\)<sup>11+</sup> | 取消订阅HTTP网络请求数据发送进度事件。 | 34 35## request接口开发步骤 36 371. 从@kit.NetworkKit中导入http命名空间。 382. 调用createHttp()方法，创建一个HttpRequest对象。 393. 调用该对象的on()方法，订阅http响应头事件，此接口会比request请求先返回。可以根据业务需要订阅此消息。 404. 调用该对象的request()方法，传入http请求的url地址和可选参数，发起网络请求。 415. 按照实际业务需要，解析返回结果。 426. 调用该对象的off()方法，取消订阅http响应头事件。 437. 当该请求使用完毕时，调用destroy()方法主动销毁。 44 45```ts 46// 引入包名 47import { http } from '@kit.NetworkKit'; 48import { BusinessError } from '@kit.BasicServicesKit'; 49 50// 每一个httpRequest对应一个HTTP请求任务，不可复用 51let httpRequest = http.createHttp(); 52// 用于订阅HTTP响应头，此接口会比request请求先返回。可以根据业务需要订阅此消息 53// 从API 8开始，使用on('headersReceive', Callback)替代on('headerReceive', AsyncCallback)。 8+ 54httpRequest.on('headersReceive', (header) => { 55 console.info('header: ' + JSON.stringify(header)); 56}); 57httpRequest.request( 58 // 填写HTTP请求的URL地址，可以带参数也可以不带参数。URL地址需要开发者自定义。请求的参数可以在extraData中指定 59 "EXAMPLE_URL", 60 { 61 method: http.RequestMethod.POST, // 可选，默认为http.RequestMethod.GET 62 // 开发者根据自身业务需要添加header字段 63 header: { 64 'Content-Type': 'application/json' 65 }, 66 // 当使用POST请求时此字段用于传递请求体内容，具体格式与服务端协商确定 67 extraData: "data to send", 68 expectDataType: http.HttpDataType.STRING, // 可选，指定返回数据的类型 69 usingCache: true, // 可选，默认为true 70 priority: 1, // 可选，默认为1 71 connectTimeout: 60000, // 可选，默认为60000ms 72 readTimeout: 60000, // 可选，默认为60000ms 73 usingProtocol: http.HttpProtocol.HTTP1_1, // 可选，协议类型默认值由系统自动指定 74 usingProxy: false, // 可选，默认不使用网络代理，自API 10开始支持该属性 75 caPath:'/path/to/cacert.pem', // 可选，默认使用系统预制证书，自API 10开始支持该属性 76 clientCert: { // 可选，默认不使用客户端证书，自API 11开始支持该属性 77 certPath: '/path/to/client.pem', // 默认不使用客户端证书，自API 11开始支持该属性 78 keyPath: '/path/to/client.key', // 若证书包含Key信息，传入空字符串，自API 11开始支持该属性 79 certType: http.CertType.PEM, // 可选，默认使用PEM，自API 11开始支持该属性 80 keyPassword: "passwordToKey" // 可选，输入key文件的密码，自API 11开始支持该属性 81 }, 82 multiFormDataList: [ // 可选，仅当Header中，'content-Type'为'multipart/form-data'时生效，自API 11开始支持该属性 83 { 84 name: "Part1", // 数据名，自API 11开始支持该属性 85 contentType: 'text/plain', // 数据类型，自API 11开始支持该属性 86 data: 'Example data', // 可选，数据内容，自API 11开始支持该属性 87 remoteFileName: 'example.txt' // 可选，自API 11开始支持该属性 88 }, { 89 name: "Part2", // 数据名，自API 11开始支持该属性 90 contentType: 'text/plain', // 数据类型，自API 11开始支持该属性 91 // data/app/el2/100/base/com.example.myapplication/haps/entry/files/fileName.txt 92 filePath: `${getContext(this).filesDir}/fileName.txt`, // 可选，传入文件路径，自API 11开始支持该属性 93 remoteFileName: 'fileName.txt' // 可选，自API 11开始支持该属性 94 } 95 ] 96 }, (err: BusinessError, data: http.HttpResponse) => { 97 if (!err) { 98 // data.result为HTTP响应内容，可根据业务需要进行解析 99 console.info('Result:' + JSON.stringify(data.result)); 100 console.info('code:' + JSON.stringify(data.responseCode)); 101 // data.header为HTTP响应头，可根据业务需要进行解析 102 console.info('header:' + JSON.stringify(data.header)); 103 console.info('cookies:' + JSON.stringify(data.cookies)); // 8+ 104 // 当该请求使用完毕时，调用destroy方法主动销毁 105 httpRequest.destroy(); 106 } else { 107 console.error('error:' + JSON.stringify(err)); 108 // 取消订阅HTTP响应头事件 109 httpRequest.off('headersReceive'); 110 // 当该请求使用完毕时，调用destroy方法主动销毁 111 httpRequest.destroy(); 112 } 113 } 114); 115``` 116 117## requestInStream接口开发步骤 118 1191. 从@kit.NetworkKit中导入http命名空间。 1202. 调用createHttp()方法，创建一个HttpRequest对象。 1213. 调用该对象的on()方法，可以根据业务需要订阅HTTP响应头事件、HTTP流式响应数据接收事件、HTTP流式响应数据接收进度事件和HTTP流式响应数据接收完毕事件。 1224. 调用该对象的requestInStream()方法，传入http请求的url地址和可选参数，发起网络请求。 1235. 按照实际业务需要，可以解析返回的响应码。 1246. 调用该对象的off()方法，取消订阅响应事件。 1257. 当该请求使用完毕时，调用destroy()方法主动销毁。 126 127```ts 128// 引入包名 129import { http } from '@kit.NetworkKit'; 130import { BusinessError } from '@kit.BasicServicesKit'; 131 132// 每一个httpRequest对应一个HTTP请求任务，不可复用 133let httpRequest = http.createHttp(); 134// 用于订阅HTTP响应头事件 135httpRequest.on('headersReceive', (header: Object) => { 136 console.info('header: ' + JSON.stringify(header)); 137}); 138// 用于订阅HTTP流式响应数据接收事件 139let res = new ArrayBuffer(0); 140httpRequest.on('dataReceive', (data: ArrayBuffer) => { 141 const newRes = new ArrayBuffer(res.byteLength + data.byteLength); 142 const resView = new Uint8Array(newRes); 143 resView.set(new Uint8Array(res)); 144 resView.set(new Uint8Array(data), res.byteLength); 145 res = newRes; 146 console.info('res length: ' + res.byteLength); 147}); 148// 用于订阅HTTP流式响应数据接收完毕事件 149httpRequest.on('dataEnd', () => { 150 console.info('No more data in response, data receive end'); 151}); 152// 用于订阅HTTP流式响应数据接收进度事件 153class Data { 154 receiveSize: number = 0; 155 totalSize: number = 0; 156} 157httpRequest.on('dataReceiveProgress', (data: Data) => { 158 console.log("dataReceiveProgress receiveSize:" + data.receiveSize + ", totalSize:" + data.totalSize); 159}); 160 161let streamInfo: http.HttpRequestOptions = { 162 method: http.RequestMethod.POST, // 可选，默认为http.RequestMethod.GET 163 // 开发者根据自身业务需要添加header字段 164 header: { 165 'Content-Type': 'application/json' 166 }, 167 // 当使用POST请求时此字段用于传递请求体内容，具体格式与服务端协商确定 168 extraData: "data to send", 169 expectDataType: http.HttpDataType.STRING,// 可选，指定返回数据的类型 170 usingCache: true, // 可选，默认为true 171 priority: 1, // 可选，默认为1 172 connectTimeout: 60000, // 可选，默认为60000ms 173 readTimeout: 60000, // 可选，默认为60000ms。若传输的数据较大，需要较长的时间，建议增大该参数以保证数据传输正常终止 174 usingProtocol: http.HttpProtocol.HTTP1_1 // 可选，协议类型默认值由系统自动指定 175} 176 177// 填写HTTP请求的URL地址，可以带参数也可以不带参数。URL地址需要开发者自定义。请求的参数可以在extraData中指定 178httpRequest.requestInStream("EXAMPLE_URL", streamInfo).then((data: number) => { 179 console.info("requestInStream OK!"); 180 console.info('ResponseCode :' + JSON.stringify(data)); 181 // 取消订阅HTTP响应头事件 182 httpRequest.off('headersReceive'); 183 // 取消订阅HTTP流式响应数据接收事件 184 httpRequest.off('dataReceive'); 185 // 取消订阅HTTP流式响应数据接收进度事件 186 httpRequest.off('dataReceiveProgress'); 187 // 取消订阅HTTP流式响应数据接收完毕事件 188 httpRequest.off('dataEnd'); 189 // 当该请求使用完毕时，调用destroy方法主动销毁 190 httpRequest.destroy(); 191}).catch((err: Error) => { 192 console.info("requestInStream ERROR : err = " + JSON.stringify(err)); 193}); 194``` 195 196## 相关实例 197 198针对HTTP数据请求，有以下相关实例可供参考： 199 200- [上传和下载（ArkTS）(API10)](https://gitee.com/openharmony/applications_app_samples/tree/OpenHarmony-5.0.1-Release/code/BasicFeature/Connectivity/UploadAndDownLoad) 201 202- [Http（ArkTS）（API10）](https://gitee.com/openharmony/applications_app_samples/tree/OpenHarmony-5.0.1-Release/code/BasicFeature/Connectivity/Http) 203