數(shù)據(jù)請(qǐng)求

說(shuō)明：
開(kāi)發(fā)前請(qǐng)熟悉鴻蒙開(kāi)發(fā)指導(dǎo)文檔 ：[gitee.com/li-shizhen-skin/harmony-os/blob/master/README.md]
本模塊首批接口從API version 6開(kāi)始支持。后續(xù)版本的新增接口，采用上角標(biāo)單獨(dú)標(biāo)記接口的起始版本。

導(dǎo)入模塊

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

完整示例

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

// 每一個(gè)httpRequest對(duì)應(yīng)一個(gè)http請(qǐng)求任務(wù)，不可復(fù)用
let httpRequest = http.createHttp();
// 用于訂閱http響應(yīng)頭，此接口會(huì)比request請(qǐng)求先返回?？梢愿鶕?jù)業(yè)務(wù)需要訂閱此消息
// 從API 8開(kāi)始，使用on('headersReceive', Callback)替代on('headerReceive', AsyncCallback)。 8+
httpRequest.on('headersReceive', (header) = > {
    console.info('header: ' + JSON.stringify(header));
});
httpRequest.request(
    // 填寫(xiě)http請(qǐng)求的url地址，可以帶參數(shù)也可以不帶參數(shù)。URL地址需要開(kāi)發(fā)者自定義。請(qǐng)求的參數(shù)可以在extraData中指定
    "EXAMPLE_URL",
    {
        method: http.RequestMethod.POST, // 可選，默認(rèn)為http.RequestMethod.GET
        // 開(kāi)發(fā)者根據(jù)自身業(yè)務(wù)需要添加header字段
        header: {
            'Content-Type': 'application/json'
        },
        // 當(dāng)使用POST請(qǐng)求時(shí)此字段用于傳遞內(nèi)容
        extraData: {
            "data": "data to send",
        },
        connectTimeout: 60000, // 可選，默認(rèn)為60s
        readTimeout: 60000, // 可選，默認(rèn)為60s
    }, (err, data) = > {
        if (!err) {
            // data.result為http響應(yīng)內(nèi)容，可根據(jù)業(yè)務(wù)需要進(jìn)行解析
            console.info('Result:' + data.result);
            console.info('code:' + data.responseCode);
            // data.header為http響應(yīng)頭，可根據(jù)業(yè)務(wù)需要進(jìn)行解析
            console.info('header:' + JSON.stringify(data.header));
            console.info('cookies:' + data.cookies); // 8+
        } else {
            console.info('error:' + JSON.stringify(err));
            // 當(dāng)該請(qǐng)求使用完畢時(shí)，調(diào)用destroy方法主動(dòng)銷(xiāo)毀。
            httpRequest.destroy();
        }
    }
);

http.createHttp

createHttp(): HttpRequest

創(chuàng)建一個(gè)http，里面包括發(fā)起請(qǐng)求、中斷請(qǐng)求、訂閱/取消訂閱HTTP Response Header 事件。每一個(gè)HttpRequest對(duì)象對(duì)應(yīng)一個(gè)Http請(qǐng)求。如需發(fā)起多個(gè)Http請(qǐng)求，須為每個(gè)Http請(qǐng)求創(chuàng)建對(duì)應(yīng)HttpRequest對(duì)象。

系統(tǒng)能力 ：SystemCapability.Communication.NetStack

返回值：

示例：

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

HttpRequest

http請(qǐng)求任務(wù)。在調(diào)用HttpRequest的方法前，需要先通過(guò)[createHttp()]創(chuàng)建一個(gè)任務(wù)。

request

request(url: string, callback: AsyncCallback):void

根據(jù)URL地址，發(fā)起HTTP網(wǎng)絡(luò)請(qǐng)求，使用callback方式作為異步方法。

需要權(quán)限 ：ohos.permission.INTERNET

系統(tǒng)能力 ：SystemCapability.Communication.NetStack

參數(shù)：

示例：

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):void

根據(jù)URL地址和相關(guān)配置項(xiàng)，發(fā)起HTTP網(wǎng)絡(luò)請(qǐng)求，使用callback方式作為異步方法。

需要權(quán)限 ：ohos.permission.INTERNET

系統(tǒng)能力 ：SystemCapability.Communication.NetStack

參數(shù)：

示例：

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

根據(jù)URL地址，發(fā)起HTTP網(wǎng)絡(luò)請(qǐng)求，使用Promise方式作為異步方法。

需要權(quán)限 ：ohos.permission.INTERNET

系統(tǒng)能力 ：SystemCapability.Communication.NetStack

參數(shù)：

返回值：

示例：

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

中斷請(qǐng)求任務(wù)。

系統(tǒng)能力 ：SystemCapability.Communication.NetStack

示例：

httpRequest.destroy();

on('headerReceive')

on(type: 'headerReceive', callback: AsyncCallback ): void

訂閱HTTP Response Header 事件。

說(shuō)明： 此接口已廢棄，建議使用[on('headersReceive')8+]替代。

系統(tǒng)能力 ：SystemCapability.Communication.NetStack

參數(shù)：

示例：

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 ): void

取消訂閱HTTP Response Header 事件。

說(shuō)明：

1. 此接口已廢棄，建議使用[off('headersReceive')8+]替代。
2. 可以指定傳入on中的callback取消一個(gè)訂閱，也可以不指定callback清空所有訂閱。

系統(tǒng)能力 ：SystemCapability.Communication.NetStack

參數(shù)：

示例：

httpRequest.off('headerReceive');

on('headersReceive')8+

on(type: 'headersReceive', callback: Callback ): void

訂閱HTTP Response Header 事件。

系統(tǒng)能力 ：SystemCapability.Communication.NetStack

參數(shù)：

示例：

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

off('headersReceive')8+

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

取消訂閱HTTP Response Header 事件。

說(shuō)明： 可以指定傳入on中的callback取消一個(gè)訂閱，也可以不指定callback清空所有訂閱。

系統(tǒng)能力 ：SystemCapability.Communication.NetStack

參數(shù)：

示例：

httpRequest.off('headersReceive');

once('headersReceive')8+

once(type: 'headersReceive', callback: Callback ): void

訂閱HTTP Response Header 事件，但是只觸發(fā)一次。一旦觸發(fā)之后，訂閱器就會(huì)被移除。使用callback方式作為異步方法。

系統(tǒng)能力 ：SystemCapability.Communication.NetStack

參數(shù)：

示例：

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

HttpRequestOptions

發(fā)起請(qǐng)求可選參數(shù)的類(lèi)型和取值范圍。

系統(tǒng)能力 ：以下各項(xiàng)對(duì)應(yīng)的系統(tǒng)能力均為SystemCapability.Communication.NetStack。

RequestMethod

HTTP 請(qǐng)求方法。

系統(tǒng)能力 ：以下各項(xiàng)對(duì)應(yīng)的系統(tǒng)能力均為SystemCapability.Communication.NetStack。

ResponseCode

發(fā)起請(qǐng)求返回的響應(yīng)碼。

系統(tǒng)能力 ：以下各項(xiàng)對(duì)應(yīng)的系統(tǒng)能力均為SystemCapability.Communication.NetStack。

HttpResponse

request方法回調(diào)函數(shù)的返回值類(lèi)型。

系統(tǒng)能力 ：以下各項(xiàng)對(duì)應(yīng)的系統(tǒng)能力均為SystemCapability.Communication.NetStack。

審核編輯 黃宇