首页
/ ORPC v0.37.0 发布:无限查询优化与OpenAPI规范增强

ORPC v0.37.0 发布:无限查询优化与OpenAPI规范增强

2025-06-25 07:49:24作者:龚格成

ORPC(OpenRPC)是一个现代化的RPC框架,专注于为TypeScript开发者提供类型安全、高性能的远程过程调用解决方案。最新发布的v0.37.0版本带来了两项重要改进:无限查询功能的优化重构和OpenAPI规范的自定义能力增强。

无限查询功能重构

在数据分页场景中,无限查询(Infinite Query)是一种常见需求。v0.37.0对.infiniteOptions输入进行了重大重构,使其更加灵活和类型安全。

改进前的问题

旧版本要求输入必须匹配{ cursor?: any }结构,这种设计存在两个主要限制:

  1. 类型约束不够严格,cursor可以是任意类型
  2. 输入结构固定,不够灵活

新版本解决方案

现在.infiniteOptions接受一个函数作为输入,开发者可以完全控制cursor的位置和类型:

const listQuery = useInfiniteQuery(
  orpc.planet.list.infiniteOptions({
    input: cursor => ({ cursor }),  // 显式定义cursor位置
    getNextPageParam: lastPage => (lastPage.at(-1)?.id ?? -1) + 1,
    initialPageParam: 0,
  }),
)

这种改进带来了以下优势:

  • 更精确的类型推断
  • 更好的灵活性,可以适应各种分页参数结构
  • 更清晰的代码表达意图

OpenAPI规范增强

ORPC v0.37.0引入了.spec辅助工具,使开发者能够精细控制生成的OpenAPI规范。

基本用法

.spec可以附加到中间件或错误定义上,自动将元数据合并到生成的OpenAPI规范中。

中间件安全配置示例

import { oo } from '@orpc/openapi'

const authMid = oo.spec(
  os.middleware(({ context, path, next }, input) => {
    // 认证逻辑
    return next()
  }),
  {
    security: [{ bearerAuth: [] }],  // 自动添加到OpenAPI
  },
)

错误元数据附加示例

const base = os.errors({
  UNAUTHORIZED: oo.spec({}, {
    security: [{ bearerAuth: [] }],  // 错误关联的安全要求
  }),
})

技术价值

这一改进使得:

  1. API文档与实现保持严格同步
  2. 安全要求等元数据可以集中定义
  3. 减少了样板代码,提高了开发效率

性能优化

v0.37.0还包含了一个重要的性能优化:当RPC输入/输出为undefined时,现在会使用空body,减少了不必要的网络传输。

升级建议

对于现有项目升级到v0.37.0,需要注意:

  1. 检查所有使用.infiniteOptions的地方,按照新API进行调整
  2. 考虑使用新的.spec功能来增强API文档
  3. 性能优化是透明的,无需额外修改

ORPC持续演进的设计理念使其在保持轻量级的同时,提供了企业级的功能和灵活性。v0.37.0的这些改进进一步巩固了其在TypeScript RPC框架中的地位。

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