路由处理器 3个月前

路由处理器（Route Handlers）

路由处理器允许您使用 Web 的 Request 和 Response API 为特定路由创建自定义请求处理器。

值得注意：路由处理器仅在 app 目录中可用。它们相当于 pages 目录中的 API 路由，这意味着您 不需要 同时使用 API 路由和路由处理器。

约定

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

copy
// app/api/route.ts
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 API 外，Next.js 还通过 NextRequest 和 NextResponse 扩展了这些 API，以提供方便的工具来处理高级用例。

行为

缓存

默认情况下，路由处理器不会被缓存。然而，您可以选择为 GET 方法启用缓存。为此，可以在您的路由处理器文件中使用 路由配置选项 如 export const dynamic = 'force-static'。

copy
// app/items/route.ts
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 })
}

特殊路由处理器

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

路由解析

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

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

每个 route.js 或 page.js 文件处理该路由的所有 HTTP 方法。

app/page.js

copy
export default function Page() {
  return <h1>Hello, Next.js!</h1>
}
// ❌ 冲突
// `app/route.js`
export async function POST(request) {}

示例

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

重新验证缓存数据

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

copy
// 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 段配置选项：

copy
export const revalidate = 60

动态函数

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

Cookies

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

另外，您也可以使用 Set-Cookie 头返回新的 Response。

copy
// 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）：

copy
// app/api/route.ts
import { type NextRequest } from 'next/server'

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

Headers

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

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

copy
// 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）：

copy
// app/api/route.ts
import { type NextRequest } from 'next/server'

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

重定向

您可以使用 redirect 方法进行重定向：

copy
// app/api/route.ts
import { redirect } from 'next/navigation'

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

动态路由段

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

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

copy
// app/items/[slug]/route.ts
export async function GET(
  request: Request,
  { params }: { params: { slug: string } }
) {
  const slug = params.slug // 'a', 'b', or 'c'
}

URL 查询参数

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

copy
// 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') // query 是 "hello" 对于 /api/search?query=hello
}

流式响应

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

copy
// app/api/chat/route.ts
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。

copy
// 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 方法读取请求体：

copy
// 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

TypeScript

JavaScriptTypeScript

copy
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 头：

copy
// app/api/route.ts
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

您可以使用路由处理器接收来自第三方服务的 Webhooks：

copy
// app/api/route.ts
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 响应

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

copy
// app/rss.xml/route.ts
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' },
    }
  )
}

段配置选项

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

copy
// 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'

See the API reference for more details.