数据请求

说明：

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

导入模块

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

完整示例

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

// 每一个httpRequest对应一个http请求任务，不可复用
let httpRequest = http.createHttp();
// 用于订阅http响应头，此接口会比request请求先返回。可以根据业务需要订阅此消息
// 从API 8开始，使用on('headersReceive', Callback)替代on('headerReceive', AsyncCallback)。 8+
httpRequest.on('headersReceive', (header) => {
    console.info('header: ' + JSON.stringify(header));
});
httpRequest.request(
    // 填写http请求的url地址，可以带参数也可以不带参数。URL地址需要开发者自定义。请求的参数可以在extraData中指定
    "EXAMPLE_URL",
    {
        method: http.RequestMethod.POST, // 可选，默认为http.RequestMethod.GET
        // 开发者根据自身业务需要添加header字段
        header: {
            'Content-Type': 'application/json'
        },
        // 当使用POST请求时此字段用于传递内容
        extraData: {
            "data": "data to send",
        },
        connectTimeout: 60000, // 可选，默认为60s
        readTimeout: 60000, // 可选，默认为60s
    }, (err, data) => {
        if (!err) {
            // data.result为http响应内容，可根据业务需要进行解析
            console.info('Result:' + data.result);
            console.info('code:' + data.responseCode);
            // data.header为http响应头，可根据业务需要进行解析
            console.info('header:' + JSON.stringify(data.header));
            console.info('cookies:' + data.cookies); // 8+
        } else {
            console.info('error:' + JSON.stringify(err));
            // 当该请求使用完毕时，调用destroy方法主动销毁。
            httpRequest.destroy();
        }
    }
);

http.createHttp

createHttp(): HttpRequest

创建一个http，里面包括发起请求、中断请求、订阅/取消订阅HTTP Response Header 事件。每一个HttpRequest对象对应一个Http请求。如需发起多个Http请求，须为每个Http请求创建对应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方式作为异步方法。

需要权限：ohos.permission.INTERNET

系统能力：SystemCapability.Communication.NetStack

参数：

示例：

httpRequest.request("EXAMPLE_URL", (err, data) => {
    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

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

需要权限：ohos.permission.INTERNET

系统能力：SystemCapability.Communication.NetStack

参数：

示例：

httpRequest.request("EXAMPLE_URL",
{
    method: http.RequestMethod.GET,
    header: {
        'Content-Type': 'application/json'
    },
    readTimeout: 60000,
    connectTimeout: 60000
}, (err, data) => {
    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+
        console.info('header.Content-Type:' + data.header['Content-Type']);
        console.info('header.Status-Line:' + data.header['Status-Line']);
    } else {
        console.info('error:' + JSON.stringify(err));
    }
});

request

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

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

需要权限：ohos.permission.INTERNET

系统能力：SystemCapability.Communication.NetStack

参数：

返回值：

示例：

let promise = httpRequest.request("EXAMPLE_URL", {
    method: http.RequestMethod.GET,
    connectTimeout: 60000,
    readTimeout: 60000,
    header: {
        'Content-Type': 'application/json'
    }
});
promise.then((data) => {
    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['Content-Type']);
    console.info('header.Status-Line:' + data.header['Status-Line']);
}).catch((err) => {
    console.info('error:' + JSON.stringify(err));
});

destroy

destroy(): void

中断请求任务。

系统能力：SystemCapability.Communication.NetStack

示例：

httpRequest.destroy();

on('headerReceive')

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

订阅HTTP Response Header 事件。

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

系统能力：SystemCapability.Communication.NetStack

参数：

示例：

httpRequest.on('headerReceive', (err, data) => {
    if (!err) {
        console.info('header: ' + JSON.stringify(data));
    } else {
        console.info('error:' + JSON.stringify(err));
    }
});

off('headerReceive')

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

取消订阅HTTP Response Header 事件。

说明：

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

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

系统能力：SystemCapability.Communication.NetStack

参数：

示例：

httpRequest.off('headerReceive');

on('headersReceive')⁸⁺

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

订阅HTTP Response Header 事件。

系统能力：SystemCapability.Communication.NetStack

参数：

示例：

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

off('headersReceive')⁸⁺

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

取消订阅HTTP Response Header 事件。

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

系统能力：SystemCapability.Communication.NetStack

参数：

示例：

httpRequest.off('headersReceive');

once('headersReceive')⁸⁺

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

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

系统能力：SystemCapability.Communication.NetStack

参数：

示例：

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

HttpRequestOptions

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

系统能力：以下各项对应的系统能力均为SystemCapability.Communication.NetStack。

RequestMethod

HTTP 请求方法。

系统能力：以下各项对应的系统能力均为SystemCapability.Communication.NetStack。

ResponseCode

发起请求返回的响应码。

系统能力：以下各项对应的系统能力均为SystemCapability.Communication.NetStack。

HttpResponse

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

系统能力：以下各项对应的系统能力均为SystemCapability.Communication.NetStack。