TanStack Router 中 router.invalidate() 数据不刷新的问题解析

问题背景

在使用 TanStack Router（原 React Router）与 React Query 配合开发时，开发者可能会遇到一个常见问题：在执行数据变更操作（mutation）后调用 router.invalidate() 方法，却发现页面数据并未按预期刷新。这种情况通常发生在通过 loader 加载数据的场景中。

问题复现

让我们来看一个典型的问题场景：

1. 路由配置中使用了 loader 来预加载数据
2. 组件中执行了数据变更操作（如创建、更新、删除）
3. 在 mutation 的 onSuccess 回调中调用了 router.invalidate()
4. 发现页面数据并未更新

问题分析

根本原因

问题的核心在于对 TanStack Router 和 React Query 协同工作机制的理解不足。router.invalidate() 方法确实会重新执行路由的 loader 函数，但这并不意味着它会自动触发 React Query 的重新获取数据。

在示例代码中，loader 函数内部使用了 queryClient.ensureQueryData() 方法，这个方法会检查缓存中是否已有数据，如果有则直接返回缓存数据，而不会强制重新获取。

解决方案对比

开发者最初尝试的解决方案是在 mutation 成功后：

1. 调用 queryClient.invalidateQueries()
2. 调用 router.invalidate()

但发现这并不总是有效。最终找到的正确方案是使用 queryClient.refetchQueries() 方法，这会强制重新获取指定查询的数据。

最佳实践

推荐解决方案

在 mutation 成功后，应该采用以下步骤确保数据刷新：

onSuccess: async () => {
  // 先使相关查询失效
  await queryClient.invalidateQueries({ queryKey: ['keys'] });
  // 强制重新获取数据
  await queryClient.refetchQueries({ queryKey: ['keys'] });
  // 可选：重新执行路由loader
  await router.invalidate();
}

技术原理

1. invalidateQueries：将查询标记为过时，但不会立即重新获取
2. refetchQueries：立即强制重新获取数据
3. router.invalidate：重新执行路由loader，但要注意loader内部的实现

深入理解

缓存机制

React Query 的缓存策略是导致这种现象的根本原因。ensureQueryData 方法优先使用缓存数据，而 invalidateQueries 只是标记数据为过时，并不保证立即重新获取。

性能考量

虽然 refetchQueries 能解决问题，但需要考虑性能影响。在数据变更不频繁的场景下，这种方案是可接受的。对于高频变更场景，可能需要考虑其他优化策略。

总结

在 TanStack Router 和 React Query 的配合使用中，理解两者的数据流和缓存机制至关重要。当遇到数据不刷新的问题时，开发者应该：

1. 明确区分数据失效和重新获取的概念
2. 根据场景选择合适的刷新策略
3. 必要时使用 refetchQueries 强制刷新
4. 注意 loader 函数内部的数据获取逻辑

通过正确理解和使用这些API，可以确保应用中的数据始终保持最新状态。