首页
/ React Query Angular 版本中废弃 API 的移除与迁移指南

React Query Angular 版本中废弃 API 的移除与迁移指南

2025-05-01 09:02:10作者:戚魁泉Nursing

在 React Query 的 Angular 版本(angular-query 和 angular-query-experimental)中,开发团队近期完成了一项重要的 API 清理工作。这项变更涉及两个已被标记为废弃的 API 的正式移除,旨在简化 API 表面并提高一致性。

变更背景

随着 React Query 在 Angular 生态中的不断演进,开发团队发现早期设计的一些 API 在命名和使用方式上存在改进空间。特别是以下两个 API:

  1. provideAngularQuery - 这个服务提供函数被更符合命名约定的 provideTanStackQuery 所取代
  2. injectQueryClient - 这个注入函数被更符合 Angular 依赖注入标准的 inject(QueryClient) 所替代

变更细节

1. 服务提供函数的变更

原先的 provideAngularQuery 函数名称包含了特定于 Angular 的标识,这与 TanStack 生态系统的统一命名策略不一致。新的 provideTanStackQuery 名称更好地反映了这个库在整个 TanStack 生态系统中的位置,同时也保持了跨框架的一致性。

2. 查询客户端注入方式的变更

injectQueryClient 作为一个独立的注入函数,与 Angular 的标准依赖注入模式略有不同。新的 inject(QueryClient) 方式完全遵循 Angular 14+ 引入的 inject 函数模式,这使得 API 更加符合 Angular 开发者熟悉的模式,也减少了需要记忆的特殊 API。

迁移指南

对于正在使用这些废弃 API 的项目,迁移非常简单:

  1. 将所有 provideAngularQuery() 的调用替换为 provideTanStackQuery()
  2. 将所有 injectQueryClient() 的调用替换为 inject(QueryClient)

这些变更在功能上是完全等效的,不会引入任何行为变化,仅仅是名称和调用方式的调整。

版本策略

值得注意的是,这项变更只在稳定版本(angular-query)中实施,而实验版本(angular-query-experimental)仍然保留了这些 API。这种策略允许开发者有充足的时间进行迁移,同时确保稳定版本的简洁性和一致性。

最佳实践建议

对于新项目,建议直接使用新的 API 名称。对于现有项目,可以在升级 React Query 版本时一并完成这些简单的替换。由于这些变更不涉及功能变化,迁移风险极低,可以在常规开发过程中逐步完成。

这项清理工作是 React Query 团队持续优化 API 设计的一部分,旨在为开发者提供更一致、更符合框架习惯的开发体验。通过遵循这些简单的迁移步骤,开发者可以确保他们的应用保持最新并获得最佳的支持。

登录后查看全文
热门项目推荐
相关项目推荐