进阶 trpc.io 2026-10-12 05:42:24 · 35 阅读
第2章 Express Adapter
版本:10.x Express Adapter
示例应用
描述链接 使用 Node.js 的 Express 服务器与过程调用。CodeSandbox 源码
如何将 tRPC 添加到现有的 Express 项目
1. 安装依赖
bashyarn add @trpc/server zod
bashyarn add @trpc/server zod
Zod 不是必需的依赖,但下面的示例路由中用到了它。
2. 创建 tRPC 路由
实现你的 tRPC 路由。下面是一个示例路由:
server.tstsimport { initTRPC } from '@trpc/server';import { z } from 'zod';export const t = initTRPC.create();export const appRouter = t.router({ getUser: t.procedure.input(z.string()).query((opts) => { opts.input; // string return { id: opts.input, name: 'Bilbo' }; }), createUser: t.procedure .input(z.object({ name: z.string().min(5) })) .mutation(async (opts) => { // use your ORM of choice return await UserModel.create({ data: opts.input, }); }),});// export type definition of APIexport type AppRouter = typeof appRouter;
server.tstsimport { initTRPC } from '@trpc/server';import { z } from 'zod';export const t = initTRPC.create();export const appRouter = t.router({ getUser: t.procedure.input(z.string()).query((opts) => { opts.input; // string return { id: opts.input, name: 'Bilbo' }; }), createUser: t.procedure .input(z.object({ name: z.string().min(5) })) .mutation(async (opts) => { // use your ORM of choice return await UserModel.create({ data: opts.input, }); }),});// export type definition of APIexport type AppRouter = typeof appRouter;
如果路由文件变得太大,可以把路由拆分为多个子路由,分别放在各自的文件中实现,然后将它们合并为一个根 appRouter。
3. 使用 Express adapter
tRPC 内置了 Express adapter,可以把 tRPC 路由转换为 Express 中间件。
server.tstsimport { initTRPC } from '@trpc/server';import * as trpcExpress from '@trpc/server/adapters/express';// created for each requestconst createContext = ({ req, res,}: trpcExpress.CreateExpressContextOptions) => ({}); // no contexttype Context = Awaited>;const t = initTRPC.context().create();const appRouter = t.router({ // [...]});const app = express();app.use( '/trpc', trpcExpress.createExpressMiddleware({ router: appRouter, createContext, }),);app.listen(4000);
server.tstsimport { initTRPC } from '@trpc/server';import * as trpcExpress from '@trpc/server/adapters/express';// created for each requestconst createContext = ({ req, res,}: trpcExpress.CreateExpressContextOptions) => ({}); // no contexttype Context = Awaited>;const t = initTRPC.context().create();const appRouter = t.router({ // [...]});const app = express();app.use( '/trpc', trpcExpress.createExpressMiddleware({ router: appRouter, createContext, }),);app.listen(4000);
现在你的端点已经可以通过 HTTP 访问了!
端点 HTTP URI getUser GET http://localhost:4000/trpc/getUser?input=INPUT
其中 INPUT 是一个经过 URI 编码的 JSON 字符串。执行 createUser 的 POST 请求,目标地址为 http://localhost:4000/trpc/createUser
请求体 req.body 的类型为 {name: string}
其中 INPUT 是一个经过 URI 编码的 JSON 字符串。执行 createUser 的 POST 请求,目标地址为 http://localhost:4000/trpc/createUser
请求体 req.body 的类型为 {name: string}