React Query 中全局 Mutation 回调的类型问题解决方案

在使用 React Query 进行数据管理时，开发者经常会遇到需要在 mutation 成功后自动失效相关查询的需求。本文探讨了在全局配置中处理 mutation 回调时遇到的一个 TypeScript 类型问题及其解决方案。

问题背景

在 React Query 的全局配置中，我们可以通过设置 mutationCache 的 onSuccess 回调来实现自动查询失效。一个常见的模式是：

export const queryClient = new QueryClient({
  mutationCache: new MutationCache({
    onSuccess: (_data, _variables, _context, mutation) => {
      // 失效逻辑
    }
  })
})

当开发者尝试在 onSuccess 回调中返回 queryClient.invalidateQueries() 的 Promise 以实现异步失效时，TypeScript 会报出类型错误，提示参数 query 隐式具有 any 类型。

问题分析

这个类型问题的根源在于 TypeScript 无法自动推断出回调函数的返回类型。React Query 的 onSuccess 回调默认不期望有返回值，但当我们需要等待某些查询失效完成时，就需要返回一个 Promise。

解决方案

方案一：显式声明返回类型

最直接的解决方案是为 onSuccess 回调显式声明返回类型为 Promise<void>：

onSuccess: (_data, _variables, _context, mutation): Promise<void> => {
  return queryClient.invalidateQueries({
    predicate: query => 
      mutation.meta?.awaits?.some(queryKey => 
        matchQuery({queryKey}, query)
      ) ?? false
  })
}

这种方式明确告诉 TypeScript 这个回调将返回一个 Promise，解决了类型推断问题。

方案二：显式声明 queryClient 类型

另一种解决方案是在创建 queryClient 时就显式声明其类型：

const queryClient: QueryClient = new QueryClient({
  // 配置
})

这种方式通过确保 queryClient 的类型明确，帮助 TypeScript 更好地进行类型推断。

最佳实践建议

1. 一致性选择：在项目中统一采用一种解决方案，保持代码风格一致
2. 类型安全：推荐使用第一种方案，因为它更精确地描述了回调的行为
3. 文档注释：无论采用哪种方案，都应添加适当的注释说明这种全局失效的意图

扩展思考

这种类型问题在配置复杂的库时很常见。理解 React Query 的类型系统有助于开发者：

• 更自信地编写类型安全的代码
• 在遇到类似问题时能快速定位原因
• 设计出更健壮的全局配置方案

通过解决这个具体问题，开发者可以深入理解 TypeScript 的类型推断机制和 React Query 的类型设计哲学，为处理更复杂的数据管理场景打下基础。