Angular-Query中injectMutation的类型推断问题解析

在Angular应用中使用TanStack Query（原React Query）的Angular适配器时，开发者可能会遇到一个微妙的类型推断问题。本文将深入分析这个问题，探讨其产生原因，并提供解决方案。

问题现象

当使用injectMutation方法时，如果传递了queryClient参数，会导致onSuccess回调函数中的result参数丢失类型信息，变成unknown类型。而如果不传递queryClient，类型推断则能正常工作。

// 不传递queryClient - 类型推断正常
const foo = injectMutation(() => ({
  mutationFn: () => Promise.resolve({ foo: true }),
  onSuccess: (result) => {
    result.foo; // result正确推断为{ foo: boolean }
  }
}));

// 传递queryClient - 类型推断失效
const bar = injectMutation((queryClient) => ({
  mutationFn: () => Promise.resolve({ bar: true }),
  onSuccess: (result) => {
    result.bar; // result变为unknown
  }
}));

技术背景

这个问题涉及到TypeScript的类型推断机制和泛型参数的传递。在Angular-Query的实现中，injectMutation是一个泛型函数，它需要正确推断出mutationFn返回值的类型，并将这个类型传递给onSuccess回调。

当不传递queryClient时，TypeScript能够直接推断出泛型参数。但当函数参数中包含queryClient时，类型推断链被打断，导致泛型参数无法正确传递。

根本原因

问题的核心在于TypeScript的类型推断机制在处理高阶函数时的局限性。当injectMutation接收一个带参数的回调函数时，TypeScript难以同时推断回调参数的类型和泛型参数的类型。

在底层实现上，MutationOptions类型没有使用NoInfer工具类型来保护泛型参数，导致类型信息在传递过程中丢失。

解决方案

临时解决方案

1. 显式指定类型参数：可以手动指定泛型参数类型

   injectMutation<{bar: boolean}>((queryClient) => ({
     mutationFn: () => Promise.resolve({ bar: true }),
     onSuccess: (result) => {
       result.bar; // 现在类型正确
     }
   }));
   

2. 指定queryClient类型：为queryClient参数添加类型注解

   injectMutation((client: QueryClient) => ({
     mutationFn: () => Promise.resolve({ bar: true }),
     onSuccess: (result) => {
       result.bar; // 类型推断恢复
     }
   }));
   

官方建议

Angular-Query的维护者建议，在即将发布的稳定版本中可能会移除queryClient参数的支持，转而推荐使用Angular的依赖注入系统：

// 新推荐方式
const client = inject(QueryClient);

const mutation = injectMutation(() => ({
  mutationFn: () => Promise.resolve({ bar: true }),
  onSuccess: (result) => {
    result.bar; // 类型推断正常
  }
}));

这种方式更符合Angular的设计理念，同时避免了类型推断问题。

扩展影响

这个问题不仅存在于injectMutation中，在injectQuery的select函数中也有类似表现：

const query = injectQuery((client) => ({
  queryKey: ['key'],
  queryFn: () => Promise.resolve(1),
  select: (data) => data > 1, // data类型可能丢失
}));

最佳实践

1. 优先使用Angular的依赖注入系统获取QueryClient
2. 如果必须使用queryClient参数，考虑显式指定类型
3. 关注Angular-Query的稳定版本发布，及时更新代码

总结

类型推断问题是静态类型系统在复杂场景下的常见挑战。Angular-Query作为连接Angular和TanStack Query的桥梁，需要在Angular的依赖注入系统和React风格API之间找到平衡。理解这些类型问题的本质，有助于开发者编写更健壮的类型安全代码。

随着Angular-Query走向稳定，API设计将更加符合Angular习惯，这类类型问题也会得到更好的解决。开发者应关注官方文档更新，及时调整代码实现方式。