• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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-guidelines.md)。
14
15涉及的接口如下表,具体的接口说明请参考[API文档](../reference/apis/js-apis-http.md)。
16
17| 接口名                                    | 功能描述                            |
18| ----------------------------------------- | ----------------------------------- |
19| createHttp()                              | 创建一个http请求。                  |
20| request()                                 | 根据URL地址,发起HTTP网络请求。     |
21| destroy()                                 | 中断请求任务。                      |
22| on(type: 'headersReceive')                | 订阅HTTP Response Header 事件。     |
23| off(type: 'headersReceive')               | 取消订阅HTTP Response Header 事件。 |
24| once\('headersReceive'\)<sup>8+</sup>     | 订阅HTTP Response Header 事件,但是只触发一次。|
25
26## request接口开发步骤
27
281. 从@ohos.net.http.d.ts中导入http命名空间。
292. 调用createHttp()方法,创建一个HttpRequest对象。
303. 调用该对象的on()方法,订阅http响应头事件,此接口会比request请求先返回。可以根据业务需要订阅此消息。
314. 调用该对象的request()方法,传入http请求的url地址和可选参数,发起网络请求。
325. 按照实际业务需要,解析返回结果。
336. 调用该对象的off()方法,取消订阅http响应头事件。
347. 当该请求使用完毕时,调用destroy()方法主动销毁。
35
36```js
37// 引入包名
38import http from '@ohos.net.http';
39
40// 每一个httpRequest对应一个HTTP请求任务,不可复用
41let httpRequest = http.createHttp();
42// 用于订阅HTTP响应头,此接口会比request请求先返回。可以根据业务需要订阅此消息
43// 从API 8开始,使用on('headersReceive', Callback)替代on('headerReceive', AsyncCallback)。 8+
44httpRequest.on('headersReceive', (header) => {
45  console.info('header: ' + JSON.stringify(header));
46});
47httpRequest.request(
48  // 填写HTTP请求的URL地址,可以带参数也可以不带参数。URL地址需要开发者自定义。请求的参数可以在extraData中指定"EXAMPLE_URL",
49  {
50    method: http.RequestMethod.POST, // 可选,默认为http.RequestMethod.GET
51    // 开发者根据自身业务需要添加header字段
52    header: {
53      'Content-Type': 'application/json'
54    },
55    // 当使用POST请求时此字段用于传递内容
56    extraData: {
57      "data": "data to send",
58    },
59    expectDataType: http.HttpDataType.STRING, // 可选,指定返回数据的类型
60    usingCache: true, // 可选,默认为true
61    priority: 1, // 可选,默认为1
62    connectTimeout: 60000, // 可选,默认为60000ms
63    readTimeout: 60000, // 可选,默认为60000ms
64    usingProtocol: http.HttpProtocol.HTTP1_1, // 可选,协议类型默认值由系统自动指定
65  }, (err, data) => {
66    if (!err) {
67      // data.result为HTTP响应内容,可根据业务需要进行解析
68      console.info('Result:' + JSON.stringify(data.result));
69      console.info('code:' + JSON.stringify(data.responseCode));
70      // data.header为HTTP响应头,可根据业务需要进行解析
71      console.info('header:' + JSON.stringify(data.header));
72      console.info('cookies:' + JSON.stringify(data.cookies)); // 8+
73    } else {
74      console.info('error:' + JSON.stringify(err));
75      // 取消订阅HTTP响应头事件
76      httpRequest.off('headersReceive');
77      // 当该请求使用完毕时,调用destroy方法主动销毁
78      httpRequest.destroy();
79    }
80  }
81);
82```
83
84## 相关实例
85
86针对HTTP数据请求,有以下相关实例可供参考:
87
88- [使用HTTP实现与服务端通信(ArkTS)(API9)](https://gitee.com/openharmony/codelabs/tree/master/NetworkManagement/SmartChatEtsOH)