鸿蒙开发(NEXT/API 12)【HTTP数据请求】网络篇

场景介绍

应用通过HTTP发起一个数据请求,支持常见的GET、POST、OPTIONS、HEAD、PUT、DELETE、TRACE、CONNECT方法。

接口说明

HTTP数据请求功能主要由http模块提供。

使用该功能需要申请ohos.permission.INTERNET权限。

接口名 描述
createHttp() 创建一个http请求。
request() 根据URL地址,发起HTTP网络请求。
requestInStream()10+ 根据URL地址,发起HTTP网络请求并返回流式响应。
destroy() 中断请求任务。
on(type: 'headersReceive') 订阅HTTP Response Header 事件。
off(type: 'headersReceive') 取消订阅HTTP Response Header 事件。
once('headersReceive')8+ 订阅HTTP Response Header 事件,但是只触发一次。
on('dataReceive')10+ 订阅HTTP流式响应数据接收事件。
off('dataReceive')10+ 取消订阅HTTP流式响应数据接收事件。
on('dataEnd')10+ 订阅HTTP流式响应数据接收完毕事件。
off('dataEnd')10+ 取消订阅HTTP流式响应数据接收完毕事件。
on('dataReceiveProgress')10+ 订阅HTTP流式响应数据接收进度事件。
off('dataReceiveProgress')10+ 取消订阅HTTP流式响应数据接收进度事件。
on('dataSendProgress')11+ 订阅HTTP网络请求数据发送进度事件。
off('dataSendProgress')11+ 取消订阅HTTP网络请求数据发送进度事件。

request接口开发步骤

  1. 从@kit.NetworkKit中导入http命名空间。

  2. 调用createHttp()方法,创建一个HttpRequest对象。

  3. 调用该对象的on()方法,订阅http响应头事件,此接口会比request请求先返回。可以根据业务需要订阅此消息。

  4. 调用该对象的request()方法,传入http请求的url地址和可选参数,发起网络请求。

  5. 按照实际业务需要,解析返回结果。

  6. 调用该对象的off()方法,取消订阅http响应头事件。

  7. 当该请求使用完毕时,调用destroy()方法主动销毁。

    // 引入包名
    import { http } from '@kit.NetworkKit';
    import { BusinessError } from '@kit.BasicServicesKit';

    // 每一个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 to send",
    expectDataType: http.HttpDataType.STRING, // 可选,指定返回数据的类型
    usingCache: true, // 可选,默认为true
    priority: 1, // 可选,默认为1
    connectTimeout: 60000, // 可选,默认为60000ms
    readTimeout: 60000, // 可选,默认为60000ms
    usingProtocol: http.HttpProtocol.HTTP1_1, // 可选,协议类型默认值由系统自动指定
    usingProxy: false, // 可选,默认不使用网络代理,自API 10开始支持该属性
    caPath:'/path/to/cacert.pem', // 可选,默认使用系统预制证书,自API 10开始支持该属性
    clientCert: { // 可选,默认不使用客户端证书,自API 11开始支持该属性
    certPath: '/path/to/client.pem', // 默认不使用客户端证书,自API 11开始支持该属性
    keyPath: '/path/to/client.key', // 若证书包含Key信息,传入空字符串,自API 11开始支持该属性
    certType: http.CertType.PEM, // 可选,默认使用PEM,自API 11开始支持该属性
    keyPassword: "passwordToKey" // 可选,输入key文件的密码,自API 11开始支持该属性
    },
    multiFormDataList: [ // 可选,仅当Header中,'content-Type'为'multipart/form-data'时生效,自API 11开始支持该属性
    {
    name: "Part1", // 数据名,自API 11开始支持该属性
    contentType: 'text/plain', // 数据类型,自API 11开始支持该属性
    data: 'Example data', // 可选,数据内容,自API 11开始支持该属性
    remoteFileName: 'example.txt' // 可选,自API 11开始支持该属性
    }, {
    name: "Part2", // 数据名,自API 11开始支持该属性
    contentType: 'text/plain', // 数据类型,自API 11开始支持该属性
    // data/app/el2/100/base/com.example.myapplication/haps/entry/files/fileName.txt
    filePath: ${getContext(this).filesDir}/fileName.txt, // 可选,传入文件路径,自API 11开始支持该属性
    remoteFileName: 'fileName.txt' // 可选,自API 11开始支持该属性
    }
    ]
    }, (err: BusinessError, data: http.HttpResponse) => {
    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+
    // 当该请求使用完毕时,调用destroy方法主动销毁
    httpRequest.destroy();
    } else {
    console.error('error:' + JSON.stringify(err));
    // 取消订阅HTTP响应头事件
    httpRequest.off('headersReceive');
    // 当该请求使用完毕时,调用destroy方法主动销毁
    httpRequest.destroy();
    }
    }
    );

requestInStream接口开发步骤

  1. 从@kit.NetworkKit中导入http命名空间。

  2. 调用createHttp()方法,创建一个HttpRequest对象。

  3. 调用该对象的on()方法,可以根据业务需要订阅HTTP响应头事件、HTTP流式响应数据接收事件、HTTP流式响应数据接收进度事件和HTTP流式响应数据接收完毕事件。

  4. 调用该对象的requestInStream()方法,传入http请求的url地址和可选参数,发起网络请求。

  5. 按照实际业务需要,可以解析返回的响应码。

  6. 调用该对象的off()方法,取消订阅响应事件。

  7. 当该请求使用完毕时,调用destroy()方法主动销毁。

    // 引入包名
    import { http } from '@kit.NetworkKit';
    import { BusinessError } from '@kit.BasicServicesKit';

    // 每一个httpRequest对应一个HTTP请求任务,不可复用
    let httpRequest = http.createHttp();
    // 用于订阅HTTP响应头事件
    httpRequest.on('headersReceive', (header: Object) => {
    console.info('header: ' + JSON.stringify(header));
    });
    // 用于订阅HTTP流式响应数据接收事件
    let res = new ArrayBuffer(0);
    httpRequest.on('dataReceive', (data: ArrayBuffer) => {
    const newRes = new ArrayBuffer(res.byteLength + data.byteLength);
    const resView = new Uint8Array(newRes);
    resView.set(new Uint8Array(res));
    resView.set(new Uint8Array(data), res.byteLength);
    res = newRes;
    console.info('res length: ' + res.byteLength);
    });
    // 用于订阅HTTP流式响应数据接收完毕事件
    httpRequest.on('dataEnd', () => {
    console.info('No more data in response, data receive end');
    });
    // 用于订阅HTTP流式响应数据接收进度事件
    class Data {
    receiveSize: number = 0;
    totalSize: number = 0;
    }
    httpRequest.on('dataReceiveProgress', (data: Data) => {
    console.log("dataReceiveProgress receiveSize:" + data.receiveSize + ", totalSize:" + data.totalSize);
    });

    let streamInfo: http.HttpRequestOptions = {
    method: http.RequestMethod.POST, // 可选,默认为http.RequestMethod.GET
    // 开发者根据自身业务需要添加header字段
    header: {
    'Content-Type': 'application/json'
    },
    // 当使用POST请求时此字段用于传递请求体内容,具体格式与服务端协商确定
    extraData: "data to send",
    expectDataType: http.HttpDataType.STRING,// 可选,指定返回数据的类型
    usingCache: true, // 可选,默认为true
    priority: 1, // 可选,默认为1
    connectTimeout: 60000, // 可选,默认为60000ms
    readTimeout: 60000, // 可选,默认为60000ms。若传输的数据较大,需要较长的时间,建议增大该参数以保证数据传输正常终止
    usingProtocol: http.HttpProtocol.HTTP1_1 // 可选,协议类型默认值由系统自动指定
    }

    // 填写HTTP请求的URL地址,可以带参数也可以不带参数。URL地址需要开发者自定义。请求的参数可以在extraData中指定
    httpRequest.requestInStream("EXAMPLE_URL", streamInfo).then((data: number) => {
    console.info("requestInStream OK!");
    console.info('ResponseCode :' + JSON.stringify(data));
    // 取消订阅HTTP响应头事件
    httpRequest.off('headersReceive');
    // 取消订阅HTTP流式响应数据接收事件
    httpRequest.off('dataReceive');
    // 取消订阅HTTP流式响应数据接收进度事件
    httpRequest.off('dataReceiveProgress');
    // 取消订阅HTTP流式响应数据接收完毕事件
    httpRequest.off('dataEnd');
    // 当该请求使用完毕时,调用destroy方法主动销毁
    httpRequest.destroy();
    }).catch((err: Error) => {
    console.info("requestInStream ERROR : err = " + JSON.stringify(err));
    });

最后呢

很多开发朋友不知道需要学习那些鸿蒙技术?鸿蒙开发岗位需要掌握那些核心技术点?为此鸿蒙的开发学习必须要系统性的进行。

而网上有关鸿蒙的开发资料非常的少,假如你想学好鸿蒙的应用开发与系统底层开发。你可以参考这份资料,少走很多弯路,节省没必要的麻烦。由两位前阿里高级研发工程师联合打造的《鸿蒙NEXT星河版OpenHarmony开发文档 》里面内容包含了(ArkTS、ArkUI开发组件、Stage模型、多端部署、分布式应用开发、音频、视频、WebGL、OpenHarmony多媒体技术、Napi组件、OpenHarmony内核、Harmony南向开发、鸿蒙项目实战等等)鸿蒙(Harmony NEXT)技术知识点

如果你是一名Android、Java、前端等等开发人员,想要转入鸿蒙方向发展。可以直接领取这份资料辅助你的学习。下面是鸿蒙开发的学习路线图。

针对鸿蒙成长路线打造的鸿蒙学习文档。话不多说,我们直接看详细鸿蒙(OpenHarmony )手册(共计1236页)与鸿蒙(OpenHarmony )开发入门视频,帮助大家在技术的道路上更进一步。

  • 《鸿蒙 (OpenHarmony)开发学习视频》
  • 《鸿蒙生态应用开发V2.0白皮书》
  • 《鸿蒙 (OpenHarmony)开发基础到实战手册》
  • OpenHarmony北向、南向开发环境搭建
  • 《鸿蒙开发基础》
  • 《鸿蒙开发进阶》
  • 《鸿蒙开发实战》

总结

鸿蒙---作为国家主力推送的国产操作系统。部分的高校已经取消了安卓课程,从而开设鸿蒙课程;企业纷纷跟进启动了鸿蒙研发。

并且鸿蒙是完全具备无与伦比的机遇和潜力的;预计到年底将有 5,000 款的应用完成原生鸿蒙开发,未来将会支持 50 万款的应用。那么这么多的应用需要开发,也就意味着需要有更多的鸿蒙人才。鸿蒙开发工程师也将会迎来爆发式的增长,学习鸿蒙势在必行! 自↓↓↓拿

相关推荐
m0_629958347 分钟前
TCP编程-socket(套接字)编程实战1
网络·网络协议·tcp/ip
lqqjuly1 小时前
深度学习基础知识-残差网络ResNet
网络·人工智能·深度学习
瑕、疵1 小时前
全面解析:网络协议及其应用
网络·网络协议
技术小赵1 小时前
外贸独立站的四大引流推广策略
大数据·网络·经验分享
gengjianchun2 小时前
clickhouse 安装配置
服务器·网络·clickhouse
螺蛳粉只吃炸蛋的走风2 小时前
网络编程IO多路复用之poll模式
网络·c++·面试·poll·阻塞与非阻塞
重生之我是数学王子3 小时前
网络编程 UDP编程 Linux环境 C语言实现
linux·c语言·开发语言·网络·网络协议·udp
明月看潮生3 小时前
青少年编程与数学 02-003 Go语言网络编程 10课题、HTTP/HTTPS协议
网络·青少年编程·golang·编程与数学