數(shù)據(jù)請求

導入模塊

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

完整示例

// 引入包名
import http from '@ohos.net.http';

// 每一個httpRequest對應一個HTTP請求任務，不可復用
let httpRequest = http.createHttp();
// 用于訂閱HTTP響應頭，此接口會比request請求先返回?？梢愿鶕?jù)業(yè)務需要訂閱此消息
// 從API 8開始，使用on('headersReceive', Callback)替代on('headerReceive', AsyncCallback)。 8+
httpRequest.on('headersReceive', (header) => {
    console.info('header: ' + JSON.stringify(header));
});
httpRequest.request(
    // 填寫HTTP請求的URL地址，可以帶參數(shù)也可以不帶參數(shù)。URL地址需要開發(fā)者自定義。請求的參數(shù)可以在extraData中指定
    "EXAMPLE_URL",
    {
        method: http.RequestMethod.POST, // 可選，默認為http.RequestMethod.GET
        // 開發(fā)者根據(jù)自身業(yè)務需要添加header字段
        header: {
            'Content-Type': 'application/json'
        },
        // 當使用POST請求時此字段用于傳遞內容
        extraData: {
            "data": "data to send",
        },
        expectDataType: http.HttpDataType.STRING, // 可選，指定返回數(shù)據(jù)的類型
        usingCache: true, // 可選，默認為true
        priority: 1, // 可選，默認為1
        connectTimeout: 60000, // 可選，默認為60000ms
        readTimeout: 60000, // 可選，默認為60000ms
        usingProtocol: http.HttpProtocol.HTTP1_1, // 可選，協(xié)議類型默認值由系統(tǒng)自動指定
    }, (err, data) => {
        if (!err) {
            // data.result為HTTP響應內容，可根據(jù)業(yè)務需要進行解析
            console.info('Result:' + JSON.stringify(data.result));
            console.info('code:' + JSON.stringify(data.responseCode));
            // data.header為HTTP響應頭，可根據(jù)業(yè)務需要進行解析
            console.info('header:' + JSON.stringify(data.header));
            console.info('cookies:' + JSON.stringify(data.cookies)); // 8+
            // 取消訂閱HTTP響應頭事件
            httpRequest.off('headersReceive');
            // 當該請求使用完畢時，調用destroy方法主動銷毀
            httpRequest.destroy();
        } else {
            console.info('error:' + JSON.stringify(err));
            // 取消訂閱HTTP響應頭事件
            httpRequest.off('headersReceive');
            // 當該請求使用完畢時，調用destroy方法主動銷毀。
            httpRequest.destroy();
        }
    }
);

http.createHttp

createHttp(): HttpRequest

創(chuàng)建一個HTTP請求，里面包括發(fā)起請求、中斷請求、訂閱/取消訂閱HTTP Response Header事件。

每一個HttpRequest對象對應一個HTTP請求。如需發(fā)起多個HTTP請求，須為每個HTTP請求創(chuàng)建對應HttpRequest對象。最多只能創(chuàng)建100個HttpRequest對象。

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

返回值：

示例：

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

HttpRequest

HTTP請求任務。在調用HttpRequest的方法前，需要先通過createHttp()創(chuàng)建一個任務。

request

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

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

需要權限：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<HttpResponse>):void

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

需要權限：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<HttpResponse>

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

需要權限：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

中斷請求任務。

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

示例：

httpRequest.destroy();

on('headerReceive')(deprecated)

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

訂閱HTTP Response Header 事件。

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

參數(shù)：

示例：

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

off('headerReceive')(deprecated)

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

取消訂閱HTTP Response Header 事件。

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

參數(shù)：

示例：

httpRequest.off('headerReceive');

on('headersReceive')8+

on(type: 'headersReceive', callback: Callback<Object>): 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<Object>): void

取消訂閱HTTP Response Header 事件。

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

參數(shù)：

示例：

httpRequest.off('headersReceive');

once('headersReceive')8+

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

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

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

參數(shù)：

示例：

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

HttpRequestOptions

發(fā)起請求可選參數(shù)的類型和取值范圍。

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

RequestMethod

HTTP 請求方法。

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

ResponseCode

發(fā)起請求返回的響應碼。

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

HttpResponse

request方法回調函數(shù)的返回值類型。

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

http.createHttpResponseCache9+

createHttpResponseCache(cacheSize?: number): HttpResponseCache

創(chuàng)建一個默認的對象來存儲HTTP訪問請求的響應。

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

參數(shù)：

返回值：

示例：

import http from '@ohos.net.http';
let httpResponseCache = http.createHttpResponseCache();

HttpResponseCache9+

存儲HTTP訪問請求響應的對象。在調用HttpResponseCache的方法前，需要先通過createHttpResponseCache()創(chuàng)建一個任務。

flush9+

flush(callback: AsyncCallback<void>): void

將緩存中的數(shù)據(jù)寫入文件系統(tǒng)，以便在下一個HTTP請求中訪問所有緩存數(shù)據(jù)，使用callback方式作為異步方法。

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

參數(shù)：

示例：

httpResponseCache.flush(err => {
  if (err) {
    console.info('flush fail');
    return;
  }
  console.info('flush success');
});

flush9+

flush(): Promise<void>

將緩存中的數(shù)據(jù)寫入文件系統(tǒng)，以便在下一個HTTP請求中訪問所有緩存數(shù)據(jù)，使用Promise方式作為異步方法。

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

返回值：

示例：

httpResponseCache.flush().then(() => {
  console.info('flush success');
}).catch(err => {
  console.info('flush fail');
});

delete9+

delete(callback: AsyncCallback<void>): void

禁用緩存并刪除其中的數(shù)據(jù)，使用callback方式作為異步方法。

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

參數(shù)：

示例：

httpResponseCache.delete(err => {
  if (err) {
    console.info('delete fail');
    return;
  }
  console.info('delete success');
});

delete9+

delete(): Promise<void>

禁用緩存并刪除其中的數(shù)據(jù)，使用Promise方式作為異步方法。

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

返回值：

示例：

httpResponseCache.delete().then(() => {
  console.info('delete success');
}).catch(err => {
  console.info('delete fail');
});

HttpDataType9+

http的數(shù)據(jù)類型。

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

HttpProtocol9+

http協(xié)議版本。

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