路由处理程序

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

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

约定

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

app/api/route.ts

export async function GET(request: Request) {}

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

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

扩展的 `NextRequest` 和 `NextResponse` API

除了支持原生 Request 和 Response API 之外，Next.js 还使用 NextRequest 和 NextResponse 对其进行扩展，以便为高级用例提供便捷的辅助程序。

行为

缓存，例如 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 })
}

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

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

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

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

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

app/page.js

export default function Page() {
  return <h1>Hello, Next.js!</h1>
}
 
// ❌ Conflict
// `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)
}

Cookiecookies 读取或设置 Cookie。此服务器函数可以直接在路由处理程序中调用，也可以嵌套在另一个函数中。

或者，您可以使用 Set-Cookie 标头返回新的 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}` },
  })
}

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

app/api/route.ts

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

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

您还可以使用底层 Web API 从请求 (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.net.cn/')
}

动态路由段

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

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

app/items/[slug]/route.ts

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

路由	示例 URL	`参数`
`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 查询参数，包括更容易地处理查询参数。

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 is "hello" for /api/search?query=hello
}

流式传输的信息。

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。

app/api/route.ts

// https://mdn.org.cn/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)
}

请求正文

app/items/route.ts

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

请求正文 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 方法为特定的路由处理程序设置 CORS 标头。

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

您可以使用路由处理程序接收来自第三方服务的 Webhook。

app/api/route.ts

export async function POST(request: Request) {
  try {
    const text = await request.text()
    // Process the webhook payload
  } catch (error) {
    return new Response(`Webhook error: ${error.message}`, {
      status: 400,
    })
  }
 
  return new Response('Success!', {
    status: 200,
  })
}

值得注意的是，与使用页面路由器的 API 路由不同，您不需要使用 bodyParser 来使用任何其他配置。

非 UI 响应sitemap.xml、robots.txt、app icons 和开放图谱图像都内置了支持。

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.net.cn/docs</link>
  <description>The React Framework for the Web</description>
</channel>
 
</rss>`,
    {
      headers: {
        'Content-Type': 'text/xml',
      },
    }
  )
}

Segment 配置选项

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

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

API 参考

详细了解 route.js 文件。

route.js

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

这有帮助吗？

路由处理程序

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

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

API 参考

route.js

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

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