@ohos.net.http (Data Request)

The http module provides the HTTP data request capability. An application can initiate a data request over HTTP. Common HTTP methods include GET, POST, OPTIONS, HEAD, PUT, DELETE, TRACE, and CONNECT.

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.

Modules to Import

import http from '@ohos.net.http';

Examples

// Import the http namespace.
import http from '@ohos.net.http';
import { BusinessError } from '@ohos.base';

// Each httpRequest corresponds to an HTTP request task and cannot be reused.
let httpRequest = http.createHttp();
// This API is used to listen for the HTTP Response Header event, which is returned earlier than the result of the HTTP request. It is up to you whether to listen for HTTP Response Header events.
// on('headerReceive', AsyncCallback) is replaced by on('headersReceive', Callback) since API version 8.
httpRequest.on('headersReceive', (header:Object) => {
  console.info('header: ' + JSON.stringify(header));
});
class ExtraData {
  public data: string;

  constructor(data: string) {
    this.data = data;
  }
}
class Header {
  public contentType: string;

  constructor(contentType: string) {
    this.contentType = contentType;
  }
}
httpRequest.request(
  // Customize EXAMPLE_URL in extraData on your own. It is up to you whether to add parameters to the URL.
  "EXAMPLE_URL",
  {
    method: http.RequestMethod.POST, // Optional. The default value is http.RequestMethod.GET.
    // You can add header fields based on service requirements.
    header: new Header('application/json'),
    // This parameter is used to transfer data when the POST request is used.
    extraData: new ExtraData('data to send'),
    expectDataType: http.HttpDataType.STRING, // Optional. This parameter specifies the type of the return data.
    usingCache: true, // Optional. The default value is true.
    priority: 1, // Optional. The default value is 1.
    connectTimeout: 60000 // Optional. The default value is 60000, in ms.
    readTimeout: 60000, // Optional. The default value is 60000, in ms.
    usingProtocol: http.HttpProtocol.HTTP1_1, // Optional. The default protocol type is automatically specified by the system.
    usingProxy: false, // Optional. By default, network proxy is not used. This field is supported since API version 10.
    caPath: "", // Optional. The preset CA certificate is used by default. This field is supported since API version 10.
  },
  (err: BusinessError, data: http.HttpResponse ) => {
  if (!err) {
    // data.result carries the HTTP response. Parse the response based on service requirements.
    console.info('Result:' + JSON.stringify(data.result));
    console.info('code:' + JSON.stringify(data.responseCode));
    // data.header carries the HTTP response header. Parse the content based on service requirements.
    console.info('header:' + JSON.stringify(data.header));
    console.info('cookies:' + JSON.stringify(data.cookies)); // 8+
    // Unsubscribe from HTTP Response Header events.
    httpRequest.off('headersReceive');
    // Call destroy() to destroy the JavaScript object after the HTTP request is complete.
    httpRequest.destroy();
  } else {
    console.info('error:' + JSON.stringify(err));
    // Unsubscribe from HTTP Response Header events.
    httpRequest.off('headersReceive');
    // Call destroy() to destroy the JavaScript object after the HTTP request is complete.
    httpRequest.destroy();
  }
);

NOTE If the data in console.info() contains a newline character, the data will be truncated.

http.createHttp⁶⁺

createHttp(): HttpRequest

Creates an HTTP request. You can use this API to initiate or destroy an HTTP request, or enable or disable listening for HTTP Response Header events. An HttpRequest object corresponds to an HTTP request. To initiate multiple HTTP requests, you must create an HttpRequest object for each HTTP request.

NOTE Call the destroy() method to release resources after the HttpRequest is complete.

System capability: SystemCapability.Communication.NetStack

Return value

Example

import http from '@ohos.net.http';

let httpRequest = http.createHttp();

HttpRequest

Defines an HTTP request task. Before invoking APIs provided by HttpRequest, you must call createHttp() to create an HttpRequestTask object.

request⁶⁺

request(url: string, callback: AsyncCallback<HttpResponse>):void

Initiates an HTTP request to a given URL. This API uses an asynchronous callback to return the result.

NOTE This API supports only receiving of data not greater than 5 MB.

Required permissions: ohos.permission.INTERNET

System capability: SystemCapability.Communication.NetStack

Parameters

Error codes

NOTE For details about the error codes, see HTTP Error Codes. The HTTP error code mapping is in the format of 2300000 + Curl error code. For more common error codes, see Curl Error Codes.

Example

import http from '@ohos.net.http';

let httpRequest = http.createHttp();
httpRequest.request("EXAMPLE_URL", (err: Error, data: http.HttpResponse) => {
  if (!err) {
    console.info('Result:' + data.result);
    console.info('code:' + data.responseCode);
    console.info('header:' + JSON.stringify(data.header));
    console.info('cookies:' + data.cookies); // 8+
  } else {
    console.info('error:' + JSON.stringify(err));
  }
});

request⁶⁺

request(url: string, options: HttpRequestOptions, callback: AsyncCallback<HttpResponse>):void

Initiates an HTTP request containing specified options to a given URL. This API uses an asynchronous callback to return the result.

NOTE This API supports only receiving of data not greater than 5 MB.

Required permissions: ohos.permission.INTERNET

System capability: SystemCapability.Communication.NetStack

Parameters

Error codes

NOTE For details about the error codes, see HTTP Error Codes. The HTTP error code mapping is in the format of 2300000 + Curl error code. For more common error codes, see Curl Error Codes.

Example

import http from '@ohos.net.http';

class Header {
  public contentType: string;

  constructor(contentType: string) {
    this.contentType = contentType;
  }
}

let httpRequest = http.createHttp();
let promise = httpRequest.request("EXAMPLE_URL", {
  method: http.RequestMethod.GET,
  connectTimeout: 60000,
  readTimeout: 60000,
  header: new Header('application/json')
});

promise.then((data:http.HttpResponse) => {
  console.info('Result:' + data.result);
  console.info('code:' + data.responseCode);
  console.info('header:' + JSON.stringify(data.header));
  console.info('cookies:' + data.cookies); // 8+
  console.info('header.Content-Type:' + data.header);
  console.info('header.Status-Line:' + data.header);

}).catch((err:Error) => {
  console.info('error:' + JSON.stringify(err));
});

request⁶⁺

request(url: string, options? : HttpRequestOptions): Promise<HttpResponse>

Initiates an HTTP request containing specified options to a given URL. This API uses a promise to return the result.

NOTE This API supports only receiving of data not greater than 5 MB.

Required permissions: ohos.permission.INTERNET

System capability: SystemCapability.Communication.NetStack

Parameters

Return value

Error codes

NOTE For details about the error codes, see HTTP Error Codes. The HTTP error code mapping is in the format of 2300000 + Curl error code. For more common error codes, see Curl Error Codes.

Example

import http from '@ohos.net.http';

class Header {
  public contentType: string;

  constructor(contentType: string) {
    this.contentType = contentType;
  }
}

let httpRequest = http.createHttp();
let promise = httpRequest.request("EXAMPLE_URL", {
  method: http.RequestMethod.GET,
  connectTimeout: 60000,
  readTimeout: 60000,
  header: new Header('application/json')
});
promise.then((data:http.HttpResponse) => {
  console.info('Result:' + data.result);
  console.info('code:' + data.responseCode);
  console.info('header:' + JSON.stringify(data.header));
  console.info('cookies:' + data.cookies); // 8+
  console.info('header.Content-Type:' + data.header);
  console.info('header.Status-Line:' + data.header);
}).catch((err:Error) => {
  console.info('error:' + JSON.stringify(err));
});

destroy

destroy(): void

Destroys an HTTP request.

System capability: SystemCapability.Communication.NetStack

Example

import http from '@ohos.net.http';
let httpRequest = http.createHttp();

httpRequest.destroy();

requestInStream¹⁰⁺

requestInStream(url: string, callback: AsyncCallback<number>): void

Initiates an HTTP request containing specified options to a given URL. This API uses an asynchronous callback to return the result, which is a streaming response.

Required permissions: ohos.permission.INTERNET

System capability: SystemCapability.Communication.NetStack

Parameters

Error codes

NOTE For details about the error codes, see HTTP Error Codes. The HTTP error code mapping is in the format of 2300000 + Curl error code. For more common error codes, see Curl Error Codes.

Example

import http from '@ohos.net.http';
import { BusinessError } from '@ohos.base';

let httpRequest = http.createHttp();
httpRequest.requestInStream("EXAMPLE_URL", (err: BusinessError, data: number) => {
  if (!err) {
    console.info("requestInStream OK! ResponseCode is " + JSON.stringify(data));
  } else {
    console.info("requestInStream ERROR : err = " + JSON.stringify(err));
  }
})

requestInStream¹⁰⁺

requestInStream(url: string, options: HttpRequestOptions, callback: AsyncCallback<number>): void

Initiates an HTTP request containing specified options to a given URL. This API uses an asynchronous callback to return the result, which is a streaming response.

Required permissions: ohos.permission.INTERNET

System capability: SystemCapability.Communication.NetStack

Parameters

Error codes

NOTE For details about the error codes, see HTTP Error Codes. The HTTP error code mapping is in the format of 2300000 + Curl error code. For more common error codes, see Curl Error Codes.

Example

import http from '@ohos.net.http';
import { BusinessError } from '@ohos.base';

class Header {
  public contentType: string;

  constructor(contentType: string) {
    this.contentType = contentType;
  }
}

let httpRequest = http.createHttp();
httpRequest.requestInStream("EXAMPLE_URL", (err: BusinessError<void> , data: number) => {
  if (!err) {
    console.info("requestInStream OK! ResponseCode is " + JSON.stringify(data));
  } else {
    console.info("requestInStream ERROR : err = " + JSON.stringify(err));
  }
})

requestInStream¹⁰⁺

requestInStream(url: string, options? : HttpRequestOptions): Promise<number>

Initiates an HTTP request containing specified options to a given URL. This API uses a promise to return the result, which is a streaming response.

Required permissions: ohos.permission.INTERNET

System capability: SystemCapability.Communication.NetStack

Parameters

Return value

Error codes

NOTE For details about the error codes, see HTTP Error Codes. The HTTP error code mapping is in the format of 2300000 + Curl error code. For more common error codes, see Curl Error Codes.

Example

import http from '@ohos.net.http';

class Header {
  public contentType: string;

  constructor(contentType: string) {
    this.contentType = contentType;
  }
}

let httpRequest = http.createHttp();
let promise = httpRequest.request("EXAMPLE_URL", {
  method: http.RequestMethod.GET,
  connectTimeout: 60000,
  readTimeout: 60000,
  header: new Header('application/json')
});
promise.then((data: http.HttpResponse) => {
  console.info("requestInStream OK!" + JSON.stringify(data));
}).catch((err: Error) => {
  console.info("requestInStream ERROR : err = " + JSON.stringify(err));
});

on(‘headerReceive’)^(deprecated)

on(type: ‘headerReceive’, callback: AsyncCallback<Object>): void

Registers an observer for HTTP Response Header events.

NOTE This API has been deprecated. You are advised to use on(‘headersReceive’)⁸⁺.

System capability: SystemCapability.Communication.NetStack

Parameters

Example

import http from '@ohos.net.http';
import { BusinessError } from '@ohos.base';

let httpRequest = http.createHttp();
httpRequest.on('headerReceive', (data: BusinessError) => {
  console.info('error:' + JSON.stringify(data));
});

off(‘headerReceive’)^(deprecated)

off(type: ‘headerReceive’, callback?: AsyncCallback<Object>): void

Unregisters the observer for HTTP Response Header events.

NOTE

1. This API has been deprecated. You are advised to use off(‘headersReceive’)⁸⁺.

2. 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

Parameters

Example

import http from '@ohos.net.http';

let httpRequest = http.createHttp();
httpRequest.off('headerReceive');

on(‘headersReceive’)⁸⁺

on(type: ‘headersReceive’, callback: Callback<Object>): void

Registers an observer for HTTP Response Header events.

System capability: SystemCapability.Communication.NetStack

Parameters

Example

import http from '@ohos.net.http';

let httpRequest = http.createHttp();
httpRequest.on('headersReceive', (header: Object) => {
  console.info('header: ' + JSON.stringify(header));
});

off(‘headersReceive’)⁸⁺

off(type: ‘headersReceive’, callback?: Callback<Object>): void

Unregisters the observer for HTTP Response Header events.

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.

System capability: SystemCapability.Communication.NetStack

Parameters

Example

import http from '@ohos.net.http';

let httpRequest = http.createHttp();
httpRequest.off('headersReceive');

once(‘headersReceive’)⁸⁺

once(type: ‘headersReceive’, callback: Callback<Object>): void

Registers a one-time observer for HTTP Response Header events. Once triggered, the observer will be removed. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Communication.NetStack

Parameters

Example

import http from '@ohos.net.http';

let httpRequest = http.createHttp();
httpRequest.once('headersReceive', (header: Object) => {
  console.info('header: ' + JSON.stringify(header));
});

on(‘dataReceive’)¹⁰⁺

on(type: ‘dataReceive’, callback: Callback<ArrayBuffer>): void

Registers an observer for events indicating receiving of HTTP streaming responses.

NOTE Currently, listening for events related to HTTP streaming data upload is not supported.

System capability: SystemCapability.Communication.NetStack

Parameters

Example

import http from '@ohos.net.http';

let httpRequest = http.createHttp();
httpRequest.on('dataReceive', (data: ArrayBuffer) => {
  console.info('dataReceive length: ' + JSON.stringify(data.byteLength));
});

off(‘dataReceive’)¹⁰⁺

off(type: ‘dataReceive’, callback?: Callback<ArrayBuffer>): void

Unregisters the observer for events indicating receiving of HTTP streaming responses.

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.

System capability: SystemCapability.Communication.NetStack

Parameters

Example

import http from '@ohos.net.http';

let httpRequest = http.createHttp();
httpRequest.off('dataReceive');

on(‘dataEnd’)¹⁰⁺

on(type: ‘dataEnd’, callback: Callback<void>): void

Registers an observer for events indicating completion of receiving HTTP streaming responses.

NOTE Currently, listening for events related to HTTP streaming data upload is not supported.

System capability: SystemCapability.Communication.NetStack

Parameters

Example

import http from '@ohos.net.http';

let httpRequest = http.createHttp();
httpRequest.on('dataEnd', () => {
  console.info('Receive dataEnd !');
});

off(‘dataEnd’)¹⁰⁺

off(type: ‘dataEnd’, callback?: Callback<void>): void

Unregisters the observer for events indicating completion of receiving HTTP streaming responses.

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.

System capability: SystemCapability.Communication.NetStack

Parameters

Example

import http from '@ohos.net.http';

let httpRequest = http.createHttp();
httpRequest.off('dataEnd');

on(‘dataReceiveProgress’)¹⁰⁺

on(type: ‘dataReceiveProgress’, callback: Callback<{ receiveSize: number, totalSize: number }>): void

Registers an observer for events indicating progress of receiving HTTP streaming responses.

NOTE Currently, listening for events related to HTTP streaming data upload is not supported.

System capability: SystemCapability.Communication.NetStack

Parameters

Example

import http from '@ohos.net.http';

class RequestData{
  receiveSize: number = 2000 
  totalSize: number = 2000 
}

let httpRequest = http.createHttp();
httpRequest.on('dataReceiveProgress', (data: RequestData) => {
  console.info('dataReceiveProgress:' + JSON.stringify(data));
});

off(‘dataReceiveProgress’)¹⁰⁺

off(type: ‘dataReceiveProgress’, callback?: Callback<{ receiveSize: number, totalSize: number }>): void

Unregisters the observer for events indicating progress of receiving HTTP streaming responses.

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.

System capability: SystemCapability.Communication.NetStack

Parameters

Example

import http from '@ohos.net.http';

let httpRequest = http.createHttp();
httpRequest.off('dataReceiveProgress');

HttpRequestOptions⁶⁺

Specifies the type and value range of the optional parameters in the HTTP request.

System capability: SystemCapability.Communication.NetStack

RequestMethod⁶⁺

Defines an HTTP request method.

System capability: SystemCapability.Communication.NetStack

ResponseCode⁶⁺

Enumerates the response codes for an HTTP request.

System capability: SystemCapability.Communication.NetStack

HttpResponse⁶⁺

Defines the response to an HTTP request.

System capability: SystemCapability.Communication.NetStack

http.createHttpResponseCache⁹⁺

createHttpResponseCache(cacheSize?: number): HttpResponseCache

Creates a default object to store responses to HTTP access requests.

System capability: SystemCapability.Communication.NetStack

Parameters

Return value

Example

import http from '@ohos.net.http';

let httpResponseCache = http.createHttpResponseCache();

HttpResponseCache⁹⁺

Defines an object that stores the response to an HTTP request. Before invoking APIs provided by HttpResponseCache, you must call createHttpResponseCache() to create an HttpRequestTask object.

flush⁹⁺

flush(callback: AsyncCallback<void>): void

Flushes data in the cache to the file system so that the cached data can be accessed in the next HTTP request. This API uses an asynchronous callback to return the result. Cached data includes the response header (header), response body (result), cookies, request time (requestTime), and response time (responseTime).

System capability: SystemCapability.Communication.NetStack

Parameters

Example

import http from '@ohos.net.http';
import { BusinessError } from '@ohos.base';

let httpResponseCache = http.createHttpResponseCache();
httpResponseCache.flush((err: BusinessError) => {
  if (err) {
    console.info('flush fail');
    return;
  }
  console.info('flush success');
});

flush⁹⁺

flush(): Promise<void>

Flushes data in the cache to the file system so that the cached data can be accessed in the next HTTP request. This API uses a promise to return the result.

System capability: SystemCapability.Communication.NetStack

Return value

Example

import http from '@ohos.net.http';
import { BusinessError } from '@ohos.base';

let httpResponseCache = http.createHttpResponseCache();
httpResponseCache.flush().then(() => {
  console.info('flush success');
}).catch((err: BusinessError) => {
  console.info('flush fail');
});

delete⁹⁺

delete(callback: AsyncCallback<void>): void

Disables the cache and deletes the data in it. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Communication.NetStack

Parameters

Example

import http from '@ohos.net.http';
import { BusinessError } from '@ohos.base';

let httpResponseCache = http.createHttpResponseCache();
httpResponseCache.delete((err: BusinessError) => {
  if (err) {
    console.info('delete fail');
    return;
  }
  console.info('delete success');
});

delete⁹⁺

delete(): Promise<void>

Disables the cache and deletes the data in it. This API uses a promise to return the result.

System capability: SystemCapability.Communication.NetStack

Return value

Example

import http from '@ohos.net.http';
import { BusinessError } from '@ohos.base';

let httpResponseCache = http.createHttpResponseCache();
httpResponseCache.delete().then(() => {
  console.info('delete success');
}).catch((err: Error) => {
  console.info('delete fail');
});

HttpDataType⁹⁺

Enumerates HTTP data types.

System capability: SystemCapability.Communication.NetStack

|Name|Value|Description | |——————|–|———–| |STRING |0|String type.| |OBJECT |1|Object type. | |ARRAY_BUFFER |2|Binary array type.|

HttpProtocol⁹⁺

Enumerates HTTP protocol versions.

System capability: SystemCapability.Communication.NetStack

你可能感兴趣的鸿蒙文章

harmony 鸿蒙APIs

harmony 鸿蒙System Common Events (To Be Deprecated Soon)

harmony 鸿蒙System Common Events

harmony 鸿蒙API Reference Document Description

harmony 鸿蒙Enterprise Device Management Overview (for System Applications Only)

harmony 鸿蒙BundleStatusCallback

harmony 鸿蒙@ohos.bundle.innerBundleManager (innerBundleManager)

harmony 鸿蒙@ohos.distributedBundle (Distributed Bundle Management)

harmony 鸿蒙@ohos.bundle (Bundle)

harmony 鸿蒙@ohos.enterprise.EnterpriseAdminExtensionAbility (EnterpriseAdminExtensionAbility)