首页
/ Orval项目中TanStack Query类型回归问题解析

Orval项目中TanStack Query类型回归问题解析

2025-06-17 03:14:07作者:田桥桑Industrious

背景介绍

在Orval项目的最新版本7.4.0中,开发团队发现了一个与TanStack Query(原React Query)相关的类型系统回归问题。这个问题主要影响了使用select选项进行数据转换时的类型推断。

问题本质

在Orval自动生成的代码中,查询钩子的类型定义存在一个关键缺陷。具体表现为生成的UseQueryOptions类型参数设置不当,导致select函数的返回类型被错误地约束为必须与API原始返回类型一致。

技术细节

Orval生成的代码原本是这样的结构:

export function useControllerGetData<
  TData = Awaited<ReturnType<typeof controllerGetData>>,
  TError = ErrorType<ErrorResponse>,
>(
  id: string,
  options?: {
    query?: Partial<UseQueryOptions<TData, TError, TData>>;
    request?: SecondParameter<typeof orvalHttpClient>;
  },
): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData> }

问题出在UseQueryOptions<TData, TError, TData>的第三个泛型参数上。按照TanStack Query的设计,这三个参数分别代表:

  1. 查询函数返回的数据类型
  2. 错误类型
  3. 最终返回的数据类型(经过select等转换后的类型)

当前的实现错误地将第三个参数也设为TData,这意味着select函数必须返回与API原始响应相同类型的数据,这显然不符合实际使用场景。

实际影响

这种类型限制会导致开发者在使用select进行数据转换时遇到类型错误。例如以下常见用法会报错:

useControllerGetData(mainAssetId, {
  query: {
    select(data) {
      const boolA = data.key_X;
      const boolB = data.key_Y;
      return { boolA, boolB }; // 类型错误,因为要求返回原始API类型
    },
  },
});

解决方案

正确的类型定义应该是:

query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof controllerGetData>>, TError, TData>>;

这样修改后,第一个参数保持为API原始返回类型,而第三个参数则可以自由定义为select转换后的类型,完美支持数据转换场景。

修复过程

Orval团队在7.4.1版本中快速修复了这个问题。修复的关键在于确保生成的代码中UseQueryOptions的三个类型参数正确区分了原始数据类型和转换后数据类型。

经验教训

这个案例提醒我们:

  1. 自动生成代码时,类型系统的精确性至关重要
  2. 需要全面考虑各种使用场景,特别是像select这样的数据转换功能
  3. 完善的测试用例能够帮助及早发现这类问题

总结

Orval作为API客户端代码生成工具,其与TanStack Query的集成需要精确处理类型系统。这次类型回归问题的快速修复展现了团队对类型安全性的重视,也提醒开发者在使用自动生成代码时要注意类型系统的正确性。

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

项目优选

收起
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
149
1.95 K
kernelkernel
deepin linux kernel
C
22
6
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
980
395
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
192
274
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
931
555
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
145
190
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
75
66
openHiTLS-examplesopenHiTLS-examples
本仓将为广大高校开发者提供开源实践和创新开发平台,收集和展示openHiTLS示例代码及创新应用,欢迎大家投稿,让全世界看到您的精巧密码实现设计,也让更多人通过您的优秀成果,理解、喜爱上密码技术。
C
65
518
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
1.11 K
0