路由处理器 (Route Handlers)

路由处理器 (Route Handlers) 允许您使用 Web Request 和 Response API 为指定路由创建自定义请求处理器。

须知：路由处理器仅在 app 目录内可用。它们等同于 pages 目录中的 API 路由，这意味着您不需要同时使用 API 路由和路由处理器。

约定

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

export async function GET(request: Request) {}

路由处理器可以像 page.js 和 layout.js 一样嵌套在 app 目录的任何位置。但在与 page.js 相同的路由层级不能存在 route.js 文件。

支持的 HTTP 方法

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

扩展的 `NextRequest` 和 `NextResponse` API

除了支持原生的 Request 和 Response API 外，Next.js 还通过 NextRequest 和 NextResponse 对其进行了扩展，为高级用例提供了便捷的帮助方法。

行为

缓存

默认情况下，路由处理器不会被缓存。但是，您可以选择为 GET 方法启用缓存。其他支持的 HTTP 方法不会被缓存。要缓存 GET 方法，请在路由处理器文件中使用路由配置选项，例如 export const dynamic = 'force-static'。

export const dynamic = 'force-static'

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 })
}

须知：其他支持的 HTTP 方法不会被缓存，即使它们与已缓存的 GET 方法位于同一文件中。

特殊路由处理器

特殊路由处理器如 sitemap.ts、opengraph-image.tsx 和 icon.tsx，以及其他元数据文件默认保持静态，除非它们使用了动态 API 或动态配置选项。

路由解析

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

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

页面	路由	结果
`app/page.js`	`app/route.js`	冲突
`app/page.js`	`app/api/route.js`	有效
`app/[user]/page.js`	`app/api/route.js`	有效

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

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

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

示例

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

重新验证缓存数据

您可以使用增量静态再生 (ISR) 重新验证缓存数据：

export const revalidate = 60

export async function GET() {
  const data = await fetch('https://api.vercel.app/blog')
  const posts = await data.json()

  return Response.json(posts)
}

Cookies

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

或者，您可以使用 Set-Cookie 标头返回一个新的 Response。

import { cookies } from 'next/headers'

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

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

您还可以使用底层的 Web API 从请求 (NextRequest) 中读取 cookie：

import { type NextRequest } from 'next/server'

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

标头

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

这个 headers 实例是只读的。要设置标头，您需要返回一个带有新 headers 的新 Response。

import { headers } from 'next/headers'

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

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

您还可以使用底层的 Web API 从请求 (NextRequest) 中读取标头：

import { type NextRequest } from 'next/server'

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

重定向

import { redirect } from 'next/navigation'

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

动态路由段

路由处理器可以使用动态段从动态数据创建请求处理器。

export async function GET(
  request: Request,
  { params }: { params: Promise<{ slug: string }> }
) {
  const { slug } = await params // 'a'、'b' 或 'c'
}

路由	示例 URL	`params`
`app/items/[slug]/route.js`	`/items/a`	`Promise<{ slug: 'a' }>`
`app/items/[slug]/route.js`	`/items/b`	`Promise<{ slug: 'b' }>`
`app/items/[slug]/route.js`	`/items/c`	`Promise<{ slug: 'c' }>`

URL 查询参数

传递给路由处理器的请求对象是一个 NextRequest 实例，它包含一些额外的便捷方法，例如用于更轻松地处理查询参数的方法。

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，query 是 "hello"
}

流式传输

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

import { openai } from '@ai-sdk/openai'
import { StreamingTextResponse, streamText } from 'ai'

export async function POST(req: Request) {
  const { messages } = await req.json()
  const result = await streamText({
    model: openai('gpt-4-turbo'),
    messages,
  })

  return new StreamingTextResponse(result.toAIStream())
}

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

// 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 方法读取 Request 体：

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

请求体 FormData

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

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 方法为特定路由处理器设置 CORS 标头：

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',
    },
  })
}

须知：

要为多个路由处理器添加 CORS 标头，您可以使用中间件或 next.config.js 文件。

或者，查看我们的 CORS 示例包。

Webhooks (网络钩子)

您可以使用路由处理器 (Route Handler) 来接收来自第三方服务的 webhooks (网络钩子)：

export async function POST(request: Request) {
  try {
    const text = await request.text()
    // 处理 webhook 有效载荷
  } catch (error) {
    return new Response(`Webhook error: ${error.message}`, {
      status: 400,
    })
  }

  return new Response('Success!', {
    status: 200,
  })
}

值得注意的是，与使用页面路由 (Pages Router) 的 API 路由不同，您无需使用 bodyParser 或进行任何额外配置。

非 UI 响应

您可以使用路由处理器 (Route Handler) 返回非 UI 内容。请注意 sitemap.xml、robots.txt、应用图标 和开放图谱图片都内置了支持。

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>`,
    {
      headers: {
        'Content-Type': 'text/xml',
      },
    }
  )
}

路由段配置选项

路由处理器 (Route Handler) 使用与页面和布局相同的路由段配置。

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 参考文档。

route.js

关于 route.js 特殊文件的 API 参考文档。

route.js

On this page