路由处理器 (Route Handlers)

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

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

约定

路由处理器 (Route Handlers) 在 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，Next.js 还通过 NextRequest 和 NextResponse 对其进行了扩展，为高级用例提供了便捷的辅助方法。

行为

缓存

当使用 GET 方法和 Response 对象时，路由处理器默认会被缓存。

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

TypeScript 警告：Response.json() 仅在 TypeScript 5.2 及以上版本中有效。如果使用较低版本的 TypeScript，可以使用 NextResponse.json() 来替代以获得类型化响应。

退出缓存

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

在 GET 方法中使用 Request 对象
使用其他 HTTP 方法
使用动态函数 (Dynamic Functions) 如 cookies 和 headers
路由段配置选项 (Segment Config Options) 手动指定动态模式

例如：

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 方法会导致路由处理器被动态执行。

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

须知：与 API 路由类似，路由处理器可用于处理表单提交等场景。目前正在开发一个与 React 深度集成的处理表单和变更 (handling forms and mutations) 的新抽象层。

路由解析

您可以将 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 方法。

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 选项重新验证缓存数据 (revalidate cached data)：

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 读取 cookie。这个服务器函数可以直接在路由处理器中调用，或嵌套在其他函数中。

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

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 的抽象来读取 cookie (NextRequest)：

import { type NextRequest } from 'next/server'

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

Headers

您可以使用 next/headers 中的 headers 读取请求头。这个服务器函数可以直接在路由处理器中调用，或嵌套在其他函数中。

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

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 的抽象来读取请求头 (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/')
}

动态路由段

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

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

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

路由	示例 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 实例，它具有一些额外的便捷方法，可以更轻松地处理查询参数。

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 { Configuration, OpenAIApi } from 'openai-edge'
import { OpenAIStream, StreamingTextResponse } from 'ai'

export const runtime = 'edge'

const apiConfig = new Configuration({
  apiKey: process.env.OPENAI_API_KEY!,
})

const openai = new OpenAIApi(apiConfig)

export async function POST(req: Request) {
  // 从请求体中提取 `messages`
  const { messages } = await req.json()

  // 根据提示向 OpenAI API 请求响应
  const response = await openai.createChatCompletion({
    model: 'gpt-3.5-turbo',
    stream: true,
    messages: messages,
    max_tokens: 500,
    temperature: 0.7,
    top_p: 1,
    frequency_penalty: 1,
    presence_penalty: 1,
  })

  // 将响应转换为友好的文本流
  const stream = OpenAIStream(response)

  // 返回流式响应
  return new StreamingTextResponse(stream)
}

这些抽象使用了 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 方法在 Response 上设置 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',
    },
  })
}

Edge 和 Node.js 运行时

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

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

export const runtime = 'edge' // 默认为 'nodejs'

非 UI 响应

你可以使用路由处理器返回非 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>`)
}

段配置选项

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

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