TanStack Query 提供了三种不同的网络模式,用于区分在没有网络连接时,Queries 和 Mutations 应该如何表现。此模式可以为每个 Query / Mutation 单独设置,也可以通过 query / mutation 默认值全局设置。
由于 TanStack Query 最常用于数据获取,并结合数据获取库一起使用,因此默认的网络模式是 online。
在此模式下,除非您有网络连接,否则 Queries 和 Mutations 不会触发。这是默认模式。如果为查询启动了获取,但由于没有网络连接而无法进行获取,它将始终保持其当前的状态(pending, error, success)。但是,还会额外公开一个 fetchStatus。它可以是:
标志 isFetching 和 isPaused 从此状态派生而来,并为了方便而公开。
请记住,仅检查 pending 状态可能不足以显示加载指示器。如果查询首次挂载,并且您没有网络连接,则查询可能处于 state: 'pending',但 fetchStatus: 'paused' 状态。
如果查询因为您在线而运行,但在获取仍在进行时您离线了,TanStack Query 也会暂停重试机制。暂停的查询将在您重新获得网络连接后继续运行。这与 refetchOnReconnect(在此模式下也默认为 true)无关,因为它不是重新获取,而是继续。如果查询在此期间已被取消,它将不会继续。
在此模式下,TanStack Query 将始终获取数据,并忽略在线/离线状态。如果您在不需要活动网络连接即可使 Queries 正常工作的环境中使用 TanStack Query,则这可能是您想要选择的模式 - 例如,如果您只是从 AsyncStorage 读取数据,或者您只想从 queryFn 返回 Promise.resolve(5)。
此模式是前两个选项之间的中间地带,其中 TanStack Query 将运行 queryFn 一次,然后暂停重试。如果您有像 offline-first PWA 中那样拦截请求以进行缓存的 serviceWorker,或者您通过 Cache-Control 标头 使用 HTTP 缓存,这将非常方便。
在这些情况下,第一次获取可能会成功,因为它来自离线存储/缓存。但是,如果发生缓存未命中,网络请求将发出并失败,在这种情况下,此模式的行为类似于 online 查询 - 暂停重试。
如果 Queries 本应获取数据但没有网络连接,则 TanStack Query Devtools 将以 paused 状态显示 Queries。还有一个切换按钮可以模拟离线行为。请注意,此按钮实际上不会干扰您的网络连接(您可以在浏览器开发者工具中执行此操作),但它会将 OnlineManager 设置为离线状态。