首页
/ ORPC v1.5.0 发布:新增休眠插件与增强 TanStack Query 集成

ORPC v1.5.0 发布:新增休眠插件与增强 TanStack Query 集成

2025-06-24 09:33:30作者:卓炯娓

ORPC 是一个现代化的 RPC 框架,旨在简化远程过程调用的开发体验。它提供了类型安全、插件化架构和与流行前端库的无缝集成。本次 v1.5.0 版本带来了两个重要特性:Hibernation 插件和 TanStack Query 键生成器的类型安全增强。

Hibernation 插件:构建经济高效的 WebSocket 应用

新引入的 Hibernation 插件为 ORPC 框架添加了对休眠 API 的原生支持。这一特性特别适合与 CDN 提供商的 WebSocket Hibernation 功能配合使用,帮助开发者构建可扩展且成本效益高的实时应用。

在传统的 WebSocket 实现中,维持大量连接会消耗大量服务器资源。而休眠 API 允许连接在不活跃时进入休眠状态,显著降低了资源消耗和运营成本。ORPC 的 Hibernation 插件抽象了这些复杂性,让开发者可以专注于业务逻辑。

使用方式非常简单,只需在 RPCHandler 的插件列表中添加 HibernationPlugin 即可:

import { experimental_HibernationPlugin as HibernationPlugin } from '@orpc/server/hibernation'

const handler = new RPCHandler(router, {
  plugins: [
    new HibernationPlugin(),
  ],
})

这个插件特别适合需要处理大量并发连接但每个连接活跃度不高的场景,如实时通知系统、聊天应用或协作编辑工具。通过利用 CDN 的持久化对象和 WebSocket Hibernation,开发者可以用极低的成本构建可扩展的实时应用。

增强 TanStack Query 集成:完全类型安全的键生成

ORPC 进一步提升了与 TanStack Query(原 React Query)的集成体验,现在为查询和变更操作提供了完全类型安全的键生成器。这一改进让开发者在操作缓存数据时能够获得更好的类型提示和安全性。

新版本为每个 ORPC 操作添加了四个键生成方法:

  • .queryKey - 生成标准查询的键
  • .streamedKey - 生成流式查询的键
  • .infiniteKey - 生成无限查询的键
  • .mutationKey - 生成变更操作的键

这些方法都接受与原始操作相同的输入类型,确保键生成与操作调用完全一致。例如:

queryClient.setQueryData(orpc.planet.find.queryKey({ input: { id: 123 } }), (old) => {
  return { ...old, id: 123, name: 'Earth' }
})

这种类型安全的键生成消除了手动输入键字符串时可能出现的拼写错误,也使得重构更加容易。当操作签名发生变化时,TypeScript 会立即在键使用处标记出类型不匹配,大大提高了开发效率和代码质量。

其他改进

本次发布还包含一个重要的错误修复:EventPublisher 现在会在信号中止时立即抛出错误,而不是继续执行。这一改进使得错误处理更加及时和可靠,特别是在需要快速响应取消操作的场景中。

ORPC 持续致力于提供最佳的类型安全和开发者体验。v1.5.0 版本的这些新特性和改进进一步巩固了这一目标,使开发者能够更高效地构建可靠、可维护的分布式应用。

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