前言:
要使用http请求,需在module.json5文件中添加网络管理权限
"module": {
"requestPermissions" : [
{ "name" : "ohos.permission.INTERNET" }
]
}
一、使用步骤
1、导入http模块
HTTP数据请求功能主要由http模块提供。
import { http } from '@kit.NetworkKit';
接口名 | 描述 |
---|---|
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网络请求数据发送进度事件。 |
2、创建http请求
调用createHttp()方法,创建一个HttpRequest对象。
let httpRequest = http.createHttp();
每一个httpRequest对象对应一个http请求,里面包含request、destory、on和off的方法。
3、发起请求
调用该对象的request()方法,传入http请求的url地址和可选参数,发起网络请求。
let url = "https://EXAMPLE_URL?param1=v1¶m2=v2"
let promise = httpRequest.request( url, {
method: http.RequestMethod.GET,
connectTimeOut: 60000,
readTimeout: 60000,
header: {
'Content-Type' : 'application/json'
}
})
4、处理响应
按照实际业务需要,解析返回结果。
promise.then( (value) => {
if ( value.responseCode === http.Response.OK) {
// value为请求结果
// 包含value.responseCode、value.result、value.resultType、value.header、value.cookies五个字段
}
})
5、销毁http对象
当该请求使用完毕时,调用destroy()方法主动销毁。
httpRequest.destory()
完整代码:
// 引入包名
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();
}
}
);
标签:11,ArkTS,HTTP,请求,---,API,http,data
From: https://blog.csdn.net/sinat_34896766/article/details/141320797