ToB企服应用市场:ToB评测及商务社交产业平台
标题:
鸿蒙开辟实战：网络哀求库【axios】
[打印本页]
作者:
诗林
时间:
2024-6-22 13:00
标题:
鸿蒙开辟实战：网络哀求库【axios】
简介
[Axios] ，是一个基于 promise 的网络哀求库，可以运行 node.js 和浏览器中。本库基于[Axios]原库v1.3.4版本举行适配，使其可以运行在 OpenHarmony，并沿用其现有用法和特性。
http 哀求
Promise API
request 和 response 拦截器
转换 request 和 response 的 data 数据
自动转换 JSON data 数据
下载安装
ohpm install @ohos/axios
复制代码
必要权限
ohos.permission.INTERNET
复制代码
接口和属性列表
接口列表
接口
参数功能axios(config)[config]：哀求设置发送哀求axios.create(config)[config]：哀求设置创建实例axios.request(config)[config]：哀求设置发送哀求axios.get(url[, config])url：哀求地点 [config]：哀求设置发送get哀求axios.delete(url[, config])url：哀求地点 [config]：哀求设置发送delete哀求axios.post(url[, data[, config]])url：哀求地点 data：发送哀求体数据 [config]：哀求设置发送post哀求axios.put(url[, data[, config]])url：哀求地点 data：发送哀求体数据 [config]：哀求设置发送put哀求 属性列表
属性
描述axios.defaults[‘xxx’]默认设置 。值为哀求设置 [config] 中的设置项 例如 axios.defaults.headers 获取头部信息axios.interceptors拦截器。参考 [拦截器] 的利用
利用示例
利用前在demo中entry–>src–>main–>ets–>common–>Common.ets文件中改为正确的服务器地点，在entry–>src–>main–>resources–>rawfile目录下添加正确的证书，才可正常的利用demo。
发起一个 GET 哀求
axios支持泛型参数，由于ArkTS不再支持any类型，需指定参数的具体类型。 如：axios.get<T = any, R = AxiosResponse, D = any>(url)
T: 是相应数据类型。当发送一个 POST 哀求时，客户端可能会收到一个 JSON 对象。T 就是这个 JSON 对象的类型。默认情况下，T 是 any，这意味着可以吸收任何类型的数据。
R: 是相应体的类型。当服务器返回一个相应时，相应体通常是一个 JSON 对象。R 就是这个 JSON 对象的类型。默认情况下，R 是 AxiosResponse，这意味着相应体是一个 AxiosResponse 对象，它的 data 属性是 T 类型的
D: 是哀求参数的类型。当发送一个 GET 哀求时，可能会在 URL 中添加一些查询参数。D 就是这些查询参数的类型。参数为空情况下，D 是 null类型。
import axios from '@ohos/axios'
interface userInfo{
id: number
name: string,
phone: number
}
// 向给定ID的用户发起请求
axios.get<userInfo, AxiosResponse<userInfo>, null>('/user?ID=12345')
.then((response: AxiosResponse<userInfo>)=> {
// 处理成功情况
console.info("id" + response.data.id)
console.info(JSON.stringify(response));
})
.catch((error: AxiosError)=> {
// 处理错误情况
console.info(JSON.stringify(error));
})
.then(()=> {
// 总是会执行
});
// 上述请求也可以按以下方式完成（可选）
axios.get<userInfo, AxiosResponse<userInfo>, null>('/user', {
params: {
ID: 12345
}
})
.then((response:AxiosResponse<userInfo>) => {
console.info("id" + response.data.id)
console.info(JSON.stringify(response));
})
.catch((error:AxiosError) => {
console.info(JSON.stringify(error));
})
.then(() => {
// 总是会执行
});
// 支持async/await用法
async function getUser() {
try {
const response:AxiosResponse = await axios.get<string, AxiosResponse<string>, null>(this.getUrl);
console.log(JSON.stringify(response));
} catch (error) {
console.error(JSON.stringify(error));
}
}
复制代码
发送一个 POST 哀求
interface user {
firstName: string,
lastName: string
}
axios.post<string, AxiosResponse<string>, user>('/user', {
firstName: 'Fred',
lastName: 'Flintstone'
})
.then((response: AxiosResponse<string>) => {
console.info(JSON.stringify(response));
})
.catch((error) => {
console.info(JSON.stringify(error));
});
复制代码
发起多个并发哀求
const getUserAccount = ():Promise<AxiosResponse> => {
return axios.get<string, AxiosResponse<string>, null>('/user/12345');
}
const getUserPermissions = ():Promise<AxiosResponse> => {
return axios.get<string, AxiosResponse<string>, null>('/user/12345/permissions');
}
Promise.all<AxiosResponse>([getUserAccount(), getUserPermissions()])
.then((results:AxiosResponse[]) => {
const acct = results[0].data as string;
const perm = results[1].data as string;
});
复制代码
利用说明
axios API
通过向 axios 通报干系设置来创建哀求
axios(config)
// 发送一个get请求
axios<string, AxiosResponse<string>, null>({
method: "get",
url: 'https://www.xxx.com/info'
}).then((res: AxiosResponse) => {
console.info('result:' + JSON.stringify(res.data));
}).catch((error: AxiosError) => {
console.error(error.message);
})
复制代码
axios(url[, config])
// 发送一个get请求（默认请求方式）
axios.get<string, AxiosResponse<string>, null>('https://www.xxx.com/info', { params: { key: "value" } })
.then((response: AxiosResponse) => {
console.info("result:" + JSON.stringify(response.data));
})
.catch((error: AxiosError) => {
console.error("result:" + error.message);
});
复制代码
哀求方法的 别名方式 来创建哀求
为方便起见，为全部支持的哀求方法提供了别名。
axios.request(config)
axios.get(url[, config])
axios.delete(url[, config])
axios.post(url[, data[, config]])
axios.put(url[, data[, config]])
留意: 在利用别名方法时， url、method、data 这些属性都不必在设置中指定。
// 发送get请求
axios.get<string, AxiosResponse<string>, null>('https://www.xxx.com/info', { params: { key: "value" } })
.then((response: AxiosResponse) => {
console.info("result:" + JSON.stringify(response.data));
})
.catch((error: AxiosError) => {
console.error("result:" + error.message);
});
复制代码
axios 实例
创建一个实例
您可以利用自定义设置新建一个实例。
axios.create([config])
const instance = axios.create({
baseURL: 'https://www.xxx.com/info',
timeout: 1000,
headers: {'X-Custom-Header': 'foobar'}
});
复制代码
实例方法
axios#request(config)
axios#get(url[, config])
axios#delete(url[, config])
axios#post(url[, data[, config]])
axios#put(url[, data[, config]])
)哀求设置
这些是创建哀求时可以用的设置选项。只有 url 是必需的。如果没有指定 method，哀求将默认利用 get 方法。
{
// `url` 是用于请求的服务器 URL
url: '/user',
// `method` 是创建请求时使用的方法 支持post/get/put/delete方法，不区分大小写，默认为get方法
method: 'get', // default
// `baseURL` 将自动加在 `url` 前面，除非 `url` 是一个绝对 URL。
// 它可以通过设置一个 `baseURL` 便于为 axios 实例的方法传递相对 URL
baseURL: 'https://www.xxx.com/info',
// `transformRequest` 允许在向服务器发送前，修改请求数据
// 它只能用于 'PUT', 'POST' 和 'PATCH' 这几个请求方法
// 数组中最后一个函数必须返回一个字符串， 一个Buffer实例，ArrayBuffer，FormData，或 Stream
// 你可以修改请求头。
transformRequest: [function (data, headers) {
// 对发送的 data 进行任意转换处理
return data;
}],
// `transformResponse` 在传递给 then/catch 前，允许修改响应数据
transformResponse: [function (data) {
// 对接收的 data 进行任意转换处理
return data;
}],
// `headers` 是即将被发送的自定义请求头
headers: {'Content-Type': 'application/json'},
// `params` 是即将与请求一起发送的 URL 参数
// 必须是一个无格式对象(plain object)，其他对象如 URLSearchParams ，必须使用 paramsSerializer 进行序列化
params: {
ID: 12345
},
// `paramsSerializer` 是一个负责 `params` 序列化的函数
paramsSerializer: function(params) {
return params
},
// `data` 是作为请求主体被发送的数据
// 只适用于这些请求方法 'PUT', 'POST', 和 'PATCH'
// 在没有设置 `transformRequest` 时，必须是以下类型之一，其他类型使用 transformRequest 转换处理
// - string, plain object, ArrayBuffer
data: {
firstName: 'Fred'
},
// 发送请求体数据的可选语法
// 请求方式 post
// 只有 value 会被发送，key 则不会
data: 'Country=Brasil&City=Belo Horizonte',
// `timeout` 指定请求超时的毫秒数(0 表示无超时时间)
// 如果请求超过 `timeout` 的时间，请求将被中断
timeout: 1000,
// `adapter` 允许自定义处理请求，这使测试更加容易。
// 返回一个 promise 并提供一个有效的响应 （参见 lib/adapters/README.md）。
adapter: function (config) {
/* ... */
},
// 如果设置了此参数，系统将使用用户指定路径的CA证书，(开发者需保证该路径下CA证书的可访问性)，否则将使用系统预设CA证书，系统预设CA证书位置：/etc/ssl/certs/cacert.pem。证书路径为沙箱映射路径（开发者可通过Global.getContext().filesDir获取应用沙箱路径）。
caPath: '',
// 客户端证书的clientCert字段，包括4个属性：
// 客户端证书（cert）、客户端证书类型（certType）、证书私钥（key）和密码短语（keyPasswd）。
clientCert:{
certPath: '', // 客户端证书路径
certType: '', // 客户端证书类型，包括pem、der、p12三种
keyPath: '', // 证书私钥路径
keyPasswd: '' // 密码短语
}
// 优先级，范围[1,1000]，默认是1，值越大，优先级越高；
priority: 1,
// `responseType` 指定返回数据的类型，默认无此字段。如果设置了此参数，系统将优先返回指定的类型。
// 选项包括: string:字符串类型; object:对象类型; array_buffer:二进制数组类型。
responseType: 'string',
// `proxy`
// 是否使用HTTP代理，默认为false，不使用代理。
// 当proxy为AxiosProxyConfig类型时，使用指定网络代理。
proxy: {
host: 'xx', // Host port
port: xx, // Host port
exclusionList: [] // Do not use a blocking list for proxy servers
}
// `onUploadProgress` 允许为上传处理进度事件
onUploadProgress: function (progressEvent) {
// 对原生进度事件的处理
},
// `onDownloadProgress` 允许为下载处理进度事件，下载文件必须设置该事件
onDownloadProgress: function (progressEvent) {
// 对原生进度事件的处理
},
// 基于应用程序的上下文，只适用于上传/下载请求
context: context,
// 下载路径。此参数，只适用于下载请求，
// Stage模型下使用AbilityContext 类获取文件路径，比如：'${getContext(this).cacheDir}/test.txt’并将文件存储在此路径下
filePath: context,
}
复制代码
相应布局
一个哀求的相应包含以下信息。
{
// `data` 由服务器提供的响应
data: {},
// `status` 来自服务器响应的 HTTP 状态码
status: 200,
// `statusText` 来自服务器响应的 HTTP 状态信息
statusText: 'OK',
// `headers` 是服务器响应头
// 所有的 header 名称都是小写，而且可以使用方括号语法访问
// 例如: `response.headers['content-type']`
headers: {},
// `config` 是 `axios` 请求的配置信息
config: {},
// `request` 是生成此响应的请求
request: {}
}
复制代码
当利用 then 时，您将吸收如下相应:
axios.get<string, AxiosResponse<string>, null>(this.getUrl)
.then( (response:AxiosResponse<string>)=> {
console.log("result data: " + response.data);
console.log("result status: " + response.status);
console.log("result statusText: " + response.statusText);
console.log("result headers: " + response.headers);
console.log("result config: " + response.config);
});
复制代码
默认设置
您可以指定默认设置，它将作用于每个哀求。
全局 axios 默认值
axios.defaults.baseURL = 'https://www.xxx.com';
axios.defaults.headers.common['Authorization'] = AUTH_TOKEN;
axios.defaults.headers.post['Content-Type'] = 'application/x-www-form-urlencoded';
复制代码
自定义实例默认值
// 创建实例时配置默认值
const instance = axios.create({
baseURL: 'https://www.xxx.com'
});
// 创建实例后修改默认值
instance.defaults.headers.common['Authorization'] = AUTH_TOKEN;
复制代码
设置的优先级 设置将会按优先级举行归并。它的次序是：在lib/defaults.js中找到的库默认值，然后是实例的 defaults 属性，最后是哀求的 config 参数。背面的优先级要高于前面的。下面有一个例子。
// 使用库提供的默认配置创建实例
// 此时超时配置的默认值是 `0`
const instance = axios.create();
// 重写库的超时默认值
// 现在，所有使用此实例的请求都将等待2.5秒，然后才会超时
instance.defaults.timeout = 2500;
// 重写此请求的超时时间，因为该请求需要很长时间
instance.get<string, AxiosResponse<string>, null>(this.getUrl, {
timeout: 5000
})
复制代码
拦截器
在哀求或相应被 then 或 catch 处理前拦截它们。
// 添加请求拦截器
axios.interceptors.request.use((config:InternalAxiosRequestConfig) => {
// 对请求数据做点什么
return config;
}, (error:AxiosError) => {
// 对请求错误做些什么
return Promise.reject(error);
});
// 添加响应拦截器
axios.interceptors.response.use((response:AxiosResponse)=> {
// 对响应数据做点什么
return response;
}, (error:AxiosError)=> {
// 对响应错误做点什么
return Promise.reject(error);
});
复制代码
移除拦截器
const myInterceptor = axios.interceptors.request.use((response: AxiosResponse)=> {/*...*/});
axios.interceptors.request.eject(myInterceptor);
复制代码
可以给自定义的 axios 实例添加拦截器
const instance = axios.create();
instance.interceptors.request.use((config:InternalAxiosRequestConfig)=> {/*...*/});
复制代码
指定返回数据的类型
responseType 指定返回数据的类型，默认无此字段。如果设置了此参数，系统将优先返回指定的类型。 选项包括: string:字符串类型; object:对象类型; array_buffer:二进制数组类型。 设置responseType后，response.data中的数据将为指定类型
axios<string, AxiosResponse<string>, null>({
url: 'https://www.xxx.com/info',
method: 'get',
responseType: 'array_buffer',
}).then((res: AxiosResponse) => {
// 处理请求成功的逻辑
})
复制代码
留意：也可以通过重写transformResponse方法，修改返回数据；
axios<string, AxiosResponse<string>, null>({
url: 'https://www.xxx.com/info',
method: 'get',
responseType: 'array_buffer',
transformResponse:(data)=>{
return data
}
}).then((res: AxiosResponse) => {
// 处理请求成功的逻辑
})
复制代码
自定义ca证书
axios<infoModel, AxiosResponse<infoModel>, null>({
url: 'https://www.xxx.com/xx',
method: 'get',
caPath: '', //ca证书路径
}).then((res: AxiosResponse) => {
//
}).catch((err: AxiosError) => {
//
})
复制代码
自定义客户端证书
axios<infoModel, AxiosResponse<infoModel>, null>({
url: 'https://www.xxx.com/xx',
method: 'get',
caPath: '', //ca证书路径
clientCert: {
certPath: '', //客户端证书路径
certType: 'p12', // 客户端证书类型，包括pem、der、p12三种
keyPath: '', //客户端私钥路径
keyPasswd: '' // 密码
}
}).then((res: AxiosResponse) => {
//
}).catch((err: AxiosError) => {
//
})
复制代码
设置代理
axios<string, AxiosResponse<string>, null>({
url: 'xxx',
method: 'get',
proxy:{
host: 'xxx',
port: xx,
exclusionList: []
}
}).then((res: AxiosResponse) => {
//
}).catch((err: AxiosError) => {
//
})
复制代码
证书锁定
证书锁定的用法如下：
必要在设置文件中对证书举行干系信息的设置：设置文件路径为：entry/src/main/resources/base/profile/network_config.json
设置文件：network_config
{
"network-security-config": {
"domain-config": [
{
"domains": [
{
"include-subdomains": true,
"name": "x.x.x.x" // ip地址或域名
}
],
"pin-set": {
"expiration": "2024-8-6", //证书锁定的有效期
"pin": [
{
"digest-algorithm": "sha256", //消息摘要的哈希算法，支持格式是sha256
"digest": "WAFcHG6pAINrztx343ccddfzLOdfoDS9pPgMv2XHk=" //消息摘要
}
]
}
}
]
}
}
复制代码
digest字段消息摘要获取
利用openssl从服务器获取证书，并提取出消息摘要
openssl s_client -connect host:port 2>&1 < /dev/null \
| sed -n '/-----BEGIN/,/-----END/p' \
| openssl x509 -noout -pubkey \
| openssl pkey -pubin -outform der \
| openssl dgst -sha256 -binary \
| openssl enc -base64
复制代码
上传下载文件
上传文件示例
上传文件必要单独导入FormData模块
当前版本只支持 Stage 模型
上传类型支持uri和ArrayBuffer，uri支持“internal”协议类型，仅支持"internal"协议类型，"internal://cache/"为必填字段，示例： internal://cache/path/to/file.txt
哀求的表单数据值为string类型
当上传的内容为ArrayBuffer时，用法如下
import axios from '@ohos/axios'
import { FormData } from '@ohos/axios'
import fs from '@ohos.file.fs';
// ArrayBuffer
let formData = new FormData()
let cacheDir = getContext(this).cacheDir
try {
// 写入
let path = cacheDir + '/hello.txt';
let file = fs.openSync(path, fs.OpenMode.CREATE | fs.OpenMode.READ_WRITE)
fs.writeSync(file.fd, "hello, world"); // 以同步方法将数据写入文件
fs.fsyncSync(file.fd); // 以同步方法同步文件数据。
fs.closeSync(file.fd);
// 读取
let file2 = fs.openSync(path, 0o2);
let stat = fs.lstatSync(path);
let buf2 = new ArrayBuffer(stat.size);
fs.readSync(file2.fd, buf2); // 以同步方法从流文件读取数据。
fs.fsyncSync(file2.fd);
fs.closeSync(file2.fd);
formData.append('file', buf2);
} catch (err) {
console.info('err:' + JSON.stringify(err));
}
// 发送请求
axios.post<string, AxiosResponse<string>, FormData>(this.uploadUrl, formData, {
headers: { 'Content-Type': 'multipart/form-data' },
context: getContext(this),
onUploadProgress: (progressEvent: AxiosProgressEvent): void => {
console.info(progressEvent && progressEvent.loaded && progressEvent.total ? Math.ceil(progressEvent.loaded / progressEvent.total * 100) + '%' : '0%');
},
}).then((res: AxiosResponse) => {
console.info("result" + JSON.stringify(res.data));
}).catch((error: AxiosError) => {
console.error("error:" + JSON.stringify(error));
})
复制代码
当上传的uri时，用法如下
import axios from '@ohos/axios'
import { FormData } from '@ohos/axios'
let formData = new FormData()
formData.append('file', 'internal://cache/blue.jpg')
// 发送请求
axios.post<string, AxiosResponse<string>, FormData>('https://www.xxx.com/upload', formData, {
headers: { 'Content-Type': 'multipart/form-data' },
context: getContext(this),
onUploadProgress: (progressEvent: AxiosProgressEvent): void => {
console.info(progressEvent && progressEvent.loaded && progressEvent.total ? Math.ceil(progressEvent.loaded / progressEvent.total * 100) + '%' : '0%');
},
}).then((res: AxiosResponse<string>) => {
console.info("result" + JSON.stringify(res.data));
}).catch((err: AxiosError) => {
console.error("error:" + JSON.stringify(err));
})
复制代码
下载文件示例
设置下载路径filePath（默认在’internal://cache/'路径下）。
关于filePath
filePath:‘workspace/test.txt’：默认路径下创建workspace路径，并将文件存储在workspace路径下。
filePath:‘test.txt’：将文件存储在默认路径下。
filePath:‘workspace/’：默认路径下创建workspace路径，并将文件存储在workspace路径下。
当前版本只支持 Stage 模型 下载文件时，如果filePath已存在该文件则下载失败，下载之前必要先删除文件。
let filePath = getContext(this).cacheDir + '/blue.jpg'
// 下载。如果文件已存在，则先删除文件。
try {
fs.accessSync(filePath);
fs.unlinkSync(filePath);
} catch(err) {}
axios({
url: 'https://www.xxx.com/blue.jpg',
method: 'get',
context: getContext(this),
filePath: filePath ,
onDownloadProgress: (progressEvent: AxiosProgressEvent): void => {
console.info("progress: " + progressEvent && progressEvent.loaded && progressEvent.total ? Math.ceil(progressEvent.loaded / progressEvent.total * 100) : 0)
}
}).then((res)=>{
console.info("result: " + JSON.stringify(res.data));
}).catch((error)=>{
console.error("error:" + JSON.stringify(error));
})
复制代码
错误处理
错误处理示例代码
axios.get<string, AxiosResponse<string>, null>('/user/12345')
.catch((error:AxiosError)=> {
console.log(JSON.stringify(error.message));
console.log(JSON.stringify(error.code));
console.log(JSON.stringify(error.config));
});
复制代码
错误码
网络哀求非常时，catch方法吸收到非常，非常错误码 [请点击检察]
错误常量
名称参数类型可读可写说明NETWORK_MOBILEnumber是否利用蜂窝网络时允许下载的位标志。NETWORK_WIFInumber是否利用WLAN时允许下载的位标志。ERROR_CANNOT_RESUME7+number是否某些临时错误导致的恢复下载失败。ERROR_DEVICE_NOT_FOUND7+number是否找不到SD卡等存储装备。ERROR_FILE_ALREADY_EXISTS7+number是否要下载的文件已存在，下载会话不能覆盖现有文件。ERROR_FILE_ERROR7+number是否文件操作失败。ERROR_HTTP_DATA_ERROR7+number是否HTTP传输失败。ERROR_INSUFFICIENT_SPACE7+number是否存储空间不足。ERROR_TOO_MANY_REDIRECTS7+number是否网络重定向过多导致的错误。ERROR_UNHANDLED_HTTP_CODE7+number是否无法识别的HTTP代码。ERROR_UNKNOWN7+number是否未知错误。PAUSED_QUEUED_FOR_WIFI7+number是否下载被暂停并等候WLAN毗连，因为文件巨细凌驾了利用蜂窝网络的会话允许的最大值。PAUSED_UNKNOWN7+number是否未知原因导致暂停下载。PAUSED_WAITING_FOR_NETWORK7+number是否由于网络题目（例如网络断开）而暂停下载。PAUSED_WAITING_TO_RETRY7+number是否发生网络错误，将重试下载会话。SESSION_FAILED7+number是否下载会话已失败，将不会重试。SESSION_PAUSED7+number是否下载会话已暂停。SESSION_PENDING7+number是否正在调理下载会话。SESSION_RUNNING7+number是否下载会话正在举行中。SESSION_SUCCESSFUL7+number是否下载会话已完成。
鸿蒙开辟知识更新在gitee.com/li-shizhen-skin/harmony-os/blob/master/README.md前去参考。
约束与限制
在下述版本验证通过： DevEco Studio: 4.1 Canary2(4.1.3.325), SDK: API11(4.1.0.36)
留意：除双向证书验证及证书锁定功能必须利用API11外，其余功能支持API9、API10
FAQ
服务器返回多个cookie，response.header中只能读取首个cookie。
由于该库底层依靠ohos.net.http模块，ohos.net.http也存在此题目，204.1.0.33 镜像版本已修复此题目。
免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。
欢迎光临 ToB企服应用市场:ToB评测及商务社交产业平台 (https://dis.qidao123.com/)
Powered by Discuz! X3.4
