路由处理程序

路由处理程序允许您使用 Web 请求和响应 API 为给定的路由创建自定义请求处理程序。

route special file

note

路由处理程序仅在 app 目录内可用。它们相当于页面目录内的 API 路由，这意味着您不需要同时使用 API 路由和路由处理程序。

约定

路由处理程序在 app 目录内的 route.js|ts 文件中定义：

app/api/route.ts

export const dynamic = 'force-dynamic'; // 默认为 auto
export async function GET(request: Request) {}

路由处理程序可以嵌套在 app 目录内，类似于 page.js 和 layout.js。但是，在与 page.js 相同的路由段级别上不能有 route.js 文件。

支持的 HTTP 方法

支持以下 HTTP 方法： GET、POST、PUT、PATCH、DELETE、HEAD 和 OPTIONS。如果调用了不受支持的方法，Next.js 将返回 405 Method Not Allowed 响应。

扩展的 NextRequest 和 NextResponse API

除了支持原生的 Request 和 Response 外，Next.js 还通过 NextRequest 和 NextResponse 对它们进行了扩展，以提供高级用例的便利助手。

行为

缓存

使用 Response 对象的 GET 方法时，路由处理程序默认会进行缓存。

app/items/route.ts

export async function GET() {
  const res = await fetch('https://data.mongodb-api.com/...', {
    headers: {
      'Content-Type': 'application/json',
      'API-Key': process.env.DATA_API_KEY,
    },
  });
  const data = await res.json();

  return Response.json({ data });
}

note

Response.json() 仅在 TypeScript 5.2 及更高版本中有效。如果使用较低版本的 TypeScript，可以使用 NextResponse.json() 代替，以获取类型化的响应。

退出缓存

您可以通过以下方式退出缓存：

使用带有 GET 方法的 Request 对象。
使用任何其他 HTTP 方法。
使用动态函数，如 cookies 和 headers。
通过手动指定动态模式的 Segment Config 选项。

例如：

app/products/api/route.ts

export async function GET(request: Request) {
  const { searchParams } = new URL(request.url);
  const id = searchParams.get('id');
  const res = await fetch(`https://data.mongodb-api.com/product/${id}`, {
    headers: {
      'Content-Type': 'application/json',
      'API-Key': process.env.DATA_API_KEY!,
    },
  });
  const product = await res.json();

  return Response.json({ product });
}

类似地，使用 POST 方法将导致动态评估路由处理程序。

app/items/route.ts

export async function POST() {
  const res = await fetch('https://data.mongodb-api.com/...', {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      'API-Key': process.env.DATA_API_KEY!,
    },
    body: JSON.stringify({ time: new Date().toISOString() }),
  });

  const data = await res.json();

  return Response.json(data);
}

note

与 API 路由一样，路由处理程序可用于处理表单提交等情况。正在开发一个新的用于处理表单和变更的抽象，与 React 深度集成。

路由解析

您可以将路由视为最低级别的route原语。

它们不参与布局或客户端导航，如 page。
在与 page.js 相同的路由上不能有 route.js 文件。

Page	Route	Result
`app/page.js`	`app/route.js`	Conflict
`app/page.js`	`app/api/route.js`	Valid
`app/[user]/page.js`	`app/api/route.js`	Valid

每个route.js 或page.js 文件都会接管该路由的所有HTTP 动词。

app/page.js

export default function Page() {
  return <h1>Hello, Next.js!</h1>;
}

// ❌ 冲突
// `app/route.js`
export async function POST(request) {}

示例

以下示例显示了如何将路由处理程序与其他 Next.js API 和功能结合使用。

重新验证缓存数据

您可以使用 next.revalidate 选项重新验证缓存的数据：

app/items/route.ts

export async function GET() {
  const res = await fetch('https://data.mongodb-api.com/...', {
    next: { revalidate: 60 }, // 每 60 秒重新验证一次
  });
  const data = await res.json();

  return Response.json(data);
}

或者，您可以使用 revalidate 段配置选项：

export const revalidate = 60;

动态函数

路由处理程序可以与 Next.js 的动态函数一起使用，如 cookies 和 headers。

Cookies

您可以使用 next/headers 中的 cookies 读取 cookies。此服务器函数可以直接在路由处理程序中调用，也可以嵌套在另一个函数中。

这个 cookies 实例是只读的。要设置 cookies，您需要使用 Set-Cookie 头返回一个新的 Response。

app/api/route.ts

import { cookies } from 'next/headers';

export async function GET(request: Request) {
  const cookieStore = cookies();
  const token = cookieStore.get('token');

  return new Response('Hello, Next.js!', {
    status: 200,
    headers: { 'Set-Cookie': `token=${token.value}` },
  });
}

或者，您可以使用底层 Web API 上的抽象来读取 cookies （NextRequest）：

app/api/route.ts

import type { NextRequest } from 'next/server';

export async function GET(request: NextRequest) {
  const token = request.cookies.get('token');
}

Headers

您可以使用 next/headers 中的 headers 读取 headers。此服务器函数可以直接在路由处理程序中调用，也可以嵌套在另一个函数中。

这个 headers 实例是只读的。要设置 headers，您需要使用新的 headers 返回一个新的 Response。

app/api/route.ts

import { headers } from 'next/headers';

export async function GET(request: Request) {
  const headersList = headers();
  const referer = headersList.get('referer');

  return new Response('Hello, Next.js!', {
    status: 200,
    headers: { referer: referer },
  });
}

或者，您可以使用底层 Web API 上的抽象来读取 headers （NextRequest）：

app/api/route.ts

import type { NextRequest } from 'next/server';

export async function GET(request: NextRequest) {
  const requestHeaders = new Headers(request.headers);
}

重定向

app/api/route.ts

import { redirect } from 'next/navigation';

export async function GET(request: Request) {
  redirect('https://nextjs.org/');
}

动态路由段

note

我们建议在继续之前阅读定义路由页面。

路由处理程序可以使用动态段创建来自动态数据的请求处理程序。

app/items/[slug]/route.ts

export async function GET(
  request: Request,
  { params }: { params: { slug: string } }
) {
  const slug = params.slug; // 'a', 'b', 或 'c'
}

Route	Example URL	params
`app/items/[slug]/route.js`	`/items/a`	`{ slug: 'a' }`
`app/items/[slug]/route.js`	`/items/b`	`{ slug: 'b' }`
`app/items/[slug]/route.js`	`/items/c`	`{ slug: 'c' }`

URL 查询参数

传递给路由处理程序的请求对象是一个 NextRequest 实例，它具有一些附加的方便方法，包括更轻松地处理查询参数。

app/api/search/route.ts

import type { NextRequest } from 'next/server';

export function GET(request: NextRequest) {
  const searchParams = request.nextUrl.searchParams;
  const query = searchParams.get('query');
  // 对于 /api/search?query=hello，查询是 "hello"
}

流式传输

流式传输通常与大型语言模型（LLM）结合使用，例如 OpenAI，用于生成的 AI 内容。了解有关 AI SDK 的更多信息。

app/api/chat/route.ts

import OpenAI from 'openai';
import { OpenAIStream, StreamingTextResponse } from 'ai';

const openai = new OpenAI({
  apiKey: process.env.OPENAI_API_KEY,
});

export const runtime = 'edge';

export async function POST(req: Request) {
  const { messages } = await req.json();
  const response = await openai.chat.completions.create({
    model: 'gpt-3.5-turbo',
    stream: true,
    messages,
  });

  const stream = OpenAIStream(response);

  return new StreamingTextResponse(stream);
}

这些抽象使用 Web API 创建流。您也可以直接使用底层 Web API。

app/api/route.ts

// https://developer.mozilla.org/docs/Web/API/ReadableStream#convert_async_iterator_to_stream
function iteratorToStream(iterator: any) {
  return new ReadableStream({
    async pull(controller) {
      const { value, done } = await iterator.next();

      if (done) {
        controller.close();
      } else {
        controller.enqueue(value);
      }
    },
  });
}

function sleep(time: number) {
  return new Promise((resolve) => {
    setTimeout(resolve, time);
  });
}

const encoder = new TextEncoder();

async function* makeIterator() {
  yield encoder.encode('<p>One</p>');
  await sleep(200);
  yield encoder.encode('<p>Two</p>');
  await sleep(200);
  yield encoder.encode('<p>Three</p>');
}

export async function GET() {
  const iterator = makeIterator();
  const stream = iteratorToStream(iterator);

  return new Response(stream);
}

请求主体

您可以使用标准的 Web API 方法读取请求主体：

app/items/route.ts

export async function POST(request: Request) {
  const res = await request.json();
  return Response.json({ res });
}

请求主体 FormData

您可以使用 request.formData() 函数读取 FormData：

app/items/route.ts

export async function POST(request: Request) {
  const formData = await request.formData();
  const name = formData.get('name');
  const email = formData.get('email');
  return Response.json({ name, email });
}

由于 formData 数据都是字符串，您可能希望使用 zod-form-data 来验证请求并以您喜欢的格式检索数据（例如，number）。

CORS

您可以使用标准的 Web API 方法在 Response 上设置 CORS 头：

app/api/route.ts

export const dynamic = 'force-dynamic'; // 默认为 auto

export async function GET(request: Request) {
  return new Response('Hello, Next.js!', {
    status: 200,
    headers: {
      'Access-Control-Allow-Origin': '*',
      'Access-Control-Allow-Methods': 'GET, POST, PUT, DELETE, OPTIONS',
      'Access-Control-Allow-Headers': 'Content-Type, Authorization',
    },
  });
}

Edge 和 Node.js 运行时

路由处理程序具有同构的 Web API，以无缝支持 Edge 和 Node.js 运行时，包括对流的支持。由于路由处理程序使用与页面和布局相同的路由段配置，因此它们支持期待已久的通用静态重新生成路由处理程序的功能。

您可以使用 runtime 段配置选项指定运行时：

export const runtime = 'edge'; // 'nodejs' 是默认值

非 UI 响应

您可以使用路由处理程序返回非 UI 内容。请注意，sitemap.xml、robots.txt、app icons和开放图像都具有内置支持。

app/rss.xml/route.ts

export const dynamic = 'force-dynamic'; // 默认为 auto

export async function GET() {
  return new Response(`<?xml version="1.0" encoding="UTF-8" ?>
<rss version="2.0">

<channel>
  <title>Next.js Documentation</title>
  <link>https://nextjs.org/docs</link>
  <description>The React Framework for the Web</description>
</channel>

</rss>`);
}

段配置选项

路由处理程序使用与页面和布局相同的路由段配置。

app/items/route.ts

export const dynamic = 'auto';
export const dynamicParams = true;
export const revalidate = false;
export const fetchCache = 'auto';
export const runtime = 'nodejs';
export const preferredRegion = 'auto';

有关更多详细信息，请参阅 API 参考。

路由处理程序

约定​

支持的 HTTP 方法​

扩展的 NextRequest 和 NextResponse API​

行为​

缓存​

退出缓存​

路由解析​

示例​

重新验证缓存数据​

动态函数​

Cookies​

Headers​

重定向​

动态路由段​

URL 查询参数​

流式传输​

请求主体​

请求主体 FormData​

CORS​

Edge 和 Node.js 运行时​

非 UI 响应​

段配置选项​

约定

支持的 HTTP 方法

扩展的 NextRequest 和 NextResponse API

行为

缓存

退出缓存

路由解析

示例

重新验证缓存数据

动态函数

Cookies

Headers

重定向

动态路由段

URL 查询参数

流式传输

请求主体

请求主体 FormData

CORS

Edge 和 Node.js 运行时

非 UI 响应

段配置选项