框架
版本

重要默认设置

TanStack Query 开箱即用,配置了激进但合理的默认值。有时这些默认值可能会让新用户措手不及,或者如果用户不了解它们,可能会使学习/调试变得困难。请在您继续学习和使用 TanStack Query 时牢记它们。

  • 通过 useQueryuseInfiniteQuery 的查询实例默认将缓存数据视为过时数据

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

  • 设置了 staleTime 的查询在 staleTime 过去之前被认为是新鲜的

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

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

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

  • 查询可以选择配置一个 refetchInterval 以定期触发重新获取,这独立于 staleTime 设置。

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

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

    要更改此设置,您可以将查询的默认 gcTime 更改为 1000 * 60 * 5 毫秒以外的值。

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

    要更改此设置,您可以将查询的默认 retryretryDelay 选项更改为 3 和默认指数退避函数以外的值。

  • 查询结果默认情况下会进行结构共享以检测数据是否实际已更改,如果未更改,则数据引用保持不变,以更好地帮助 useMemouseCallback 的值稳定。如果这个概念听起来陌生,那么不用担心!99.9% 的情况下您不需要禁用它,它可以在零成本的情况下提高您的应用程序性能。

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

延伸阅读

请查看我们社区资源中的以下文章,以获取有关默认值的进一步解释: