Skip to content

@neosjs/exponential-backoff ​

一个用于对失败操作进行重试的库,采用指数递增的方式控制重试间隔。当达到设定的最大重试次数、或者错误未命中可重试条件时停止重试,支持随机抖动(jitter)打散重试时间。

安装 ​

sh
pnpm add @neosjs/exponential-backoff
sh
npm i @neosjs/exponential-backoff
sh
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初始延迟时间number2000
maxDelay最大延迟时长number60000
factor指数因子number2
jitter是否应用随机抖动booleantrue
maxRetries最大重试次数number10
retryableErrors可重试的错误码any[]见下方默认列表
logger是否打印重试日志,或自定义回调boolean / Functiontrue

retryableErrors 默认值 ​

ts
;[
  'ECONNRESET',
  'ETIMEDOUT',
  'ECONNREFUSED',
  'EPIPE',
  'CONNECTION_CLOSED',
  'ERR_NETWORK',
  429,
  503,
  504
]

TIP

只有在 retryableErrors 列表中的错误才会触发重试,其余错误会立即终止并抛出。