未验证 提交 f1bbeba9 编写于 作者: O openharmony_ci 提交者: Gitee

!3380 翻译已完成3290#I531T3

Merge pull request !3380 from shawn_he/b3290
# Data Request # Data Request
>![](public_sys-resources/icon-note.gif) **NOTE:** >![](public_sys-resources/icon-note.gif) **NOTE**
> >
>The initial APIs of this module are supported since API version 6. Newly added APIs will be marked with a superscript to indicate their earliest API version. >The initial APIs of this module are supported since API version 6. Newly added APIs will be marked with a superscript to indicate their earliest API version.
> >
...@@ -11,45 +11,44 @@ ...@@ -11,45 +11,44 @@
import http from '@ohos.net.http'; import http from '@ohos.net.http';
``` ```
## Complete Example ## Example
``` ```
import http from '@ohos.net.http'; import http from '@ohos.net.http';
// Each httpRequest corresponds to an HttpRequestTask object and cannot be reused. // Each HttpRequest corresponds to an HttpRequestTask object and cannot be reused.
let httpRequest = http.createHttp(); let httpRequest = http.createHttp();
// This API is used to subscribe to the HTTP response header, which is returned earlier than httpRequest. It is up to you whether to listen for HTTP Response Header events. // Subscribe to the HTTP response header, which is returned earlier than HttpRequest. You can subscribe to HTTP Response Header events based on service requirements.
// on('headerReceive', AsyncCallback) will be replaced by on('headersReceive', Callback) in API version 8. 8+ // on('headerReceive', AsyncCallback) will be replaced by on('headersReceive', Callback) in API version 8. 8+
httpRequest.on('headersReceive', (data) => { httpRequest.on('headersReceive', (header) => {
console.info('header: ' + data.header); console.info('header: ' + JSON.stringify(header));
}); });
httpRequest.request( httpRequest.request(
// Customize EXAMPLE_URL on your own. It is up to you whether to add parameters to the URL. You can set the parameters of the GET request in extraData. // Set the URL of the HTTP request. You need to define the URL. Set the parameters of the request in extraData.
"EXAMPLE_URL", "EXAMPLE_URL",
{ {
method: 'POST', // Optional. The default value is GET. method: http.RequestMethod.POST, // Optional. The default value is http.RequestMethod.GET.
// Add the header field based on your service requirements. // You can add the header field based on service requirements.
header: { header: {
'Content-Type': 'application/json' 'Content-Type': 'application/json'
}, },
// This field is used to transfer content when the POST request is used. You can set request parameters in extraData as needed. // This field is used to transfer data when the POST request is used.
extraData: { extraData: {
"data": "data to send", "data": "data to send",
}, },
connectTimeout: 60000, // Optional. The default value is 60000, in ms. connectTimeout: 60000, // Optional. The default value is 60000, in ms.
readTimeout: 60000, // Optional. The default value is 60000, in ms. readTimeout: 60000, // Optional. The default value is 60000, in ms.
},(err, data) => { }, (err, data) => {
if (!err) { if (!err) {
// data.result contains the HTTP response. It is up to you whether to parse the content. // data.result contains the HTTP response. Parse the response based on service requirements.
console.info('Result:' + data.result); console.info('Result:' + data.result);
console.info('code:' + data.responseCode); console.info('code:' + data.responseCode);
// data.header contains the HTTP response header. It is up to you whether to parse the content. // data.header contains the HTTP response header. Parse the content based on service requirements.
console.info('header:' + data.header); console.info('header:' + JSON.stringify(data.header));
console.info('cookies:' + data.cookies); // 8+ console.info('cookies:' + data.cookies); // 8+
} else { } else {
console.info('error:' + err); console.info('error:' + JSON.stringify(err));
// Call the destroy function to destroy the request after use. // Call the destroy() method to release resources after the call is complete.
httpRequest.destroy(); httpRequest.destroy();
} }
} }
...@@ -64,7 +63,7 @@ Creates an HTTP request. You can use this API to initiate or destroy an HTTP req ...@@ -64,7 +63,7 @@ Creates an HTTP request. You can use this API to initiate or destroy an HTTP req
**System capability**: SystemCapability.Communication.NetStack **System capability**: SystemCapability.Communication.NetStack
**Return Value** **Return value**
| Type | Description | | Type | Description |
| :---------- | :----------------------------------------------------------- | | :---------- | :----------------------------------------------------------- |
...@@ -103,14 +102,14 @@ Initiates an HTTP request to a given URL. This API uses an asynchronous callback ...@@ -103,14 +102,14 @@ Initiates an HTTP request to a given URL. This API uses an asynchronous callback
``` ```
httpRequest.request("EXAMPLE_URL", (err, data) => { httpRequest.request("EXAMPLE_URL", (err, data) => {
if (!err) { if (!err) {
console.info('Result:' + data.result); console.info('Result:' + data.result);
console.info('code:' + data.responseCode); console.info('code:' + data.responseCode);
console.info('header:' + data.header); console.info('header:' + JSON.stringify(data.header));
console.info('cookies:' + data.cookies); // 8+ console.info('cookies:' + data.cookies); // 8+
} else { } else {
console.info('error:' + err.data); console.info('error:' + JSON.stringify(err));
} }
}); });
``` ```
...@@ -137,7 +136,7 @@ Initiates an HTTP request containing specified options to a given URL. This API ...@@ -137,7 +136,7 @@ Initiates an HTTP request containing specified options to a given URL. This API
``` ```
httpRequest.request("EXAMPLE_URL", httpRequest.request("EXAMPLE_URL",
{ {
method: 'GET', method: http.RequestMethod.GET,
header: { header: {
'Content-Type': 'application/json' 'Content-Type': 'application/json'
}, },
...@@ -147,14 +146,12 @@ httpRequest.request("EXAMPLE_URL", ...@@ -147,14 +146,12 @@ httpRequest.request("EXAMPLE_URL",
if (!err) { if (!err) {
console.info('Result:' + data.result); console.info('Result:' + data.result);
console.info('code:' + data.responseCode); console.info('code:' + data.responseCode);
console.info('header:' + data.header); console.info('header:' + JSON.stringify(data.header));
console.info('cookies:' + data.cookies); // 8+ console.info('cookies:' + data.cookies); // 8+
console.info('header.Content-Type:' + data.header['Content-Type']); console.info('header.Content-Type:' + data.header['Content-Type']);
console.info('header.Status-Line:' + data.header['Status-Line']); console.info('header.Status-Line:' + data.header['Status-Line']);
console.info('header.Date:' + data.header.Date);
console.info('header.Server:' + data.header.Server);
} else { } else {
console.info('error:' + err.data); console.info('error:' + JSON.stringify(err));
} }
}); });
``` ```
...@@ -177,7 +174,7 @@ Initiates an HTTP request to a given URL. This API uses a promise to return the ...@@ -177,7 +174,7 @@ Initiates an HTTP request to a given URL. This API uses a promise to return the
| url | string | Yes | URL for initiating an HTTP request. | | url | string | Yes | URL for initiating an HTTP request. |
| options | HttpRequestOptions | Yes | Request options. For details, see [HttpRequestOptions](#httprequestoptions).| | options | HttpRequestOptions | Yes | Request options. For details, see [HttpRequestOptions](#httprequestoptions).|
**Return Value** **Return value**
| Type | Description | | Type | Description |
| :-------------------- | :-------------------------------- | | :-------------------- | :-------------------------------- |
...@@ -188,24 +185,22 @@ Initiates an HTTP request to a given URL. This API uses a promise to return the ...@@ -188,24 +185,22 @@ Initiates an HTTP request to a given URL. This API uses a promise to return the
``` ```
let promise = httpRequest.request("EXAMPLE_URL", { let promise = httpRequest.request("EXAMPLE_URL", {
method: "GET", method: http.RequestMethod.GET,
connectTimeout: 60000, connectTimeout: 60000,
readTimeout: 60000, readTimeout: 60000,
header: { header: {
'Content-Type': 'application/json' 'Content-Type': 'application/json'
} }
}); });
promise.then((value) => { promise.then((data) => {
console.info('Result:' + value.result); console.info('Result:' + data.result);
console.info('code:' + value.responseCode); console.info('code:' + data.responseCode);
console.info('header:' + value.header); console.info('header:' + JSON.stringify(data.header));
console.info('cookies:' + value.cookies); // 8+ console.info('cookies:' + data.cookies); // 8+
console.info('header.Content-Type:' + value.header['Content-Type']); console.info('header.Content-Type:' + data.header['Content-Type']);
console.info('header.Status-Line:' + value.header['Status-Line']); console.info('header.Status-Line:' + data.header['Status-Line']);
console.info('header.Date:' + value.header.Date);
console.info('header.Server:' + value.header.Server);
}).catch((err) => { }).catch((err) => {
console.error(`errCode:${err.code}, errMessage:${err.data}`); console.info('error:' + JSON.stringify(err));
}); });
``` ```
...@@ -229,7 +224,8 @@ on\(type: 'headerReceive', callback: AsyncCallback<Object\>\): void ...@@ -229,7 +224,8 @@ on\(type: 'headerReceive', callback: AsyncCallback<Object\>\): void
Registers an observer for HTTP Response Header events. Registers an observer for HTTP Response Header events.
>![](public_sys-resources/icon-note.gif) **NOTE:** >![](public_sys-resources/icon-note.gif) **NOTE**
>
> This API has been deprecated. You are advised to use [on\('headersReceive'\)<sup>8+</sup>](#onheadersreceive8) instead. > This API has been deprecated. You are advised to use [on\('headersReceive'\)<sup>8+</sup>](#onheadersreceive8) instead.
**System capability**: SystemCapability.Communication.NetStack **System capability**: SystemCapability.Communication.NetStack
...@@ -245,11 +241,11 @@ Registers an observer for HTTP Response Header events. ...@@ -245,11 +241,11 @@ Registers an observer for HTTP Response Header events.
``` ```
httpRequest.on('headerReceive', (err, data) => { httpRequest.on('headerReceive', (err, data) => {
if (!err) { if (!err) {
console.info('header: ' + data.header); console.info('header: ' + JSON.stringify(data));
} else { } else {
console.info('error:' + err.data); console.info('error:' + JSON.stringify(err));
} }
}); });
``` ```
...@@ -260,7 +256,7 @@ off\(type: 'headerReceive', callback?: AsyncCallback<Object\>\): void ...@@ -260,7 +256,7 @@ off\(type: 'headerReceive', callback?: AsyncCallback<Object\>\): void
Unregisters the observer for HTTP Response Header events. Unregisters the observer for HTTP Response Header events.
>![](public_sys-resources/icon-note.gif) **NOTE:** >![](public_sys-resources/icon-note.gif) **NOTE**
> >
>1. This API has been deprecated. You are advised to use [off\('headersReceive'\)<sup>8+</sup>](#offheadersreceive8) instead. >1. This API has been deprecated. You are advised to use [off\('headersReceive'\)<sup>8+</sup>](#offheadersreceive8) instead.
> >
...@@ -278,13 +274,6 @@ Unregisters the observer for HTTP Response Header events. ...@@ -278,13 +274,6 @@ Unregisters the observer for HTTP Response Header events.
**Example** **Example**
``` ```
httpRequest.on('headerReceive', (err, data) => {
if (!err) {
console.info('header: ' + data.header);
} else {
console.info('error:' + err.data);
}
});
httpRequest.off('headerReceive'); httpRequest.off('headerReceive');
``` ```
...@@ -306,8 +295,8 @@ Registers an observer for HTTP Response Header events. ...@@ -306,8 +295,8 @@ Registers an observer for HTTP Response Header events.
**Example** **Example**
``` ```
httpRequest.on('headersReceive', (data) => { httpRequest.on('headersReceive', (header) => {
console.info('header: ' + data.header); console.info('header: ' + JSON.stringify(header));
}); });
``` ```
...@@ -318,7 +307,8 @@ off\(type: 'headersReceive', callback?: Callback<Object\>\): void ...@@ -318,7 +307,8 @@ off\(type: 'headersReceive', callback?: Callback<Object\>\): void
Unregisters the observer for HTTP Response Header events. Unregisters the observer for HTTP Response Header events.
>![](public_sys-resources/icon-note.gif) **NOTE:** >![](public_sys-resources/icon-note.gif) **NOTE**
>
>You can pass the callback of the **on** function if you want to cancel listening for a certain type of event. If you do not pass the callback, you will cancel listening for all events. >You can pass the callback of the **on** function if you want to cancel listening for a certain type of event. If you do not pass the callback, you will cancel listening for all events.
**System capability**: SystemCapability.Communication.NetStack **System capability**: SystemCapability.Communication.NetStack
...@@ -354,8 +344,8 @@ Registers a one-time observer for HTTP Response Header events. Once triggered, t ...@@ -354,8 +344,8 @@ Registers a one-time observer for HTTP Response Header events. Once triggered, t
**Example** **Example**
``` ```
httpRequest.once('headersReceive', (data) => { httpRequest.once('headersReceive', (header) => {
console.info('header: ' + data.header); console.info('header: ' + JSON.stringify(header));
}); });
``` ```
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册