@neosjs/exponential-backoff
一个用于对失败操作进行重试的库,采用指数递增的方式控制重试间隔。当达到设定的最大重试次数、或者错误未命中可重试条件时停止重试,支持随机抖动(jitter)打散重试时间。
安装
sh
pnpm add @neosjs/exponential-backoffsh
npm i @neosjs/exponential-backoffsh
yarn add @neosjs/exponential-backoff快速上手
全局配置
在实例化时传入配置,之后所有 execute 都复用该配置:
ts
import Backoff from '@neosjs/exponential-backoff'
const backoff = new Backoff({
initialDelay: 2000,
maxDelay: 60000,
factor: 2,
jitter: true,
maxRetries: 5,
retryableErrors: ['ECONNRESET', 'ECONNREFUSED'],
logger: true
})
async function fetchData() {
// ...
}
backoff.execute(fetchData)
.then((res: any) => {
console.log(res)
})
.catch((err: any) => {
console.log(err)
})局部配置
在 execute 的第二个参数传入配置,仅对当前这次执行有效,覆盖全局配置:
ts
import Backoff from '@neosjs/exponential-backoff'
const backoff = new Backoff()
async function fetchData() {
// ...
}
backoff.execute(fetchData, {
initialDelay: 2000,
maxDelay: 60000,
factor: 2,
jitter: true,
maxRetries: 5,
retryableErrors: ['ECONNRESET', 'ECONNREFUSED']
})自定义日志回调
logger 也可以传函数,自行处理重试日志:
ts
backoff.execute(fetchData, {
initialDelay: 2000,
maxDelay: 60000,
factor: 2,
jitter: true,
maxRetries: 5,
logger: (msg) => {
// ...
}
})配置参数
| 参数 | 描述 | 类型 | 默认值 |
|---|---|---|---|
initialDelay | 初始延迟时间 | number | 2000 |
maxDelay | 最大延迟时长 | number | 60000 |
factor | 指数因子 | number | 2 |
jitter | 是否应用随机抖动 | boolean | true |
maxRetries | 最大重试次数 | number | 10 |
retryableErrors | 可重试的错误码 | any[] | 见下方默认列表 |
logger | 是否打印重试日志,或自定义回调 | boolean / Function | true |
retryableErrors 默认值
ts
;[
'ECONNRESET',
'ETIMEDOUT',
'ECONNREFUSED',
'EPIPE',
'CONNECTION_CLOSED',
'ERR_NETWORK',
429,
503,
504
]TIP
只有在 retryableErrors 列表中的错误才会触发重试,其余错误会立即终止并抛出。