重要默认设置

开箱即用,TanStack Query 的配置是激进但合理的默认值。有时这些默认值可能会让新用户感到意外,或者如果用户不知道这些默认值,可能会使学习/调试变得困难。 在您继续学习和使用 TanStack Query 的过程中,请牢记它们。

  • 通过 useQueryuseInfiniteQuery 的查询实例,默认情况下会认为缓存的数据是过时的

要更改此行为,您可以使用 staleTime 选项全局和按查询进行配置。指定更长的 staleTime 意味着查询不会那么频繁地重新获取其数据。

  • 设置了 staleTime 的查询在 staleTime 过期之前,都将被视为新鲜

    • staleTime 设置为例如 2 * 60 * 1000 毫秒,以确保在 2 分钟内数据可以从缓存中读取,而不会触发任何类型的重新获取,或者直到查询被 手动失效
    • staleTime 设置为 Infinity,直到查询被 手动失效 之前,都不会触发重新获取。
    • staleTime 设置为 'static',即使查询被 手动失效,也永远不会触发重新获取。
  • 过时查询会在以下情况下自动在后台重新获取:

    • 查询的新实例挂载
    • 窗口重新获得焦点
    • 网络重新连接

设置 staleTime 是避免过度重新获取的推荐方法,但您也可以通过设置 refetchOnMountrefetchOnWindowFocusrefetchOnReconnect 等选项来自定义重新获取的时间点。

  • 查询可以选择配置 refetchInterval 来定期触发重新获取,这与 staleTime 设置无关。

  • 不再有 useQueryuseInfiniteQuery 或查询观察者的活动实例的查询结果被标记为“不活动”,并保留在缓存中,以防以后再次使用。

  • 默认情况下,“非活动”查询在 5 分钟后被垃圾回收。

    要更改此行为,您可以将查询的默认 gcTime1000 * 60 * 5 毫秒更改为其他值。

  • 失败的查询会静默重试 3 次,并采用指数退避延迟,然后才会捕获并向 UI 显示错误。

    要更改此行为,您可以将查询的默认 retryretryDelay 选项从 3 次和默认的指数退避函数更改为其他值。

  • 默认情况下,查询结果会结构化共享,以检测数据是否确实已更改,如果未更改,数据引用将保持不变,以更好地支持 useMemo 和 useCallback 的值稳定。如果这个概念对您来说很陌生,请不用担心!99.9% 的情况下您不需要禁用它,它会以零成本使您的应用程序更高效。

    结构化共享仅适用于 JSON 兼容的值,任何其他值类型都将被视为已更改。如果您由于响应过大而遇到性能问题,例如,您可以通过 config.structuralSharing 标志禁用此功能。如果您在查询响应中处理非 JSON 兼容的值,并且仍想检测数据是否已更改,您可以提供自己的自定义函数作为 config.structuralSharing,以根据旧响应和新响应计算值,并根据需要保留引用。