路由处理程序

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

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

约定

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

app/api/route.ts

export async function GET(request: Request) {}

app/api/route.js

export async function GET(request) {}

路由处理程序可以嵌套在 app 目录的任何位置，类似于 page.js 和 layout.js。但是在同一路由段级别上不能同时存在 route.js 文件和 page.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 方法选择启用缓存。要做到这一点，可以在路由处理程序文件中使用路由配置选项，比如 export const dynamic = 'force-static'。

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

app/items/route.js

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。
在同一路由上不能同时存在 route.js 文件和 page.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 和功能结合使用。

重新验证缓存数据

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

app/posts/route.ts

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

app/posts/route.js

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 读取或设置 cookies。这个服务器函数可以直接在 Route Handler 中调用，或嵌套在另一个函数中。

或者，你可以使用 Set-Cookie header 返回一个新的 Response。

app/api/route.ts

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

app/api/route.js

import { cookies } from 'next/headers'
 
export async function GET(request) {
  const cookieStore = await cookies()
  const token = cookieStore.get('token')
 
  return new Response('Hello, Next.js!', {
    status: 200,
    headers: { 'Set-Cookie': `token=${token}` },
  })
}

你也可以使用底层的 Web API 从请求 (NextRequest) 中读取 cookies:

app/api/route.ts

import { type NextRequest } from 'next/server'
 
export async function GET(request: NextRequest) {
  const token = request.cookies.get('token')
}

app/api/route.js

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

Headers

你可以使用来自 next/headers 的 headers 读取 headers。这个服务器函数可以直接在 Route Handler 中调用，或嵌套在另一个函数中。

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

app/api/route.ts

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

app/api/route.js

import { headers } from 'next/headers'
 
export async function GET(request) {
  const headersList = await headers()
  const referer = headersList.get('referer')
 
  return new Response("你好，Next.js！", {
    status: 200,
    headers: { referer: referer },
  })
}

你也可以使用底层的 Web API 从请求 (NextRequest) 中读取 headers:

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.js

export async function GET(request) {
  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/')
}

app/api/route.js

import { redirect } from 'next/navigation'
 
export async function GET(request) {
  redirect('https://nextjs.org/')
}

动态路由段

值得注意的是：在继续之前，建议阅读定义路由页面。

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

app/items/[slug]/route.ts

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

app/items/[slug]/route.js

export async function GET(request, { params }) {
  const slug = (await params).slug // '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 实例，它有一些额外的便捷方法，包括更容易处理查询参数。

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

app/api/search/route.js

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

流式响应

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

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

app/api/chat/route.js

import { openai } from '@ai-sdk/openai'
import { StreamingTextResponse, streamText } from 'ai'
 
export async function POST(req) {
  const { messages } = await req.json()
  const result = await streamText({
    model: openai('gpt-4-turbo'),
    messages,
  })
 
  return new StreamingTextResponse(result.toAIStream())
}

这些抽象使用 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>第一个</p>");
  await sleep(200);
  yield encoder.encode("<p>第二个</p>");
  await sleep(200);
  yield encoder.encode("<p>第三个</p>");
}
 
export async function GET() {
  const iterator = makeIterator()
  const stream = iteratorToStream(iterator)
 
  return new Response(stream)
}

app/api/route.js

// https://developer.mozilla.org/docs/Web/API/ReadableStream#convert_async_iterator_to_stream
function iteratorToStream(iterator) {
  return new ReadableStream({
    async pull(controller) {
      const { value, done } = await iterator.next()
 
      if (done) {
        controller.close()
      } else {
        controller.enqueue(value)
      }
    },
  })
}
 
function sleep(time) {
  return new Promise((resolve) => {
    setTimeout(resolve, time)
  })
}
 
const encoder = new TextEncoder()
 
async function* makeIterator() {
  yield encoder.encode("<p>第一个</p>");
  await sleep(200);
  yield encoder.encode("<p>第二个</p>");
  await sleep(200);
  yield encoder.encode("<p>第三个</p>");
}
 
export async function GET() {
  const iterator = makeIterator()
  const stream = iteratorToStream(iterator)
 
  return new Response(stream)
}

请求体

你可以使用标准的 Web API 方法读取 Request 体：

app/items/route.ts

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

app/items/route.js

export async function POST(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 })
}

app/items/route.js

export async function POST(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 头：

app/api/route.ts

export async function GET(request: Request) {
  return new Response("你好，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',
    },
  })
}

app/api/route.js

export async function GET(request) {
  return new Response("你好，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：

app/api/route.ts

export async function POST(request: Request) {
  try {
    const text = await request.text()
    // 处理 webhook 负载
  } catch (error) {
    return new Response(`Webhook 错误: ${error.message}`, {
      status: 400,
    })
  }
 
  return new Response("成功！", {
    status: 200,
  })
}

app/api/route.js

export async function POST(request) {
  try {
    const text = await request.text()
    // 处理 webhook 负载
  } catch (error) {
    return new Response(`Webhook 错误: ${error.message}`, {
      status: 400,
    })
  }
 
  return new Response("成功！", {
    status: 200,
  })
}

值得注意的是，与页面路由器中的 API 路由不同，你不需要使用 bodyParser 或任何额外的配置。

非 UI 响应

你可以使用路由处理程序返回非 UI 内容。注意，sitemap.xml、robots.txt、app icons 和 open graph 图片都有内置支持。

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 文档</title>
  <link>https://nextjs.org/docs</link>
  <description>Web 的 React 框架</description>
</channel>
 
</rss>`,
    {
      headers: {
        'Content-Type': 'text/xml',
      },
    }
  )
}

app/rss.xml/route.js

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'

app/items/route.js

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