查询重试
当一个 useQuery 查询失败(查询函数抛出错误)时,若该查询请求尚未达到连续重试次数上限(默认为 3 次),或你提供了用于判断是否允许重试的函数,TanStack Query 将自动重试该查询。
你可以在全局层面和单个查询层面分别配置重试行为。
- 将
retry = false设为false将禁用重试。 - 将
retry = 6设为6将在显示查询函数最终抛出的错误前,对失败请求重试 6 次。 - 将
retry = true设为Infinity将无限次重试失败请求。 - 将
retry = (failureCount, error) => ...设为函数可基于请求失败原因实现自定义重试逻辑。注意:对于首次重试尝试,failureCount的值从0开始计数。
在服务端,重试次数默认为
0,以使服务端渲染尽可能快。
TypeScript
1import { useQuery } from '@tanstack/vue-query'2 3// Make a specific query retry a certain number of times4const result = useQuery({5 queryKey: ['todos', 1],6 queryFn: fetchTodoListPage,7 retry: 10, // Will retry failed requests 10 times before displaying an error8})说明:
error属性的内容将在useQuery的failureReason响应属性中持续存在,直至最后一次重试尝试结束。因此,在上述示例中,任何错误内容都会出现在前 9 次重试尝试(总计 10 次尝试)的failureReason属性中;若所有重试均失败,最终错误内容将出现在error属性中。
重试延迟
默认情况下,TanStack Query 的重试不会在请求失败后立即发生。与标准实践一致,每次重试尝试都会逐步应用指数退避延迟。
默认 retryDelay 函数设置为每次尝试将延迟时间翻倍(起始值为 1000ms),但不超过 30 秒:
TypeScript
1import { VueQueryPlugin } from '@tanstack/vue-query'2 3const vueQueryPluginOptions = {4 queryClientConfig: {5 defaultOptions: {6 queries: {7 retryDelay: (attemptIndex) => Math.min(1000 * 2 ** attemptIndex, 30000),8 },9 },10 },11}12app.use(VueQueryPlugin, vueQueryPluginOptions)尽管不推荐,你仍可在插件(Plugin)和单个查询选项中显式覆盖 retryDelay(函数或整数)。若将其设为整数而非函数,则每次重试延迟时间将保持恒定:
TypeScript
1const result = useQuery({2 queryKey: ['todos'],3 queryFn: fetchTodoList,4 retryDelay: 1000, // Will always wait 1000ms to retry, regardless of how many retries5})后台重试行为
当使用 refetchInterval 并启用 refetchIntervalInBackground: true 时,若浏览器标签页处于非活跃状态,重试将暂停。这是因为重试遵循与常规重新拉取(refetch)相同的焦点行为。
若你需要后台持续重试,请考虑禁用重试并实现自定义重新拉取策略:
TypeScript
1const result = useQuery({2 queryKey: ['todos'],3 queryFn: fetchTodos,4 refetchInterval: (query) => {5 // Refetch more frequently when in error state6 return query.state.status === 'error' ? 5000 : 300007 },8 refetchIntervalInBackground: true,9 retry: false, // Disable built-in retries10})该方法让你能手动控制重试时机,同时保持后台重新拉取的活跃状态。