tRPC 是一个用于构建端到端类型安全 API 的 TypeScript 框架。资料强调其无需 schema 或代码生成,依靠 TypeScript 类型推断即可让客户端获得服务端的完整类型信息,并提供自动补全与类型安全。
主要能力:
- 路由与过程:通过 initTRPC.create() 创建路由器与 publicProcedure,定义 query(获取数据)、mutation(创建/更新/删除)和 subscription(实时更新)过程;支持嵌套路由与路由合并。
- 输入校验:集成 zod,对输入进行基础与复杂校验,并支持可复用 schema(omit、partial 等)。
- 上下文:通过 createContext 注入 session、db 等依赖,并在过程中通过 ctx 访问。
- 中间件:可创建日志中间件、认证中间件(isAuthed)与基于角色的中间件(requireRole),并组合出 publicProcedure、protectedProcedure、adminProcedure。
- 客户端使用:配合 @tanstack/react-query,使用 useQuery、useMutation、useInfiniteQuery,支持禁用查询、轮询、乐观更新、错误处理与缓存失效。
- 服务端调用:通过 createCallerFactory 创建 caller,在 Server Components 中直接调用过程。
- 高级模式:请求批处理(httpBatchLink)、请求去重(React Query 自动处理)、自定义请求头、错误格式化与 TRPCError 错误码。
使用方式:资料给出 Next.js App Router 的完整示例:安装 @trpc/server@next、@trpc/client@next、@trpc/react-query@next 及 @tanstack/react-query、zod;创建 server/trpc.ts、定义 appRouter、创建 app/api/trpc/[trpc]/route.ts 的 fetch 适配器、设置客户端 Provider、创建 tRPC React 客户端并在组件中使用。
适用场景:Next.js、React 等 TypeScript 项目需要类型安全 API 层时;需要输入校验、认证与角色控制、乐观更新、无限滚动、请求批处理等场景。
限制:资料未提供关于性能、兼容性版本范围、非 TypeScript 环境支持、收费或价格等信息,暂未提供。