首页
/ ORPC v0.41.0 发布:客户端独立化与路径通配符支持

ORPC v0.41.0 发布:客户端独立化与路径通配符支持

2025-06-25 16:06:18作者:羿妍玫Ivan

ORPC(OpenAPI RPC)是一个基于 TypeScript 的 RPC 框架,它通过 OpenAPI 规范实现了类型安全的远程过程调用。该项目旨在简化前后端通信的开发流程,提供强类型约束和优秀的开发体验。

客户端架构重大调整

本次发布的 v0.41.0 版本对 ORPC 的客户端架构进行了重大重构。最核心的变化是将客户端从 @orpc/contract 中完全独立出来,现在 @orpc/client 成为了一个完全自包含的模块,不再依赖 @orpc/server@orpc/contract

这种架构调整带来了几个显著优势:

  1. 客户端可以独立发布和更新,不受服务端约束
  2. 减少了不必要的依赖,降低了包体积
  3. 提高了模块的复用性和灵活性

客户端定义方式变更

随着架构调整,客户端的类型定义方式也发生了变化:

// 旧版方式(已废弃)
const client = createORPCClient<typeof router>(rpcLink)

// 新版推荐方式
const client: RouterClient<typeof router> = createORPCClient(rpcLink)

开发者现在需要显式地声明客户端类型,这虽然增加了一点代码量,但带来了更好的类型提示和代码可读性。类型 RouterClientContractRouterClient 分别从 @orpc/server@orpc/contract 中导入。

路径通配符支持

v0.41.0 引入了 OpenAPI 的保留扩展模式(Reserved Expansion Pattern),允许在路由路径中使用 + 前缀来匹配包含斜杠的剩余路径。这个特性特别适合处理文件路径或复杂的嵌套路由场景。

使用示例

const file = os.route({
  method: 'GET',
  path: '/{+filePath}'  // 可以匹配 /documents/report.pdf 这样的路径
})

在这个例子中,filePath 参数将捕获整个剩余路径部分,包括其中的斜杠。相比传统的路径参数只能匹配单个路径段,这种通配符方式提供了更大的灵活性。

升级建议

对于现有项目升级到 v0.41.0,开发者需要重点关注以下几点:

  1. 修改所有客户端实例的创建方式,使用新的类型声明语法
  2. 检查是否使用了路径参数,考虑是否需要改用通配符模式
  3. 更新相关依赖,确保 @orpc/client 与其他 ORPC 包的版本兼容

这次架构调整虽然带来了破坏性变更,但从长远来看,它使 ORPC 的模块划分更加清晰,为未来的功能扩展奠定了更好的基础。路径通配符的支持也大大增强了路由系统的表达能力,使 ORPC 能够处理更复杂的 API 设计场景。

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

项目优选

收起
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
176
261
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
858
509
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
129
182
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
257
300
ShopXO开源商城ShopXO开源商城
🔥🔥🔥ShopXO企业级免费开源商城系统,可视化DIY拖拽装修、包含PC、H5、多端小程序(微信+支付宝+百度+头条&抖音+QQ+快手)、APP、多仓库、多商户、多门店、IM客服、进销存,遵循MIT开源协议发布、基于ThinkPHP8框架研发
JavaScript
93
15
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
331
1.08 K
HarmonyOS-ExamplesHarmonyOS-Examples
本仓将收集和展示仓颉鸿蒙应用示例代码,欢迎大家投稿,在仓颉鸿蒙社区展现你的妙趣设计!
Cangjie
397
370
note-gennote-gen
一款跨平台的 Markdown AI 笔记软件,致力于使用 AI 建立记录和写作的桥梁。
TSX
83
4
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
1.07 K
0
kernelkernel
deepin linux kernel
C
22
5