@neosjs/request
发起 HTTP、HTTPS 网络请求,基于 axios 进行的二次封装。在 axios 之上默认集成了缓存 adapter(GET 请求结果缓存、可设过期时间)、重复请求取消(同一请求进行中自动去重)与失败重试(可配次数与间隔),并提供 before / success / fail / complete 生命周期回调,导出 request、requestAll、requestInstance 三个入口。
安装
sh
pnpm add @neosjs/requestsh
npm i @neosjs/requestsh
yarn add @neosjs/requestTIP
当前版本(2.x)为具名导出,请使用 import { request } from '@neosjs/request'。
快速上手
基础使用
ts
import { request } from '@neosjs/request'
// 方式一:传配置对象
request({
url: 'http://api.com',
params: {
user: 1
}
}).then((res) => {
console.log(res)
}).catch((err) => {
console.log(err)
})
// 方式二:url 在前,配置在后
request('http://api.com', {
params: {
user: 1
}
})带生命周期回调
ts
import { request } from '@neosjs/request'
request({
method: 'POST',
url: 'http://api.com',
params: {
user: 1
},
// 发起请求之前的回调函数
before: () => {
console.log('before')
},
// 成功返回的回调函数
success: (res) => {
console.log(res)
},
// 接口调用失败的回调函数
fail: (err) => {
console.log(err)
},
// 接口调用结束的回调函数(调用成功、失败都会执行)
complete: () => {
console.log('complete')
}
})async / await 用法
ts
import { request } from '@neosjs/request'
const res = await request({
url: 'https://api.com',
params: {
id: 1
}
})POST / PUT 请求的参数
对于 POST、PUT 请求,params 会作为请求体 data 发送(而非拼接在 URL 上);当请求头 Content-Type 不是 application/json 时,会自动使用 qs 序列化请求体。
requestAll
并发发起多个请求,等全部完成后按顺序返回结果数组:
ts
import { request, requestAll } from '@neosjs/request'
const res = await requestAll([
request({ url: '/api/a' }), // 请求 1
request({ url: '/api/b' }) // 请求 2
])
console.log(res) // [resA, resB]requestInstance
requestInstance 是底层 axios 实例,用法与 axios 一致:
ts
import { requestInstance } from '@neosjs/request'
const data1 = await requestInstance.get('https://api.com', {
// ...
})
const data2 = await requestInstance.post('https://api.com', {
// ...
})
const data3 = await requestInstance({ url: 'https://api.com' })WARNING
requestInstance 的使用方法同 axios 一致,但 request 扩展的参数(缓存、重试、回调等)可能对 requestInstance 无效。
参数说明
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|---|---|---|---|---|
url | 请求的 api 地址 | string | - | - |
method | 请求类型 | string | POST、GET、DELETE、HEAD、OPTIONS、PUT、PATCH | GET |
dataType | 返回数据类型 | string | - | json |
timeout | 超时时间(ms) | number | - | 5000 |
withCredentials | 是否传递 cookie | boolean | - | false |
params | 请求的参数 | object | - | - |
retry | 重试次数 | number | - | 1 |
retryDelay | 重试间隔时间(ms) | number | - | 2000 |
cache | 是否开启缓存 | boolean | - | false |
cacheMaxAge | 缓存时间(ms) | number | - | 60000 |
forceUpdate | 是否强制更新缓存 | boolean | - | false |
cancelRequest | 是否取消重复请求 | boolean | - | false |
headers | 设置请求的 header | object | - | {'Content-Type': 'application/json'} |
before | 发起请求之前的回调函数 | function | - | null |
after | 请求完成后的回调函数 | function | - | null |
success | 成功返回的回调函数 | function | - | null |
fail | 接口调用失败的回调函数 | function | - | null |
complete | 接口调用结束的回调函数(调用成功、失败都会执行) | function | - | null |
导出清单
| 导出 | 说明 |
|---|---|
request | 主要请求方法,支持 (config) 与 (url, config) 两种传参,返回 PromiseLike<IResponse> |
requestAll | 并发执行多个请求,结果按传入顺序以数组返回 |
requestInstance | 底层 axios 实例,用法同 axios |