Skip to content

D
Docs

OpenHarmony / Docs
1 年多 前同步成功

通知 159
Star 292
Fork 28
D
Docs
未验证 提交 6de12f28 编写于 作者: O openharmony_ci 提交者： Gitee
浏览文件
操作

!22089 request2和dataProgress接口名称变更 

Merge pull request !22089 from Yangys/master
上级 e3a52a91 ca95424e
隐藏空白更改
内联 并排
Showing with 77 addition and 34 deletion
zh-cn/application-dev/connectivity/http-request.md
浏览文件 @ 6de12f28
......@@ -18,7 +18,7 @@ HTTP数据请求功能主要由http模块提供。
| ----------------------------------------- | ----------------------------------- |
| createHttp() | 创建一个http请求。 |
| request() | 根据URL地址，发起HTTP网络请求。 |
| request2()<sup>10+</sup> | 根据URL地址，发起HTTP网络请求并返回流式响应|
| requestInStream()<sup>10+</sup> | 根据URL地址，发起HTTP网络请求并返回流式响应|
| destroy() | 中断请求任务。 |
| on(type: 'headersReceive') | 订阅HTTP Response Header 事件。 |
| off(type: 'headersReceive') | 取消订阅HTTP Response Header 事件。 |
......@@ -27,8 +27,8 @@ HTTP数据请求功能主要由http模块提供。
| off\('dataReceive'\)<sup>10+</sup> | 取消订阅HTTP流式响应数据接收事件。 |
| on\('dataEnd'\)<sup>10+</sup> | 订阅HTTP流式响应数据接收完毕事件。 |
| off\('dataEnd'\)<sup>10+</sup> | 取消订阅HTTP流式响应数据接收完毕事件。 |
| on\('dataProgress'\)<sup>10+</sup> | 订阅HTTP流式响应数据接收进度事件。 |
| off\('dataProgress'\)<sup>10+</sup> | 取消订阅HTTP流式响应数据接收进度事件。 |
| on\('dataReceiveProgress'\)<sup>10+</sup> | 订阅HTTP流式响应数据接收进度事件。 |
| off\('dataReceiveProgress'\)<sup>10+</sup> | 取消订阅HTTP流式响应数据接收进度事件。 |
## request接口开发步骤
......@@ -91,12 +91,12 @@ httpRequest.request(
);
```
## request2接口开发步骤
## requestInStream接口开发步骤
1. 从@ohos.net.http.d.ts中导入http命名空间。
2. 调用createHttp()方法，创建一个HttpRequest对象。
3. 调用该对象的on()方法，可以根据业务需要订阅HTTP响应头事件、HTTP流式响应数据接收事件、HTTP流式响应数据接收进度事件和HTTP流式响应数据接收完毕事件。
4. 调用该对象的request2()方法，传入http请求的url地址和可选参数，发起网络请求。
4. 调用该对象的requestInStream()方法，传入http请求的url地址和可选参数，发起网络请求。
5. 按照实际业务需要，可以解析返回的响应码。
6. 调用该对象的off()方法，取消订阅相应事件。
7. 当该请求使用完毕时，调用destroy()方法主动销毁。
......@@ -122,11 +122,11 @@ httpRequest.on('dataEnd', () => {
console.info('No more data in response, data receive end');
});
// 用于订阅HTTP流式响应数据接收进度事件
httpRequest.on('dataProgress', (data) => {
console.log("dataProgress receiveSize:" + data.receiveSize + ", totalSize:" + data.totalSize);
httpRequest.on('dataReceiveProgress', (data) => {
console.log("dataReceiveProgress receiveSize:" + data.receiveSize + ", totalSize:" + data.totalSize);
});
httpRequest.request2(
httpRequest.requestInStream(
// 填写HTTP请求的URL地址，可以带参数也可以不带参数。URL地址需要开发者自定义。请求的参数可以在extraData中指定
"EXAMPLE_URL",
{
......@@ -153,7 +153,7 @@ httpRequest.request2(
// 取消订阅HTTP流式响应数据接收事件
httpRequest.off('dataReceive');
// 取消订阅HTTP流式响应数据接收进度事件
httpRequest.off('dataProgress');
httpRequest.off('dataReceiveProgress');
// 取消订阅HTTP流式响应数据接收完毕事件
httpRequest.off('dataEnd');
// 当该请求使用完毕时，调用destroy方法主动销毁
......
zh-cn/application-dev/reference/apis/js-apis-http.md
浏览文件 @ 6de12f28
......@@ -86,7 +86,7 @@ createHttp(): HttpRequest
| 类型 | 说明 |
| :---------- | :----------------------------------------------------------- |
| HttpRequest | 返回一个HttpRequest对象，里面包括request、request2、destroy、on和off方法。 |
| HttpRequest | 返回一个HttpRequest对象，里面包括request、requestInStream、destroy、on和off方法。 |
**示例：**
......@@ -364,9 +364,9 @@ destroy(): void
httpRequest.destroy();
```
### request2<sup>10+</sup>
### requestInStream<sup>10+</sup>
request2(url: string, callback: AsyncCallback\<number\>): void
requestInStream(url: string, callback: AsyncCallback\<number\>): void
根据URL地址，发起HTTP网络请求并返回流式响应，使用callback方式作为异步方法。
......@@ -424,18 +424,18 @@ request2(url: string, callback: AsyncCallback\<number\>): void
**示例：**
```js
httpRequest.request2("EXAMPLE_URL", (err, data) => {
httpRequest.requestInStream("EXAMPLE_URL", (err, data) => {
if (!err) {
console.info("request2 OK! ResponseCode is " + JSON.stringify(data));
console.info("requestInStream OK! ResponseCode is " + JSON.stringify(data));
} else {
console.info("request2 ERROR : err = " + JSON.stringify(err));
console.info("requestInStream ERROR : err = " + JSON.stringify(err));
}
})
```
### request2<sup>10+</sup>
### requestInStream<sup>10+</sup>
request2(url: string, options: HttpRequestOptions, callback: AsyncCallback\<number\>): void
requestInStream(url: string, options: HttpRequestOptions, callback: AsyncCallback\<number\>): void
根据URL地址和相关配置项，发起HTTP网络请求并返回流式响应，使用callback方式作为异步方法。
......@@ -494,7 +494,7 @@ request2(url: string, options: HttpRequestOptions, callback: AsyncCallback\<numb
**示例：**
```js
httpRequest.request2("EXAMPLE_URL",
httpRequest.requestInStream("EXAMPLE_URL",
{
method: http.RequestMethod.GET,
header: {
......@@ -504,16 +504,16 @@ httpRequest.request2("EXAMPLE_URL",
connectTimeout: 60000
}, (err, data) => {
if (!err) {
console.info("request2 OK! ResponseCode is " + JSON.stringify(data));
console.info("requestInStream OK! ResponseCode is " + JSON.stringify(data));
} else {
console.info("request2 ERROR : err = " + JSON.stringify(err));
console.info("requestInStream ERROR : err = " + JSON.stringify(err));
}
})
```
### request2<sup>10+</sup>
### requestInStream<sup>10+</sup>
request2(url: string, options? : HttpRequestOptions): Promise\<number\>
requestInStream(url: string, options? : HttpRequestOptions): Promise\<number\>
根据URL地址，发起HTTP网络请求并返回流式响应，使用Promise方式作为异步方法。
......@@ -577,7 +577,7 @@ request2(url: string, options? : HttpRequestOptions): Promise\<number\>
**示例：**
```js
let promise = httpRequest.request2("EXAMPLE_URL", {
let promise = httpRequest.requestInStream("EXAMPLE_URL", {
method: http.RequestMethod.GET,
connectTimeout: 60000,
readTimeout: 60000,
......@@ -586,9 +586,9 @@ let promise = httpRequest.request2("EXAMPLE_URL", {
}
});
promise.then((data) => {
console.info("request2 OK!" + JSON.stringify(data));
console.info("requestInStream OK!" + JSON.stringify(data));
}).catch((err) => {
console.info("request2 ERROR : err = " + JSON.stringify(err));
console.info("requestInStream ERROR : err = " + JSON.stringify(err));
});
```
......@@ -815,9 +815,9 @@ off(type: 'dataEnd', callback?: Callback\<void\>): void
httpRequest.off('dataEnd');
```
### on('dataProgress')<sup>10+</sup>
### on('dataReceiveProgress')<sup>10+</sup>
on(type: 'dataProgress', callback: Callback\<{ receiveSize: number, totalSize: number }\>): void
on(type: 'dataReceiveProgress', callback: Callback\<{ receiveSize: number, totalSize: number }\>): void
订阅HTTP流式响应数据接收进度事件。
......@@ -830,20 +830,20 @@ on(type: 'dataProgress', callback: Callback\<{ receiveSize: number, totalSize: n
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------- | ---- | --------------------------------- |
| type | string | 是 | 订阅的事件类型，'dataProgress'。 |
| type | string | 是 | 订阅的事件类型，'dataReceiveProgress'。 |
| callback | AsyncCallback\<{ receiveSize: number, totalSize: number }\> | 是 | 回调函数。<br>receiveSize：已接收的数据字节数，totalSize待接收的字节总数 |
**示例：**
```js
httpRequest.on('dataProgress', (data) => {
console.info('dataProgress:' + JSON.stringify(data));
httpRequest.on('dataReceiveProgress', (data) => {
console.info('dataReceiveProgress:' + JSON.stringify(data));
});
```
### off('dataProgress')<sup>10+</sup>
### off('dataReceiveProgress')<sup>10+</sup>
off(type: 'dataProgress', callback?: Callback\<{ receiveSize: number, totalSize: number }\>): void
off(type: 'dataReceiveProgress', callback?: Callback\<{ receiveSize: number, totalSize: number }\>): void
取消订阅HTTP流式响应数据接收进度事件。
......@@ -856,13 +856,13 @@ off(type: 'dataProgress', callback?: Callback\<{ receiveSize: number, totalSize:
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------ | ---- | -------------------------------------- |
| type | string | 是 | 取消订阅的事件类型：'dataProgress'。 |
| type | string | 是 | 取消订阅的事件类型：'dataReceiveProgress'。 |
| callback | Callback\<{ receiveSize: number, totalSize: number }\> | 否 | 回调函数。 |
**示例：**
```js
httpRequest.off('dataProgress');
httpRequest.off('dataReceiveProgress');
```
## HttpRequestOptions<sup>6+</sup>
......
zh-cn/release-notes/changelogs/OpenHarmony_4.0.10.2/changelogs-netstack.md 0 → 100644
浏览文件 @ 6de12f28
# 网络管理子系统ChangeLog
## request2 接口名称变更
此前版本http流式请求的名称为request2，无法清楚的表达该接口的意图，且容易产生歧义，不符合OpenHarmony的API接口规范。
现做出如下变更：
- request2接口名称更换为requestInStream。
## dataProgress 流式数据接收进度事件名称变更
此前版本http流式数据接收进度事件名称为dataProgress，无法清楚的表达该事件为数据接收事件，不符合OpenHarmony的API接口规范。
现做出如下变更：
- dataProgress事件名称更换为dataReceiveProgress。
**变更影响**
基于此前版本开发的应用，需更改对应接口和监听事件名称，否则无法正常调用接口，影响原有业务逻辑。
**关键的接口/组件变更**
涉及接口
- request2;
- on(type: "dataProgress", callback: Callback<{ receiveSize: number, totalSize: number }>): void;
- off(type: "dataProgress", callback: Callback<{ receiveSize: number, totalSize: number }>): void;
变更前：
- request2(url: string, callback: AsyncCallback<number>): void;
- request2(url: string, options: HttpRequestOptions, callback: AsyncCallback<number>): void;
- request2(url: string, options?: HttpRequestOptions): Promise<number>;
- on(type: "dataProgress", callback: Callback<{ receiveSize: number, totalSize: number }>): void;
- off(type: 'dataProgress', callback?: Callback<{ receiveSize: number, totalSize: number }>): void;
变更后：
- requestInStream(url: string, callback: AsyncCallback<number>): void;
- requestInStream(url: string, options: HttpRequestOptions, callback: AsyncCallback<number>): void;
- requestInStream(url: string, options?: HttpRequestOptions): Promise<number>;
- on(type: "dataReceiveProgress", callback: Callback<{ receiveSize: number, totalSize: number }>): void;
- off(type: 'dataReceiveProgress', callback?: Callback<{ receiveSize: number, totalSize: number }>): void;
**适配指导**
将原有业务代码中request2接口名称和dataProgress事件名称分别替换为requestInStream和dataReceiveProgress即可正常使用。
\ No newline at end of file
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或