鸿蒙开发网络管理： @ohos.net.http 数据请求

jf_46214456 2024-06-18 759

电子说

1.3w人已加入

描述

数据请求

鸿蒙说明：
开发前请熟悉鸿蒙开发指导文档 ：[gitee.com/li-shizhen-skin/harmony-os/blob/master/README.md]
本模块首批接口从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

返回值：

类型说明
HttpRequest返回一个HttpRequest对象，里面包括request、destroy、on和off方法。

示例：

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

HttpRequest

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

request

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

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

需要权限 ：ohos.permission.INTERNET

系统能力 ：SystemCapability.Communication.NetStack

参数：

参数名类型必填说明
urlstring是发起网络请求的URL地址。
callbackAsyncCallback<[HttpResponse]>是回调函数。

示例：

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

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

需要权限 ：ohos.permission.INTERNET

系统能力 ：SystemCapability.Communication.NetStack

参数：

参数名类型必填说明
urlstring是发起网络请求的URL地址。
optionsHttpRequestOptions是参考[HttpRequestOptions]。
callbackAsyncCallback<[HttpResponse]>是回调函数。

示例：

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

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

需要权限 ：ohos.permission.INTERNET

系统能力 ：SystemCapability.Communication.NetStack

参数：

参数名类型必填说明
urlstring是发起网络请求的URL地址。
optionsHttpRequestOptions是参考[HttpRequestOptions]。

返回值：

类型说明
Promise<[HttpResponse]>以Promise形式返回发起请求的结果。

示例：

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

订阅HTTP Response Header 事件。

鸿蒙说明： 此接口已废弃，建议使用[on('headersReceive')8+]替代。

系统能力 ：SystemCapability.Communication.NetStack

参数：

参数名类型必填说明
typestring是订阅的事件类型，'headerReceive'。
callbackAsyncCallback是回调函数。

示例：

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 事件。

鸿蒙说明：

  1. 此接口已废弃，建议使用[off('headersReceive')8+]替代。
  2. 可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。

系统能力 ：SystemCapability.Communication.NetStack

参数：

参数名类型必填说明
typestring是取消订阅的事件类型，'headerReceive'。
callbackAsyncCallback否回调函数。

示例：

httpRequest.off('headerReceive');

on('headersReceive')8+

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

订阅HTTP Response Header 事件。

系统能力 ：SystemCapability.Communication.NetStack

参数：

参数名类型必填说明
typestring是订阅的事件类型：'headersReceive'。
callbackCallback是回调函数。

示例：

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

off('headersReceive')8+

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

取消订阅HTTP Response Header 事件。

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

系统能力 ：SystemCapability.Communication.NetStack

参数：

参数名类型必填说明
typestring是取消订阅的事件类型：'headersReceive'。
callbackCallback否回调函数。

示例：

httpRequest.off('headersReceive');

once('headersReceive')8+

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

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

系统能力 ：SystemCapability.Communication.NetStack

参数：

参数名类型必填说明
typestring是订阅的事件类型：'headersReceive'。
callbackCallback是回调函数。

示例：

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

HttpRequestOptions

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

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

参数名类型必填说明
method[RequestMethod]否请求方式。
extraDatastringObjectArrayBuffer8+
headerObject否HTTP请求头字段。默认{'Content-Type': 'application/json'}。
readTimeoutnumber否读取超时时间。单位为毫秒（ms），默认为60000ms。
connectTimeoutnumber否连接超时时间。单位为毫秒（ms），默认为60000ms。

RequestMethod

HTTP 请求方法。

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

名称值说明
OPTIONSOPTIONSHTTP 请求 OPTIONS。
GETGETHTTP 请求 GET。
HEADHEADHTTP 请求 HEAD。
POSTPOSTHTTP 请求 POST。
PUTPUTHTTP 请求 PUT。
DELETEDELETEHTTP 请求 DELETE。
TRACETRACEHTTP 请求 TRACE。
CONNECTCONNECTHTTP 请求 CONNECT。

ResponseCode

发起请求返回的响应码。

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

名称值说明
OK200请求成功。一般用于GET与POST请求。
CREATED201已创建。成功请求并创建了新的资源。
ACCEPTED202已接受。已经接受请求，但未处理完成。
NOT_AUTHORITATIVE203非授权信息。请求成功。
NO_CONTENT204无内容。服务器成功处理，但未返回内容。
RESET205重置内容。
PARTIAL206部分内容。服务器成功处理了部分GET请求。
MULT_CHOICE300多种选择。
MOVED_PERM301永久移动。请求的资源已被永久的移动到新URI，返回信息会包括新的URI，浏览器会自动定向到新URI。
MOVED_TEMP302临时移动。
SEE_OTHER303查看其它地址。
NOT_MODIFIED304未修改。
USE_PROXY305使用代理。
BAD_REQUEST400客户端请求的语法错误，服务器无法理解。
UNAUTHORIZED401请求要求用户的身份认证。
PAYMENT_REQUIRED402保留，将来使用。
FORBIDDEN403服务器理解请求客户端的请求，但是拒绝执行此请求。
NOT_FOUND404服务器无法根据客户端的请求找到资源（网页）。
BAD_METHOD405客户端请求中的方法被禁止。
NOT_ACCEPTABLE406服务器无法根据客户端请求的内容特性完成请求。
PROXY_AUTH407请求要求代理的身份认证。
CLIENT_TIMEOUT408请求时间过长，超时。
CONFLICT409服务器完成客户端的PUT请求是可能返回此代码，服务器处理请求时发生了冲突。
GONE410客户端请求的资源已经不存在。
LENGTH_REQUIRED411服务器无法处理客户端发送的不带Content-Length的请求信息。
PRECON_FAILED412客户端请求信息的先决条件错误。
ENTITY_TOO_LARGE413由于请求的实体过大，服务器无法处理，因此拒绝请求。
REQ_TOO_LONG414请求的URI过长（URI通常为网址），服务器无法处理。
UNSUPPORTED_TYPE415服务器无法处理请求的格式。
INTERNAL_ERROR500服务器内部错误，无法完成请求。
NOT_IMPLEMENTED501服务器不支持请求的功能，无法完成请求。
BAD_GATEWAY502充当网关或代理的服务器，从远端服务器接收到了一个无效的请求。
UNAVAILABLE503由于超载或系统维护，服务器暂时的无法处理客户端的请求。
GATEWAY_TIMEOUT504充当网关或代理的服务器，未及时从远端服务器获取请求。
VERSION505服务器请求的HTTP协议的版本。HarmonyOS与OpenHarmony鸿蒙文档籽料：mau123789是v直接拿

鸿蒙

HttpResponse

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

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

参数名类型必填说明
resultstringObjectArrayBuffer8+
responseCode[ResponseCode]number是
headerObject是发起http请求返回来的响应头。当前返回的是JSON格式字符串，如需具体字段内容，需开发者自行解析。常见字段及解析方式如下： - Content-Type：header['Content-Type']； - Status-Line：header['Status-Line']； - Date：header.Date/header['Date']； - Server：header.Server/header['Server']；
cookies8+Array是服务器返回的 cookies。

审核编辑 黄宇

打开APP阅读更多精彩内容
声明：本文内容及配图由入驻作者撰写或者入驻合作网站授权转载。文章观点仅代表作者本人，不代表电子发烧友网立场。文章及其配图仅供工程师学习之用，如有内容侵权或者其他违规问题，请联系本站处理。 举报投诉

全部0条评论

快来发表一下你的评论吧 !

下载APP
|投诉反馈|电子发烧友网
© 2021 elecfans.com
湘ICP备2023018690号
×
20
完善资料，
赚取积分