第5章 Next.js 适配器:在 Next.js 中集成 tRPC
版本:10.x
Next.js 适配器 tRPC 对 Next.js 的支持远不止一个适配器那么简单。本页简要介绍了配置方法,完整文档请查阅此处。
示例应用
| 描述 | 链接 | Next.js 极简入门 | CodeSandbox | 源码 |
Next.js 示例
在 Next.js 项目中提供 tRPC 路由十分简单。只需按照以下示例创建 pages/api/trpc/[trpc].ts API 处理器:
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';
// @link https://nextjs.org/docs/api-routes/introduction export default createNextApiHandler({ router: appRouter, createContext, }); ```
处理 CORS 及其他高级用法
虽然通常可以像上面那样配置 API 处理器后就“一劳永逸”,但有时你可能希望进一步修改它。
由 createNextApiHandler 和其他框架的等价方法创建的 API 处理器只是一个接收 req 和 res 对象的函数。这意味着你可以根据需要修改这些对象后再传递给处理器,例如启用 CORS。
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';
// 创建 API 处理器,但暂时不返回 const nextApiHandler = createNextApiHandler({ router: appRouter, createContext, });
// @link https://nextjs.org/docs/api-routes/introduction export default async function handler( req: NextApiRequest, res: NextApiResponse, ) { // 利用响应对象启用 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 请求 // 请删除上述代码并取消注释下方代码 // Access-Control-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 处理器 return nextApiHandler(req, res); } ```
路由处理器
如果你正在使用 Next.js App Router 并想用路由处理器,可以改用 fetch 适配器,因为它基于 Web 标准的 Request 和 Response 对象:
app/api/trpc/[trpc]/route.ts
```ts import { fetchRequestHandler } from '@trpc/server/adapters/fetch'; import { appRouter } from '~/server/api/router';
const handler = (req: Request) => fetchRequestHandler({ endpoint: '/api/trpc', req, router: appRouter, createContext: () => ({ ... }) });
export { handler as GET, handler as POST }; ```