• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# @system.fetch (数据请求)
2
3> **说明:**
4> - 从API Version 6开始,该接口不再维护,推荐使用新接口[`@ohos.net.http`](js-apis-http.md)。
5>
6> - 本模块首批接口从API version 3开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
7
8
9## 导入模块
10
11
12```
13import fetch from '@system.fetch';
14```
15
16
17## fetch.fetch<sup>3+</sup>
18
19fetch(Object): void
20
21通过网络获取数据。
22
23**系统能力:** SystemCapability.Communication.NetStack
24
25**参数:**
26| 参数名 | 类型 | 必填 | 说明 |
27| -------- | -------- | -------- | -------- |
28| url | string | 是 | 资源地址。 |
29| data | string \| Object | 否 | 请求的参数,可选类型是字符串或者json对象。详见表 data与Content-Type关系。 |
30| header | Object | 否 | 设置请求的header。 |
31| method | string | 否 | 请求方法默认为GET,可选值为:OPTIONS、GET、HEAD、POST、PUT、DELETE、TRACE。 |
32| responseType | string | 否 | 默认会根据服务器返回header中的Content-Type确定返回类型,支持文本和json格式。详见success返回值。 |
33| success | Function | 否 | 接口调用成功的回调函数,返回值为[FetchResponse](#fetchresponse) |
34| fail | Function | 否 | 接口调用失败的回调函数。 |
35| complete | Function | 否 | 接口调用结束的回调函数。 |
36
37**表1** data与Content-Type关系
38
39| data | Content-Type | 说明 |
40| -------- | -------- | -------- |
41| string | 不设置 | Content-Type默认为&nbsp;text/plain,data值作为请求的body。 |
42| string | 任意&nbsp;Type | data值作为请求的body。 |
43| Object | 不设置 | Content-Type默认为application/x-www-form-urlencoded,data按照资源地址规则进行encode拼接作为请求的body。 |
44| Object | application/x-www-form-urlencoded | data按照资源地址规则进行encode拼接作为请求的body。 |
45
46## FetchResponse
47
48| 名称 | 类型 | 可读 | 可写 | 说明 |
49| -------- | -------- | -------- | -------- | -------- |
50| code | number | 是 | 否 | 表示服务器的状态code。 |
51| data | string \| Object | 是 | 否 | 返回数据类型由responseType确定,详见表 responseType与success中data关系。 |
52| headers | Object | 是 | 否 | 表示服务器response的所有header。 |
53
54**表2** responseType与success中data关系
55
56| responseType | data | 说明 |
57| -------- | -------- | -------- |
58| 无 | string | 服务器返回的header中的type如果是text/\*或application/jsonapplication/javascriptapplication/xml,值为文本内容。 |
59| text | string | 返回文本内容。 |
60| json | Object | 返回json格式的对象。 |
61
62**示例:**
63
64```
65export default {
66  data: {
67    responseData: 'NA',
68    url: "test_url",
69  },
70  fetch: function () {
71    var that = this;
72    fetch.fetch({
73      url: that.url,
74      success: function(response) {
75        console.info("fetch success");
76        that.responseData = JSON.stringify(response);
77      },
78      fail: function() {
79        console.info("fetch fail");
80      }
81    });
82  }
83}
84```
85
86
87> **说明:**
88>   默认支持https,如果要支持http,需要在config.json里增加network标签,属性标识 "cleartextTraffic":  true。即:
89>
90> ```
91> {
92>   "deviceConfig": {
93>     "default": {
94>       "network": {
95>         "cleartextTraffic": true
96>       }
97>       ...
98>     }
99>   }
100>   ...
101> }
102> ```