路由處理器
路由處理器讓您可以使用 Web Request 和 Response API,為給定的路由建立自訂請求處理器。


要知道的是:路由處理器僅在
app
目錄內可用。它們等同於pages
目錄內的 API 路由,這表示您不需要同時使用 API 路由和路由處理器。
慣例
路由處理器定義在 app
目錄內的 route.js|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
擴充了它們,為進階使用案例提供方便的輔助工具。
行為
快取
路由處理器預設不快取。但是,您可以選擇加入 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
,以及其他 metadata 檔案,預設保持靜態,除非它們使用 Dynamic 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>
}
// ❌ Conflict
// `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')
}
Headers
您可以使用 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.dev.org.tw/')
}
動態路由區段
路由處理器可以使用動態區段,從動態資料建立請求處理器。
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 查詢參數
傳遞至路由處理器的請求物件是 NextRequest
實例,它具有一些額外的便利方法,包括更輕鬆地處理查詢參數的方法。
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
}
串流
串流通常與大型語言模型 (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)
}
請求 Body
您可以使用標準 Web API 方法讀取 Request
body
export async function POST(request: Request) {
const res = await request.json()
return Response.json({ res })
}
請求 Body 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 範例 套件。
Webhook
您可以使用路由處理器接收來自第三方服務的 webhook
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,
})
}
值得注意的是,與 Pages Router 的 API 路由不同,您不需要使用 bodyParser
即可使用任何其他設定。
非 UI 回應
您可以使用路由處理器傳回非 UI 內容。請注意,sitemap.xml
、robots.txt
、app icons
和 open graph 圖片 都有內建支援。
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.dev.org.tw/docs</link>
<description>The React Framework for the Web</description>
</channel>
</rss>`,
{
headers: {
'Content-Type': 'text/xml',
},
}
)
}
區段設定選項
路由處理器使用與頁面和版面配置相同的路由區段設定。
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 參考以取得更多詳細資訊。
這有幫助嗎?