一、場景介紹

應用通過HTTP發起一個數據請求，支持常見的GET、POST、OPTIONS、HEAD、PUT、DELETE、TRACE、CONNECT方法。

二、接口說明

HTTP數據請求功能主要由http模塊提供。

使用該功能需要申請ohos.permission.INTERNET權限。

涉及的接口如下表，具體的接口說明請參考API文檔。

接口名	功能描述
createHttp()	創建一個http請求。
request()	根據URL地址，發起HTTP網絡請求。
destroy()	中斷請求任務。
on(type: 'headersReceive')	訂閱HTTP Response Header 事件。
off(type: 'headersReceive')	取消訂閱HTTP Response Header 事件。
once('headersReceive')8+	訂閱HTTP Response Header 事件，但是只觸發一次。

熟悉[鴻蒙]文檔

鴻蒙OS開發	更多內容↓點擊	HarmonyOS與OpenHarmony技術
鴻蒙技術文檔	《鴻蒙NEXT星河版開發學習文檔》

搜狗高速瀏覽器截圖20240326151450.png

三、request接口開發步驟

1.從@ohos.net.http.d.ts中導入http命名空間。

2.調用createHttp()方法，創建一個HttpRequest對象。

3.調用該對象的on()方法，訂閱http響應頭事件，此接口會比request請求先返回。可以根據業務需要訂閱此消息。

4.調用該對象的request()方法，傳入http請求的url地址和可選參數，發起網絡請求。

5.按照實際業務需要，解析返回結果。

6.調用該對象的off()方法，取消訂閱http響應頭事件。

7.當該請求使用完畢時，調用destroy()方法主動銷毀。

// 引入包名
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",
        },
        expectDataType: http.HttpDataType.STRING, // 可選，指定返回數據的類型
        usingCache: true, // 可選，默認為true
        priority: 1, // 可選，默認為1
        connectTimeout: 60000, // 可選，默認為60000ms
        readTimeout: 60000, // 可選，默認為60000ms
        usingProtocol: http.HttpProtocol.HTTP1_1, // 可選，協議類型默認值由系統自動指定
    }, (err, data) = > {
        if (!err) {
            // data.result為HTTP響應內容，可根據業務需要進行解析
            console.info('Result:' + JSON.stringify(data.result));
            console.info('code:' + JSON.stringify(data.responseCode));
            // data.header為HTTP響應頭，可根據業務需要進行解析
            console.info('header:' + JSON.stringify(data.header));
            console.info('cookies:' + JSON.stringify(data.cookies)); // 8+
        } else {
            console.info('error:' + JSON.stringify(err));
            // 取消訂閱HTTP響應頭事件
            httpRequest.off('headersReceive');
            // 當該請求使用完畢時，調用destroy方法主動銷毀
            httpRequest.destroy();
        }
    }
);