译零 TransZero · TanStack Query v4 中文文档
主站

查询重试 Query Retries

当useQuery查询失败(查询函数引发错误)时,如果该查询的请求未达到最大连续重试次数(默认 3 次),或者未提供函数来确定是否允许重试,那么 React Query 将自动重试该查询。

你可以在全局级别或者单个查询级别上配置重试逻辑。

  • 设置retry = false将禁用重试
  • 设置retry = 6该函数抛出最终错误前,将重试 6 次
  • 设置retry = true将无限次重试失败的请求
  • 设置retry =(failureCount,error)=> ...允许基于请求失败的原因进行自定义逻辑
TypeScript
1import { useQuery } from "@tanstack/vue-query";2 3// 对特定的一个查询设置固定的重试次数4const result = useQuery({5  queryKey: ["todos", 1],6  queryFn: fetchTodoListPage,7  retry: 10, // 在显示错误之前,将重试10次8});

重试延迟

默认情况下,React Query 不会在请求失败后立即重试。按照标准,后退延迟将逐渐应用于每次重试。

默认的retryDelay设置为以二的倍数递增(从1000ms开始),但不超过 30 秒:

TypeScript
1// 为所有查询配置2import { VueQueryPlugin } from "@tanstack/vue-query";3 4const vueQueryPluginOptions = {5  queryClientConfig: {6    defaultOptions: {7      queries: {8        retryDelay: (attemptIndex) => Math.min(1000 * 2 ** attemptIndex, 30000),9      },10    },11  },12};13app.use(VueQueryPlugin, vueQueryPluginOptions);

尽管不建议这样做,但是显然你可以在 Provider 和单个查询选项中覆盖retryDelay函数/整数。 如果设置为一个整数而不是函数,则重试之间的延迟将始终是相同的时间量:

TypeScript
1const result = useQuery({2  queryKey: ["todos"],3  queryFn: fetchTodoList,4  retryDelay: 1000, // 无论重试多少次,都会始终等待1000毫秒然后重试5});

本页为 TanStack Query 文档(Vue 版)的非官方中文翻译,原文由上游团队维护,遵循 MIT 许可。 译文如有偏差,以英文原文为准。

本页译文取自社区中文版 react-query-web-i18n(MIT),非本站翻译,已停止更新,内容可能与当前 API 有出入。

译自上游 (未记录版本)