1# @ohos.net.http (数据请求) 2 3本模块提供HTTP数据请求能力。应用可以通过HTTP发起一个数据请求，支持常见的GET、POST、OPTIONS、HEAD、PUT、DELETE、TRACE、CONNECT方法。 4 5> **说明：** 6> 7>本模块首批接口从API version 6开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 8> 9 10## 导入模块 11 12```js 13import http from '@ohos.net.http'; 14``` 15 16## 完整示例 17 18```js 19// 引入包名 20import http from '@ohos.net.http'; 21 22// 每一个httpRequest对应一个HTTP请求任务，不可复用 23let httpRequest = http.createHttp(); 24// 用于订阅HTTP响应头，此接口会比request请求先返回。可以根据业务需要订阅此消息 25// 从API 8开始，使用on('headersReceive', Callback)替代on('headerReceive', AsyncCallback)。 8+ 26httpRequest.on('headersReceive', (header) => { 27 console.info('header: ' + JSON.stringify(header)); 28}); 29httpRequest.request( 30 // 填写HTTP请求的URL地址，可以带参数也可以不带参数。URL地址需要开发者自定义。请求的参数可以在extraData中指定 31 "EXAMPLE_URL", 32 { 33 method: http.RequestMethod.POST, // 可选，默认为http.RequestMethod.GET 34 // 开发者根据自身业务需要添加header字段 35 header: { 36 'Content-Type': 'application/json' 37 }, 38 // 当使用POST请求时此字段用于传递内容 39 extraData: { 40 "data": "data to send", 41 }, 42 expectDataType: http.HttpDataType.STRING, // 可选，指定返回数据的类型 43 usingCache: true, // 可选，默认为true 44 priority: 1, // 可选，默认为1 45 connectTimeout: 60000, // 可选，默认为60000ms 46 readTimeout: 60000, // 可选，默认为60000ms 47 usingProtocol: http.HttpProtocol.HTTP1_1, // 可选，协议类型默认值由系统自动指定 48 }, (err, data) => { 49 if (!err) { 50 // data.result为HTTP响应内容，可根据业务需要进行解析 51 console.info('Result:' + JSON.stringify(data.result)); 52 console.info('code:' + JSON.stringify(data.responseCode)); 53 // data.header为HTTP响应头，可根据业务需要进行解析 54 console.info('header:' + JSON.stringify(data.header)); 55 console.info('cookies:' + JSON.stringify(data.cookies)); // 8+ 56 // 当该请求使用完毕时，调用destroy方法主动销毁 57 httpRequest.destroy(); 58 } else { 59 console.info('error:' + JSON.stringify(err)); 60 // 取消订阅HTTP响应头事件 61 httpRequest.off('headersReceive'); 62 // 当该请求使用完毕时，调用destroy方法主动销毁。 63 httpRequest.destroy(); 64 } 65 } 66); 67``` 68 69> **说明：** 70> console.info()输出的数据中包含换行符会导致数据出现截断现象。 71 72## http.createHttp 73 74createHttp(): HttpRequest 75 76创建一个HTTP请求，里面包括发起请求、中断请求、订阅/取消订阅HTTP Response Header事件。每一个HttpRequest对象对应一个HTTP请求。如需发起多个HTTP请求，须为每个HTTP请求创建对应HttpRequest对象。 77 78> **说明：** 79> 当该请求使用完毕时，须调用destroy方法主动销毁HttpRequest对象。 80 81**系统能力**：SystemCapability.Communication.NetStack 82 83**返回值：** 84 85| 类型 | 说明 | 86| :---------- | :----------------------------------------------------------- | 87| HttpRequest | 返回一个HttpRequest对象，里面包括request、destroy、on和off方法。 | 88 89**示例：** 90 91```js 92import http from '@ohos.net.http'; 93 94let httpRequest = http.createHttp(); 95``` 96 97## HttpRequest 98 99HTTP请求任务。在调用HttpRequest的方法前，需要先通过[createHttp()](#httpcreatehttp)创建一个任务。 100 101### request 102 103request(url: string, callback: AsyncCallback\<HttpResponse\>):void 104 105根据URL地址，发起HTTP网络请求，使用callback方式作为异步方法。 106 107> **说明：** 108> 此接口仅支持数据大小为5M以内的数据接收。 109 110**需要权限**：ohos.permission.INTERNET 111 112**系统能力**：SystemCapability.Communication.NetStack 113 114**参数：** 115 116| 参数名 | 类型 | 必填 | 说明 | 117| -------- | ---------------------------------------------- | ---- | ----------------------- | 118| url | string | 是 | 发起网络请求的URL地址。 | 119| callback | AsyncCallback\<[HttpResponse](#httpresponse)\> | 是 | 回调函数。 | 120 121**错误码：** 122 123| 错误码ID | 错误信息 | 124|---------|-------------------------------------------------------| 125| 401 | Parameter error. | 126| 201 | Permission denied. | 127| 2300003 | URL using bad/illegal format or missing URL. | 128| 2300007 | Couldn't connect to server. | 129| 2300028 | Timeout was reached. | 130| 2300052 | Server returned nothing (no headers, no data). | 131| 2300999 | Unknown Other Error. | 132 133> **错误码说明：** 134> 以上错误码的详细介绍参见[HTTP错误码](../errorcodes/errorcode-net-http.md)。 135> HTTP 错误码映射关系：2300000 + curl错误码。更多常用错误码，可参考：[curl错误码](https://curl.se/libcurl/c/libcurl-errors.html) 136 137**示例：** 138 139```js 140httpRequest.request("EXAMPLE_URL", (err, data) => { 141 if (!err) { 142 console.info('Result:' + data.result); 143 console.info('code:' + data.responseCode); 144 console.info('header:' + JSON.stringify(data.header)); 145 console.info('cookies:' + data.cookies); // 8+ 146 } else { 147 console.info('error:' + JSON.stringify(err)); 148 } 149}); 150``` 151 152### request 153 154request(url: string, options: HttpRequestOptions, callback: AsyncCallback\<HttpResponse\>):void 155 156根据URL地址和相关配置项，发起HTTP网络请求，使用callback方式作为异步方法。 157 158> **说明：** 159> 此接口仅支持数据大小为5M以内的数据接收。 160 161**需要权限**：ohos.permission.INTERNET 162 163**系统能力**：SystemCapability.Communication.NetStack 164 165**参数：** 166 167| 参数名 | 类型 | 必填 | 说明 | 168| -------- | ---------------------------------------------- | ---- | ----------------------------------------------- | 169| url | string | 是 | 发起网络请求的URL地址。 | 170| options | HttpRequestOptions | 是 | 参考[HttpRequestOptions](#httprequestoptions)。 | 171| callback | AsyncCallback\<[HttpResponse](#httpresponse)\> | 是 | 回调函数。 | 172 173**错误码：** 174 175| 错误码ID | 错误信息 | 176|---------|-------------------------------------------------------| 177| 401 | Parameter error. | 178| 201 | Permission denied. | 179| 2300001 | Unsupported protocol. | 180| 2300003 | URL using bad/illegal format or missing URL. | 181| 2300005 | Couldn't resolve proxy name. | 182| 2300006 | Couldn't resolve host name. | 183| 2300007 | Couldn't connect to server. | 184| 2300008 | Weird server reply. | 185| 2300009 | Access denied to remote resource. | 186| 2300016 | Error in the HTTP2 framing layer. | 187| 2300018 | Transferred a partial file. | 188| 2300023 | Failed writing received data to disk/application. | 189| 2300025 | Upload failed. | 190| 2300026 | Failed to open/read local data from file/application. | 191| 2300027 | Out of memory. | 192| 2300028 | Timeout was reached. | 193| 2300047 | Number of redirects hit maximum amount. | 194| 2300052 | Server returned nothing (no headers, no data). | 195| 2300055 | Failed sending data to the peer. | 196| 2300056 | Failure when receiving data from the peer. | 197| 2300058 | Problem with the local SSL certificate. | 198| 2300059 | Couldn't use specified SSL cipher. | 199| 2300060 | SSL peer certificate or SSH remote key was not OK. | 200| 2300061 | Unrecognized or bad HTTP Content or Transfer-Encoding.| 201| 2300063 | Maximum file size exceeded. | 202| 2300070 | Disk full or allocation exceeded. | 203| 2300073 | Remote file already exists. | 204| 2300077 | Problem with the SSL CA cert (path? access rights?). | 205| 2300078 | Remote file not found. | 206| 2300094 | An authentication function returned an error. | 207| 2300999 | Unknown Other Error. | 208 209> **错误码说明：** 210> 以上错误码的详细介绍参见[HTTP错误码](../errorcodes/errorcode-net-http.md)。 211> HTTP 错误码映射关系：2300000 + curl错误码。更多常用错误码，可参考：[curl错误码](https://curl.se/libcurl/c/libcurl-errors.html) 212 213**示例：** 214 215```js 216httpRequest.request("EXAMPLE_URL", 217 { 218 method: http.RequestMethod.GET, 219 header: { 220 'Content-Type': 'application/json' 221 }, 222 readTimeout: 60000, 223 connectTimeout: 60000 224 }, (err, data) => { 225 if (!err) { 226 console.info('Result:' + data.result); 227 console.info('code:' + data.responseCode); 228 console.info('header:' + JSON.stringify(data.header)); 229 console.info('cookies:' + data.cookies); // 8+ 230 console.info('header.Content-Type:' + data.header['Content-Type']); 231 console.info('header.Status-Line:' + data.header['Status-Line']); 232 } else { 233 console.info('error:' + JSON.stringify(err)); 234 } 235 }); 236``` 237 238### request 239 240request(url: string, options? : HttpRequestOptions): Promise\<HttpResponse\> 241 242根据URL地址，发起HTTP网络请求，使用Promise方式作为异步方法。 243 244> **说明：** 245> 此接口仅支持数据大小为5M以内的数据接收。 246 247**需要权限**：ohos.permission.INTERNET 248 249**系统能力**：SystemCapability.Communication.NetStack 250 251**参数：** 252 253| 参数名 | 类型 | 必填 | 说明 | 254| ------- | ------------------ | ---- | ----------------------------------------------- | 255| url | string | 是 | 发起网络请求的URL地址。 | 256| options | HttpRequestOptions | 否 | 参考[HttpRequestOptions](#httprequestoptions)。 | 257 258**返回值：** 259 260| 类型 | 说明 | 261| :------------------------------------- | :-------------------------------- | 262| Promise<[HttpResponse](#httpresponse)> | 以Promise形式返回发起请求的结果。 | 263 264**错误码：** 265 266| 错误码ID | 错误信息 | 267|---------|-------------------------------------------------------| 268| 401 | Parameter error. | 269| 201 | Permission denied. | 270| 2300001 | Unsupported protocol. | 271| 2300003 | URL using bad/illegal format or missing URL. | 272| 2300005 | Couldn't resolve proxy name. | 273| 2300006 | Couldn't resolve host name. | 274| 2300007 | Couldn't connect to server. | 275| 2300008 | Weird server reply. | 276| 2300009 | Access denied to remote resource. | 277| 2300016 | Error in the HTTP2 framing layer. | 278| 2300018 | Transferred a partial file. | 279| 2300023 | Failed writing received data to disk/application. | 280| 2300025 | Upload failed. | 281| 2300026 | Failed to open/read local data from file/application. | 282| 2300027 | Out of memory. | 283| 2300028 | Timeout was reached. | 284| 2300047 | Number of redirects hit maximum amount. | 285| 2300052 | Server returned nothing (no headers, no data). | 286| 2300055 | Failed sending data to the peer. | 287| 2300056 | Failure when receiving data from the peer. | 288| 2300058 | Problem with the local SSL certificate. | 289| 2300059 | Couldn't use specified SSL cipher. | 290| 2300060 | SSL peer certificate or SSH remote key was not OK. | 291| 2300061 | Unrecognized or bad HTTP Content or Transfer-Encoding.| 292| 2300063 | Maximum file size exceeded. | 293| 2300070 | Disk full or allocation exceeded. | 294| 2300073 | Remote file already exists. | 295| 2300077 | Problem with the SSL CA cert (path? access rights?). | 296| 2300078 | Remote file not found. | 297| 2300094 | An authentication function returned an error. | 298| 2300999 | Unknown Other Error. | 299 300> **错误码说明：** 301> 以上错误码的详细介绍参见[HTTP错误码](../errorcodes/errorcode-net-http.md)。 302> HTTP 错误码映射关系：2300000 + curl错误码。更多常用错误码，可参考：[curl错误码](https://curl.se/libcurl/c/libcurl-errors.html) 303 304**示例：** 305 306```js 307let promise = httpRequest.request("EXAMPLE_URL", { 308 method: http.RequestMethod.GET, 309 connectTimeout: 60000, 310 readTimeout: 60000, 311 header: { 312 'Content-Type': 'application/json' 313 } 314}); 315promise.then((data) => { 316 console.info('Result:' + data.result); 317 console.info('code:' + data.responseCode); 318 console.info('header:' + JSON.stringify(data.header)); 319 console.info('cookies:' + data.cookies); // 8+ 320 console.info('header.Content-Type:' + data.header['Content-Type']); 321 console.info('header.Status-Line:' + data.header['Status-Line']); 322}).catch((err) => { 323 console.info('error:' + JSON.stringify(err)); 324}); 325``` 326 327### destroy 328 329destroy(): void 330 331中断请求任务。 332 333**系统能力**：SystemCapability.Communication.NetStack 334 335**示例：** 336 337```js 338httpRequest.destroy(); 339``` 340 341### on('headerReceive')<sup>(deprecated)</sup> 342 343on(type: 'headerReceive', callback: AsyncCallback\<Object\>): void 344 345订阅HTTP Response Header 事件。 346 347> **说明：** 348> 此接口已废弃，建议使用[on('headersReceive')<sup>8+</sup>](#onheadersreceive8)替代。 349 350**系统能力**：SystemCapability.Communication.NetStack 351 352**参数：** 353 354| 参数名 | 类型 | 必填 | 说明 | 355| -------- | ----------------------- | ---- | --------------------------------- | 356| type | string | 是 | 订阅的事件类型，'headerReceive'。 | 357| callback | AsyncCallback\<Object\> | 是 | 回调函数。 | 358 359**示例：** 360 361```js 362httpRequest.on('headerReceive', (data) => { 363 console.info('error:' + JSON.stringify(data)); 364}); 365``` 366 367### off('headerReceive')<sup>(deprecated)</sup> 368 369off(type: 'headerReceive', callback?: AsyncCallback\<Object\>): void 370 371取消订阅HTTP Response Header 事件。 372 373> **说明：** 374> 375>1. 此接口已废弃，建议使用[off('headersReceive')<sup>8+</sup>](#offheadersreceive8)替代。 376> 377>2. 可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。 378 379**系统能力**：SystemCapability.Communication.NetStack 380 381**参数：** 382 383| 参数名 | 类型 | 必填 | 说明 | 384| -------- | ----------------------- | ---- | ------------------------------------- | 385| type | string | 是 | 取消订阅的事件类型，'headerReceive'。 | 386| callback | AsyncCallback\<Object\> | 否 | 回调函数。 | 387 388**示例：** 389 390```js 391httpRequest.off('headerReceive'); 392``` 393 394### on('headersReceive')<sup>8+</sup> 395 396on(type: 'headersReceive', callback: Callback\<Object\>): void 397 398订阅HTTP Response Header 事件。 399 400**系统能力**：SystemCapability.Communication.NetStack 401 402**参数：** 403 404| 参数名 | 类型 | 必填 | 说明 | 405| -------- | ------------------ | ---- | ---------------------------------- | 406| type | string | 是 | 订阅的事件类型：'headersReceive'。 | 407| callback | Callback\<Object\> | 是 | 回调函数。 | 408 409**示例：** 410 411```js 412httpRequest.on('headersReceive', (header) => { 413 console.info('header: ' + JSON.stringify(header)); 414}); 415``` 416 417### off('headersReceive')<sup>8+</sup> 418 419off(type: 'headersReceive', callback?: Callback\<Object\>): void 420 421取消订阅HTTP Response Header 事件。 422 423> **说明：** 424> 可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。 425 426**系统能力**：SystemCapability.Communication.NetStack 427 428**参数：** 429 430| 参数名 | 类型 | 必填 | 说明 | 431| -------- | ------------------ | ---- | -------------------------------------- | 432| type | string | 是 | 取消订阅的事件类型：'headersReceive'。 | 433| callback | Callback\<Object\> | 否 | 回调函数。 | 434 435**示例：** 436 437```js 438httpRequest.off('headersReceive'); 439``` 440 441### once('headersReceive')<sup>8+</sup> 442 443once(type: 'headersReceive', callback: Callback\<Object\>): void 444 445订阅HTTP Response Header 事件，但是只触发一次。一旦触发之后，订阅器就会被移除。使用callback方式作为异步方法。 446 447**系统能力**：SystemCapability.Communication.NetStack 448 449**参数：** 450 451| 参数名 | 类型 | 必填 | 说明 | 452| -------- | ------------------ | ---- | ---------------------------------- | 453| type | string | 是 | 订阅的事件类型：'headersReceive'。 | 454| callback | Callback\<Object\> | 是 | 回调函数。 | 455 456**示例：** 457 458```js 459httpRequest.once('headersReceive', (header) => { 460 console.info('header: ' + JSON.stringify(header)); 461}); 462``` 463 464## HttpRequestOptions 465 466发起请求可选参数的类型和取值范围。 467 468**系统能力**：SystemCapability.Communication.NetStack 469 470| 名称 | 类型 | 必填 | 说明 | 471| -------------- | --------------------------------------------- | ---- | ------------------------------------------------------------ | 472| method | [RequestMethod](#requestmethod) | 否 | 请求方式，默认为GET。 | 473| extraData | string<sup>6+</sup> \| Object<sup>6+</sup> \| ArrayBuffer<sup>8+</sup> | 否 | 发送请求的额外数据，默认无此字段。<br />- 当HTTP请求为POST、PUT等方法时，此字段为HTTP请求的content，以UTF-8编码形式作为请求体。当'Content-Type'为'application/x-www-form-urlencoded'时，请求提交的信息主体数据应在key和value进行URL转码后按照键值对"key1=value1&key2=value2&key3=value3"的方式进行编码。- 当HTTP请求为GET、OPTIONS、DELETE、TRACE、CONNECT等方法时，此字段为HTTP请求参数的补充。开发者需传入Encode编码后的string类型参数，Object类型的参数无需预编码，参数内容会拼接到URL中进行发送；ArrayBuffer类型的参数不会做拼接处理。| 474| expectDataType<sup>9+</sup> | [HttpDataType](#httpdatatype9) | 否 | 指定返回数据的类型，默认无此字段。如果设置了此参数，系统将优先返回指定的类型。 | 475| usingCache<sup>9+</sup> | boolean | 否 | 是否使用缓存，默认为true。 | 476| priority<sup>9+</sup> | number | 否 | 优先级，范围[1,1000]，默认是1。 | 477| header | Object | 否 | HTTP请求头字段。默认{'Content-Type': 'application/json'}。 | 478| readTimeout | number | 否 | 读取超时时间。单位为毫秒（ms），默认为60000ms。<br />设置为0表示不会出现超时情况。 | 479| connectTimeout | number | 否 | 连接超时时间。单位为毫秒（ms），默认为60000ms。 | 480| usingProtocol<sup>9+</sup> | [HttpProtocol](#httpprotocol9) | 否 | 使用协议。默认值由系统自动指定。 | 481 482## RequestMethod 483 484HTTP 请求方法。 485 486**系统能力**：SystemCapability.Communication.NetStack 487 488| 名称 | 值 | 说明 | 489| :------ | ------- | :------------------ | 490| OPTIONS | "OPTIONS" | HTTP 请求 OPTIONS。 | 491| GET | "GET" | HTTP 请求 GET。 | 492| HEAD | "HEAD" | HTTP 请求 HEAD。 | 493| POST | "POST" | HTTP 请求 POST。 | 494| PUT | "PUT" | HTTP 请求 PUT。 | 495| DELETE | "DELETE" | HTTP 请求 DELETE。 | 496| TRACE | "TRACE" | HTTP 请求 TRACE。 | 497| CONNECT | "CONNECT" | HTTP 请求 CONNECT。 | 498 499## ResponseCode 500 501发起请求返回的响应码。 502 503**系统能力**：SystemCapability.Communication.NetStack 504 505| 名称 | 值 | 说明 | 506| ----------------- | ---- | ------------------------------------------------------------ | 507| OK | 200 | 请求成功。一般用于GET与POST请求。 | 508| CREATED | 201 | 已创建。成功请求并创建了新的资源。 | 509| ACCEPTED | 202 | 已接受。已经接受请求，但未处理完成。 | 510| NOT_AUTHORITATIVE | 203 | 非授权信息。请求成功。 | 511| NO_CONTENT | 204 | 无内容。服务器成功处理，但未返回内容。 | 512| RESET | 205 | 重置内容。 | 513| PARTIAL | 206 | 部分内容。服务器成功处理了部分GET请求。 | 514| MULT_CHOICE | 300 | 多种选择。 | 515| MOVED_PERM | 301 | 永久移动。请求的资源已被永久的移动到新URI，返回信息会包括新的URI，浏览器会自动定向到新URI。 | 516| MOVED_TEMP | 302 | 临时移动。 | 517| SEE_OTHER | 303 | 查看其它地址。 | 518| NOT_MODIFIED | 304 | 未修改。 | 519| USE_PROXY | 305 | 使用代理。 | 520| BAD_REQUEST | 400 | 客户端请求的语法错误，服务器无法理解。 | 521| UNAUTHORIZED | 401 | 请求要求用户的身份认证。 | 522| PAYMENT_REQUIRED | 402 | 保留，将来使用。 | 523| FORBIDDEN | 403 | 服务器理解请求客户端的请求，但是拒绝执行此请求。 | 524| NOT_FOUND | 404 | 服务器无法根据客户端的请求找到资源（网页）。 | 525| BAD_METHOD | 405 | 客户端请求中的方法被禁止。 | 526| NOT_ACCEPTABLE | 406 | 服务器无法根据客户端请求的内容特性完成请求。 | 527| PROXY_AUTH | 407 | 请求要求代理的身份认证。 | 528| CLIENT_TIMEOUT | 408 | 请求时间过长，超时。 | 529| CONFLICT | 409 | 服务器完成客户端的PUT请求是可能返回此代码，服务器处理请求时发生了冲突。 | 530| GONE | 410 | 客户端请求的资源已经不存在。 | 531| LENGTH_REQUIRED | 411 | 服务器无法处理客户端发送的不带Content-Length的请求信息。 | 532| PRECON_FAILED | 412 | 客户端请求信息的先决条件错误。 | 533| ENTITY_TOO_LARGE | 413 | 由于请求的实体过大，服务器无法处理，因此拒绝请求。 | 534| REQ_TOO_LONG | 414 | 请求的URI过长（URI通常为网址），服务器无法处理。 | 535| UNSUPPORTED_TYPE | 415 | 服务器无法处理请求的格式。 | 536| INTERNAL_ERROR | 500 | 服务器内部错误，无法完成请求。 | 537| NOT_IMPLEMENTED | 501 | 服务器不支持请求的功能，无法完成请求。 | 538| BAD_GATEWAY | 502 | 充当网关或代理的服务器，从远端服务器接收到了一个无效的请求。 | 539| UNAVAILABLE | 503 | 由于超载或系统维护，服务器暂时的无法处理客户端的请求。 | 540| GATEWAY_TIMEOUT | 504 | 充当网关或代理的服务器，未及时从远端服务器获取请求。 | 541| VERSION | 505 | 服务器请求的HTTP协议的版本。 | 542 543## HttpResponse 544 545request方法回调函数的返回值类型。 546 547**系统能力**：SystemCapability.Communication.NetStack 548 549| 名称 | 类型 | 必填 | 说明 | 550| -------------------- | -------------------------------------------- | ---- | ------------------------------------------------------------ | 551| result | string<sup>6+</sup> \| Object<sup>deprecated 8+</sup> \| ArrayBuffer<sup>8+</sup> | 是 | HTTP请求根据响应头中Content-type类型返回对应的响应格式内容：<br />- application/json：返回JSON格式的字符串，如需HTTP响应具体内容，需开发者自行解析<br />- application/octet-stream：ArrayBuffer<br />- 其他：string | 552| resultType<sup>9+</sup> | [HttpDataType](#httpdatatype9) | 是 | 返回值类型。 | 553| responseCode | [ResponseCode](#responsecode) \| number | 是 | 回调函数执行成功时，此字段为[ResponseCode](#responsecode)。若执行失败，错误码将会从AsyncCallback中的err字段返回。 | 554| header | Object | 是 | 发起HTTP请求返回来的响应头。当前返回的是JSON格式字符串，如需具体字段内容，需开发者自行解析。常见字段及解析方式如下：<br/>- content-type：header['content-type']；<br />- status-line：header['status-line']；<br />- date：header.date/header['date']；<br />- server：header.server/header['server']； | 555| cookies<sup>8+</sup> | string | 是 | 服务器返回的 cookies。 | 556 557## http.createHttpResponseCache<sup>9+</sup> 558 559createHttpResponseCache(cacheSize?: number): HttpResponseCache 560 561创建一个默认的对象来存储HTTP访问请求的响应。 562 563**系统能力**：SystemCapability.Communication.NetStack 564 565**参数：** 566 567| 参数名 | 类型 | 必填 | 说明 | 568| -------- | --------------------------------------- | ---- | ---------- | 569| cacheSize | number | 否 | 缓存大小最大为10\*1024\*1024（10MB），默认最大。 | 570 571**返回值：** 572 573| 类型 | 说明 | 574| :---------- | :----------------------------------------------------------- | 575| [HttpResponseCache](#httpresponsecache9) | 返回一个存储HTTP访问请求响应的对象。 | 576 577**示例：** 578 579```js 580import http from '@ohos.net.http'; 581 582let httpResponseCache = http.createHttpResponseCache(); 583``` 584 585## HttpResponseCache<sup>9+</sup> 586 587存储HTTP访问请求响应的对象。在调用HttpResponseCache的方法前，需要先通过[createHttpResponseCache()](#httpcreatehttpresponsecache9)创建一个任务。 588 589### flush<sup>9+</sup> 590 591flush(callback: AsyncCallback\<void\>): void 592 593将缓存中的数据写入文件系统，以便在下一个HTTP请求中访问所有缓存数据，使用callback方式作为异步方法。 594 595**系统能力**：SystemCapability.Communication.NetStack 596 597**参数：** 598 599| 参数名 | 类型 | 必填 | 说明 | 600| -------- | --------------------------------------- | ---- | ---------- | 601| callback | AsyncCallback\<void\> | 是 | 回调函数返回写入结果。 | 602 603**示例：** 604 605```js 606httpResponseCache.flush(err => { 607 if (err) { 608 console.info('flush fail'); 609 return; 610 } 611 console.info('flush success'); 612}); 613``` 614 615### flush<sup>9+</sup> 616 617flush(): Promise\<void\> 618 619将缓存中的数据写入文件系统，以便在下一个HTTP请求中访问所有缓存数据，使用Promise方式作为异步方法。 620 621**系统能力**：SystemCapability.Communication.NetStack 622 623**返回值：** 624 625| 类型 | 说明 | 626| --------------------------------- | ------------------------------------- | 627| Promise\<void\> | 以Promise形式返回写入结果。 | 628 629**示例：** 630 631```js 632httpResponseCache.flush().then(() => { 633 console.info('flush success'); 634}).catch(err => { 635 console.info('flush fail'); 636}); 637``` 638 639### delete<sup>9+</sup> 640 641delete(callback: AsyncCallback\<void\>): void 642 643禁用缓存并删除其中的数据，使用callback方式作为异步方法。 644 645**系统能力**：SystemCapability.Communication.NetStack 646 647**参数：** 648 649| 参数名 | 类型 | 必填 | 说明 | 650| -------- | --------------------------------------- | ---- | ---------- | 651| callback | AsyncCallback\<void\> | 是 | 回调函数返回删除结果。| 652 653**示例：** 654 655```js 656httpResponseCache.delete(err => { 657 if (err) { 658 console.info('delete fail'); 659 return; 660 } 661 console.info('delete success'); 662}); 663``` 664 665### delete<sup>9+</sup> 666 667delete(): Promise\<void\> 668 669禁用缓存并删除其中的数据，使用Promise方式作为异步方法。 670 671**系统能力**：SystemCapability.Communication.NetStack 672 673**返回值：** 674 675| 类型 | 说明 | 676| --------------------------------- | ------------------------------------- | 677| Promise\<void\> | 以Promise形式返回删除结果。 | 678 679**示例：** 680 681```js 682httpResponseCache.delete().then(() => { 683 console.info('delete success'); 684}).catch(err => { 685 console.info('delete fail'); 686}); 687``` 688 689## HttpDataType<sup>9+</sup> 690 691http的数据类型。 692 693**系统能力**：SystemCapability.Communication.NetStack 694 695| 名称 | 值 | 说明 | 696| ------------------ | -- | ----------- | 697| STRING | 0 | 字符串类型。 | 698| OBJECT | 1 | 对象类型。 | 699| ARRAY_BUFFER | 2 | 二进制数组类型。| 700 701## HttpProtocol<sup>9+</sup> 702 703http协议版本。 704 705**系统能力**：SystemCapability.Communication.NetStack 706 707| 名称 | 说明 | 708| :-------- | :----------- | 709| HTTP1_1 | 协议http1.1 | 710| HTTP2 | 协议http2 | 711