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