@ohos.net.http (数据请求)

本模块提供HTTP数据请求能力。应用可以通过HTTP发起一个数据请求，支持常见的GET、POST、OPTIONS、HEAD、PUT、DELETE、TRACE、CONNECT方法。

说明：

本模块首批接口从API version 6开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

导入模块

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

完整示例

// 引入包名
import http from '@ohos.net.http';
import { BusinessError } from '@ohos.base';

// 每一个httpRequest对应一个HTTP请求任务，不可复用
let httpRequest = http.createHttp();
// 用于订阅HTTP响应头，此接口会比request请求先返回。可以根据业务需要订阅此消息
// 从API 8开始，使用on('headersReceive', Callback)替代on('headerReceive', AsyncCallback)。 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(// 填写HTTP请求的URL地址，可以带参数也可以不带参数。URL地址需要开发者自定义。请求的参数可以在extraData中指定
  "EXAMPLE_URL",
  {
    method: http.RequestMethod.POST, // 可选，默认为http.RequestMethod.GET
    // 当使用POST请求时此字段用于传递内容
    extraData: new ExtraData('data to send'),
    expectDataType: http.HttpDataType.STRING, // 可选，指定返回数据的类型
    usingCache: true, // 可选，默认为true
    priority: 1, // 可选，默认为1
    // 开发者根据自身业务需要添加header字段
    header: new Header('application/json'),
    readTimeout: 60000, // 可选，默认为60000ms
    connectTimeout: 60000, // 可选，默认为60000ms
    usingProtocol: http.HttpProtocol.HTTP1_1, // 可选，协议类型默认值由系统自动指定
    usingProxy: false, //可选，默认不使用网络代理，自API 10开始支持该属性
    caPath: "", // 可选，默认使用系统预设CA证书，自API 10开始支持该属性
  },
  (err: BusinessError, data: http.HttpResponse) => {
    if (!err) {
      // data.result为HTTP响应内容，可根据业务需要进行解析
      console.info('Result:' + JSON.stringify(data.result));
      console.info('code:' + JSON.stringify(data.responseCode));
      console.info('type:' + JSON.stringify(data.resultType));
      // data.header为HTTP响应头，可根据业务需要进行解析
      console.info('header:' + JSON.stringify(data.header));
      console.info('cookies:' + JSON.stringify(data.cookies)); // 自API version 8开始支持cookie
      // 取消订阅HTTP响应头事件
      httpRequest.off('headersReceive');
      // 当该请求使用完毕时，开发者务必调用destroy方法主动销毁该JavaScript Object。
      httpRequest.destroy();
    } else {
      console.info('error:' + JSON.stringify(err));
      // 取消订阅HTTP响应头事件
      httpRequest.off('headersReceive');
      // 当该请求使用完毕时，开发者务必调用destroy方法主动销毁该JavaScript Object。
      httpRequest.destroy();
    }
  });

说明： console.info()输出的数据中包含换行符会导致数据出现截断现象。

http.createHttp

createHttp(): HttpRequest

创建一个HTTP请求，里面包括发起请求、中断请求、订阅/取消订阅HTTP Response Header事件。每一个HttpRequest对象对应一个HTTP请求。如需发起多个HTTP请求，须为每个HTTP请求创建对应HttpRequest对象。

说明： 当该请求使用完毕时，须调用destroy方法主动销毁HttpRequest对象。

系统能力：SystemCapability.Communication.NetStack

返回值：

示例：

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

let httpRequest = http.createHttp();

HttpRequest

HTTP请求任务。在调用HttpRequest的方法前，需要先通过createHttp()创建一个任务。

request

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

根据URL地址，发起HTTP网络请求，使用callback方式作为异步方法。

说明： 此接口仅支持数据大小为5M以内的数据接收。

需要权限：ohos.permission.INTERNET

系统能力：SystemCapability.Communication.NetStack

参数：

错误码：

错误码说明： 以上错误码的详细介绍参见HTTP错误码。 HTTP 错误码映射关系：2300000 + curl错误码。更多常用错误码，可参考：curl错误码

示例：

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('type:' + JSON.stringify(data.resultType));
    console.info('header:' + JSON.stringify(data.header));
    console.info('cookies:' + data.cookies); // 自API version 8开始支持cookie
  } else {
    console.info('error:' + JSON.stringify(err));
  }
});

request

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

根据URL地址和相关配置项，发起HTTP网络请求，使用callback方式作为异步方法。

说明： 此接口仅支持数据大小为5M以内的数据接收。

需要权限：ohos.permission.INTERNET

系统能力：SystemCapability.Communication.NetStack

参数：

错误码：

错误码说明： 以上错误码的详细介绍参见HTTP错误码。 HTTP 错误码映射关系：2300000 + curl错误码。更多常用错误码，可参考：curl错误码

示例：

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('type:' + JSON.stringify(data.resultType));
  console.info('header:' + JSON.stringify(data.header));
  console.info('cookies:' + data.cookies); // 自API version 8开始支持cookie
  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>

根据URL地址，发起HTTP网络请求，使用Promise方式作为异步方法。

说明： 此接口仅支持数据大小为5M以内的数据接收。

需要权限：ohos.permission.INTERNET

系统能力：SystemCapability.Communication.NetStack

参数：

返回值：

错误码：

错误码说明： 以上错误码的详细介绍参见HTTP错误码。 HTTP 错误码映射关系：2300000 + curl错误码。更多常用错误码，可参考：curl错误码

示例：

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('type:' + JSON.stringify(data.resultType));
  console.info('header:' + JSON.stringify(data.header));
  console.info('cookies:' + data.cookies); // 自API version 8开始支持cookie
  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

中断请求任务。

系统能力：SystemCapability.Communication.NetStack

示例：

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

httpRequest.destroy();

requestInStream¹⁰⁺

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

根据URL地址，发起HTTP网络请求并返回流式响应，使用callback方式作为异步方法。

需要权限：ohos.permission.INTERNET

系统能力：SystemCapability.Communication.NetStack

参数：

错误码：

错误码说明： 以上错误码的详细介绍参见HTTP错误码。 HTTP 错误码映射关系：2300000 + curl错误码。更多常用错误码，可参考：curl错误码

示例：

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

根据URL地址和相关配置项，发起HTTP网络请求并返回流式响应，使用callback方式作为异步方法。

需要权限：ohos.permission.INTERNET

系统能力：SystemCapability.Communication.NetStack

参数：

错误码：

错误码说明： 以上错误码的详细介绍参见HTTP错误码。 HTTP 错误码映射关系：2300000 + curl错误码。更多常用错误码，可参考：curl错误码

示例：

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

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>

根据URL地址，发起HTTP网络请求并返回流式响应，使用Promise方式作为异步方法。

需要权限：ohos.permission.INTERNET

系统能力：SystemCapability.Communication.NetStack

参数：

返回值：

错误码：

错误码说明： 以上错误码的详细介绍参见HTTP错误码。 HTTP 错误码映射关系：2300000 + curl错误码。更多常用错误码，可参考：curl错误码

示例：

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

class Header {
  public contentType: string;

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

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

on("headerReceive")^(deprecated)

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

订阅HTTP Response Header 事件。

说明： 此接口已废弃，建议使用on("headersReceive")⁸⁺替代。

系统能力：SystemCapability.Communication.NetStack

参数：

示例：

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

取消订阅HTTP Response Header 事件。

说明：

1. 此接口已废弃，建议使用off("headersReceive")⁸⁺替代。

2. 可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。

系统能力：SystemCapability.Communication.NetStack

参数：

示例：

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

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

on("headersReceive")⁸⁺

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

订阅HTTP Response Header 事件。

系统能力：SystemCapability.Communication.NetStack

参数：

示例：

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

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

off("headersReceive")⁸⁺

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

取消订阅HTTP Response Header 事件。

说明： 可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。

系统能力：SystemCapability.Communication.NetStack

参数：

示例：

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

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

once("headersReceive")⁸⁺

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

订阅HTTP Response Header 事件，但是只触发一次。一旦触发之后，订阅器就会被移除。使用callback方式作为异步方法。

系统能力：SystemCapability.Communication.NetStack

参数：

示例：

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

订阅HTTP流式响应数据接收事件。

说明： 暂不支持订阅HTTP流式数据上传的相关事件。

系统能力：SystemCapability.Communication.NetStack

参数：

示例：

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

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

off("dataReceive")¹⁰⁺

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

取消订阅HTTP流式响应数据接收事件。

说明： 可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。

系统能力：SystemCapability.Communication.NetStack

参数：

示例：

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

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

on("dataEnd")¹⁰⁺

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

订阅HTTP流式响应数据接收完毕事件。

说明： 暂不支持订阅HTTP流式数据上传的相关事件。

系统能力：SystemCapability.Communication.NetStack

参数：

示例：

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

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

off("dataEnd")¹⁰⁺

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

取消订阅HTTP流式响应数据接收完毕事件。

说明： 可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。

系统能力：SystemCapability.Communication.NetStack

参数：

示例：

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

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

on("dataReceiveProgress")¹⁰⁺

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

订阅HTTP流式响应数据接收进度事件。

说明： 暂不支持订阅HTTP流式数据上传的相关事件。

系统能力：SystemCapability.Communication.NetStack

参数：

示例：

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));
});
httpRequest.off("dataReceiveProgress");

off("dataReceiveProgress")¹⁰⁺

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

取消订阅HTTP流式响应数据接收进度事件。

说明： 可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。

系统能力：SystemCapability.Communication.NetStack

参数：

示例：

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));
});
httpRequest.off("dataReceiveProgress");

HttpRequestOptions（支持跨平台）

发起请求可选参数的类型和取值范围。

系统能力：SystemCapability.Communication.NetStack

RequestMethod

HTTP 请求方法。

系统能力：SystemCapability.Communication.NetStack

ResponseCode

发起请求返回的响应码。

系统能力：SystemCapability.Communication.NetStack

HttpResponse

request方法回调函数的返回值类型。

系统能力：SystemCapability.Communication.NetStack

http.createHttpResponseCache⁹⁺

createHttpResponseCache(cacheSize?: number): HttpResponseCache

创建一个默认的对象来存储HTTP访问请求的响应。

系统能力：SystemCapability.Communication.NetStack

参数：

返回值：

示例：

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

let httpResponseCache = http.createHttpResponseCache();

HttpResponseCache⁹⁺

存储HTTP访问请求响应的对象。在调用HttpResponseCache的方法前，需要先通过createHttpResponseCache()创建一个任务。

flush⁹⁺

flush(callback: AsyncCallback<void>): void

将缓存中的数据写入文件系统，以便在下一个HTTP请求中访问所有缓存数据，使用callback方式作为异步方法。缓存数据包括：响应头（header）、响应体（result）、cookies、请求时间（requestTime）和响应时间（responseTime）。

系统能力：SystemCapability.Communication.NetStack

参数：

示例：

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>

将缓存中的数据写入文件系统，以便在下一个HTTP请求中访问所有缓存数据，使用Promise方式作为异步方法。

系统能力：SystemCapability.Communication.NetStack

返回值：

示例：

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

禁用缓存并删除其中的数据，使用callback方式作为异步方法。

系统能力：SystemCapability.Communication.NetStack

参数：

示例：

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>

禁用缓存并删除其中的数据，使用Promise方式作为异步方法。

系统能力：SystemCapability.Communication.NetStack

返回值：

示例：

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⁹⁺

http的数据类型。

系统能力：SystemCapability.Communication.NetStack

HttpProtocol⁹⁺

http协议版本。

系统能力：SystemCapability.Communication.NetStack