首页
/ 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 设计场景。

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

热门内容推荐

最新内容推荐

项目优选

收起
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
139
1.91 K
kernelkernel
deepin linux kernel
C
22
6
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
192
273
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
923
551
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
421
392
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
145
189
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
74
64
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
344
1.3 K
easy-eseasy-es
Elasticsearch 国内Top1 elasticsearch搜索引擎框架es ORM框架,索引全自动智能托管,如丝般顺滑,与Mybatis-plus一致的API,屏蔽语言差异,开发者只需要会MySQL语法即可完成对Es的相关操作,零额外学习成本.底层采用RestHighLevelClient,兼具低码,易用,易拓展等特性,支持es独有的高亮,权重,分词,Geo,嵌套,父子类型等功能...
Java
36
8