进阶 trpc.io 2026-10-12 05:42:24 · 31 阅读

第11章 tRPC 的 Next.js 适配器

版本:11.x Next.js Adapter tRPC 对 Next.js 的支持远不止是一个适配器。本页简要概述了适配器的配置方法。如需完整文档,请参阅 Next.js 集成指南。 示例应用

描述 链接 Next.js 极简示例 CodeSandbox 源码

Next.js 示例

在 Next.js 项目中托管 tRPC router 非常简单。只需在 pages/api/trpc/[trpc].ts 中创建一个 API handler,示例如下:

pages/api/trpc/[trpc].ts ```ts import { createNextApiHandler } from '@trpc/server/adapters/next'; import { createContext } from '../../../server/trpc/context'; import { appRouter } from '../../../server/trpc/router/_app';

export default createNextApiHandler({ router: appRouter, createContext, }); ```

处理 CORS 及其他高级用法

通常情况下,你可以“设置并遗忘”上述 API handler,但有时你可能需要进一步修改它。

通过 createNextApiHandler 创建的 API handler(以及其他框架中的等价物)只是一个接收 req 和 res 对象的函数。这意味着你也可以在将这两个对象传递给 handler 之前对其进行修改,例如启用 CORS。

pages/api/trpc/[trpc].ts ```ts import type { NextApiRequest, NextApiResponse } from 'next'; import { createNextApiHandler } from '@trpc/server/adapters/next'; import { createContext } from '../../../server/trpc/context'; import { appRouter } from '../../../server/trpc/router/_app';

// 创建 API handler,但先不返回 const nextApiHandler = createNextApiHandler({ router: appRouter, createContext, });

// https://nextjs.org/docs/api-routes/introduction export default async function handler( req: NextApiRequest, res: NextApiResponse, ) { // 我们可以使用 response 对象来启用 CORS res.setHeader('Access-Control-Allow-Origin', '*'); res.setHeader('Access-Control-Request-Method', '*'); res.setHeader('Access-Control-Allow-Methods', 'OPTIONS, GET'); res.setHeader('Access-Control-Allow-Headers', '*');

// 如果需要发起带认证的 CORS 请求, // 请删除上述代码并取消注释下方代码

// Allow-Origin 必须设置为想要回传凭据的发起方域名 // res.setHeader('Access-Control-Allow-Origin', 'http://example:6006'); // res.setHeader('Access-Control-Request-Method', '*'); // res.setHeader('Access-Control-Allow-Methods', 'OPTIONS, GET'); // res.setHeader('Access-Control-Allow-Headers', 'content-type'); // res.setHeader('Referrer-Policy', 'no-referrer'); // res.setHeader('Access-Control-Allow-Credentials', 'true');

if (req.method === 'OPTIONS') { res.writeHead(200); return res.end(); }

// 最后将请求传递给 tRPC handler return nextApiHandler(req, res); } ```

App Router (Route Handlers)

如果你使用的是 Next.js App Router,请使用 fetch adapter,因为 App Router 的路由 handler 基于 Web 标准的 Request 和 Response 对象。完整的配置步骤请参考 App Router 配置指南。

app/api/trpc/[trpc]/route.ts ```ts import { fetchRequestHandler } from '@trpc/server/adapters/fetch'; import { createTRPCContext } from '../../trpc/init'; import { appRouter } from '../../trpc/routers/_app';

const handler = (req: Request) => fetchRequestHandler({ endpoint: '/api/trpc', req, router: appRouter, createContext: createTRPCContext, });

export { handler as GET, handler as POST }; ```

评论 (0)