• 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(options:{ <br>
20&nbsp;&nbsp;url: string;<br>
21&nbsp;&nbsp;data?: string | object;<br>
22&nbsp;&nbsp;header?: Object;<br>
23&nbsp;&nbsp;method?: string;<br>
24&nbsp;&nbsp;responseType?: string;<br>
25&nbsp;&nbsp;success?: (data: FetchResponse) => void;<br>
26&nbsp;&nbsp;fail?: (data: any, code: number) => void;<br>
27&nbsp;&nbsp;complete?: () => void;<br>
28  } ): void
29
30通过网络获取数据。
31
32**系统能力:** SystemCapability.Communication.NetStack
33
34**参数:**
35| 参数名 | 类型 | 必填 | 说明 |
36| -------- | -------- | -------- | -------- |
37| url | string | 是 | 资源地址。 |
38| data | string \| Object | 否 | 请求的参数,可选类型是字符串或者json对象。详见表 data与Content-Type关系。 |
39| header | Object | 否 | 设置请求的header。 |
40| method | string | 否 | 请求方法默认为GET,可选值为:OPTIONS、GET、HEAD、POST、PUT、DELETE、TRACE。 |
41| responseType | string | 否 | 默认会根据服务器返回header中的Content-Type确定返回类型,支持文本和json格式。详见success返回值。 |
42| success | Function | 否 | 接口调用成功的回调函数,返回值为[FetchResponse](#fetchresponse) |
43| fail | Function | 否 | 接口调用失败的回调函数。 |
44| complete | Function | 否 | 接口调用结束的回调函数。 |
45
46**表1** data与Content-Type关系
47
48| data | Content-Type | 说明 |
49| -------- | -------- | -------- |
50| string | 不设置 | Content-Type默认为&nbsp;text/plain,data值作为请求的body。 |
51| string | 任意&nbsp;Type | data值作为请求的body。 |
52| Object | 不设置 | Content-Type默认为application/x-www-form-urlencoded,data按照资源地址规则进行encode拼接作为请求的body。 |
53| Object | application/x-www-form-urlencoded | data按照资源地址规则进行encode拼接作为请求的body。 |
54
55## FetchResponse<sup>3+</sup>
56
57**系统能力:** SystemCapability.Communication.NetStack
58
59| 名称 | 类型 | 可读 | 可写 | 说明 |
60| -------- | -------- | -------- | -------- | -------- |
61| code | number | 是 | 否 | 表示服务器的状态code。 |
62| data | string \| Object | 是 | 否 | 返回数据类型由responseType确定,详见表 responseType与success中data关系。 |
63| headers | Object | 是 | 否 | 表示服务器response的所有header。 |
64
65**表2** responseType与success中data关系
66
67| responseType | data | 说明 |
68| -------- | -------- | -------- |
69| 无 | string | 服务器返回的header中的type如果是text/\*或application/jsonapplication/javascriptapplication/xml,值为文本内容。 |
70| text | string | 返回文本内容。 |
71| json | Object | 返回json格式的对象。 |
72
73**示例:**
74
75```
76export default {
77  data: {
78    responseData: 'NA',
79    url: "test_url",
80  },
81  fetch: function () {
82    var that = this;
83    fetch.fetch({
84      url: that.url,
85      success: function(response) {
86        console.info("fetch success");
87        that.responseData = JSON.stringify(response);
88      },
89      fail: function() {
90        console.info("fetch fail");
91      }
92    });
93  }
94}
95```
96
97
98> **说明:**
99>   默认支持https,如果要支持http,需要在config.json里增加network标签,属性标识 "cleartextTraffic":  true。即:
100>
101> ```
102> {
103>   "deviceConfig": {
104>     "default": {
105>       "network": {
106>         "cleartextTraffic": true
107>       }
108>       ...
109>     }
110>   }
111>   ...
112> }
113> ```