查询重试 | TanStack Query Solid Docs

查询重试

当 useQuery 查询失败时（查询函数抛出错误），如果该查询的请求尚未达到连续重试的最大次数（默认为 3 次）或者提供了确定是否允许重试的函数，TanStack Query 将自动重试该查询。

您可以在全局级别和单个查询级别配置重试。

设置 retry = false 将禁用重试。
设置 retry = 6 将在显示函数抛出的最终错误之前重试失败的请求 6 次。
设置 retry = true 将无限次重试失败的请求。
设置 retry = (failureCount, error) => ... 允许根据请求失败的原因自定义逻辑。

在服务器上，重试默认为 0，以使服务器端渲染尽可能快。

tsx

import { useQuery } from '@tanstack/solid-query'

// 对特定查询进行一定次数的重试
const result = useQuery(() => {
  queryKey: ['todos', 1],
  queryFn: fetchTodoListPage,
  retry: 10, // 将在显示错误之前重试失败的请求 10 次
})

import { useQuery } from '@tanstack/solid-query'

// 对特定查询进行一定次数的重试
const result = useQuery(() => {
  queryKey: ['todos', 1],
  queryFn: fetchTodoListPage,
  retry: 10, // 将在显示错误之前重试失败的请求 10 次
})

信息：error 属性的内容将成为 useQuery 的 failureReason 响应属性的一部分，直到最后一次重试尝试。因此，在上面的示例中，任何错误内容都将成为前 9 次重试尝试（总共 10 次尝试）的 failureReason 属性的一部分，最后，如果在所有重试尝试后错误仍然存在，它们将成为 error 的一部分。

重试延迟

默认情况下，TanStack Query 中的重试不会在请求失败后立即发生。按照标准，每次重试尝试都会逐渐应用退避延迟。

默认的 retryDelay 设置为每次尝试加倍（从 1000 毫秒开始），但不会超过 30 秒：

tsx

// 为所有查询配置
import {
  QueryCache,
  QueryClient,
  QueryClientProvider,
} from '@tanstack/solid-query'

const queryClient = new QueryClient({
  defaultOptions: {
    queries: {
      retryDelay: (attemptIndex) => Math.min(1000 * 2 ** attemptIndex, 30000),
    },
  },
})

function App() {
  return <QueryClientProvider client={queryClient}>...</QueryClientProvider>
}

// 为所有查询配置
import {
  QueryCache,
  QueryClient,
  QueryClientProvider,
} from '@tanstack/solid-query'

const queryClient = new QueryClient({
  defaultOptions: {
    queries: {
      retryDelay: (attemptIndex) => Math.min(1000 * 2 ** attemptIndex, 30000),
    },
  },
})

function App() {
  return <QueryClientProvider client={queryClient}>...</QueryClientProvider>
}

虽然不建议这样做，但您显然可以在提供程序和单个查询选项中覆盖 retryDelay 函数/整数。如果设置为整数而不是函数，则延迟将始终是相同的时间量：

tsx

const result = useQuery(() => {
  queryKey: ['todos'],
  queryFn: fetchTodoList,
  retryDelay: 1000, // 无论重试多少次，都将始终等待 1000 毫秒再重试
})

const result = useQuery(() => {
  queryKey: ['todos'],
  queryFn: fetchTodoList,
  retryDelay: 1000, // 无论重试多少次，都将始终等待 1000 毫秒再重试
})