NextResponse

NextResponse 擴展了 Web Response API，並提供額外的便利方法。

`cookies`

讀取或變更回應的 Set-Cookie 標頭。

`set(name, value)`

給定名稱，在回應中設定具有給定值的 Cookie。

// Given incoming request /home
let response = NextResponse.next()
// Set a cookie to hide the banner
response.cookies.set('show-banner', 'false')
// Response will have a `Set-Cookie:show-banner=false;path=/home` header
return response

`get(name)`

給定 Cookie 名稱，傳回 Cookie 的值。如果找不到 Cookie，則傳回 undefined。如果找到多個 Cookie，則傳回第一個。

// Given incoming request /home
let response = NextResponse.next()
// { name: 'show-banner', value: 'false', Path: '/home' }
response.cookies.get('show-banner')

`getAll()`

給定 Cookie 名稱，傳回 Cookie 的值。如果未給定名稱，則傳回回應中的所有 Cookie。

// Given incoming request /home
let response = NextResponse.next()
// [
//   { name: 'experiments', value: 'new-pricing-page', Path: '/home' },
//   { name: 'experiments', value: 'winter-launch', Path: '/home' },
// ]
response.cookies.getAll('experiments')
// Alternatively, get all cookies for the response
response.cookies.getAll()

`delete(name)`

給定 Cookie 名稱，從回應中刪除 Cookie。

// Given incoming request /home
let response = NextResponse.next()
// Returns true for deleted, false is nothing is deleted
response.cookies.delete('experiments')

`json()`

產生具有給定 JSON 主體的回應。

app/api/route.ts

import { NextResponse } from 'next/server'
 
export async function GET(request: Request) {
  return NextResponse.json({ error: 'Internal Server Error' }, { status: 500 })
}

`redirect()`

產生重新導向至 URL 的回應。

import { NextResponse } from 'next/server'
 
return NextResponse.redirect(new URL('/new', request.url))

在 NextResponse.redirect() 方法中使用 URL 之前，可以建立和修改它。例如，您可以使用 request.nextUrl 屬性來取得目前的 URL，然後修改它以重新導向至不同的 URL。

import { NextResponse } from 'next/server'
 
// Given an incoming request...
const loginUrl = new URL('/login', request.url)
// Add ?from=/incoming-url to the /login URL
loginUrl.searchParams.set('from', request.nextUrl.pathname)
// And redirect to the new URL
return NextResponse.redirect(loginUrl)

`rewrite()`

產生重新寫入（代理）給定 URL 的回應，同時保留原始 URL。

import { NextResponse } from 'next/server'
 
// Incoming request: /about, browser shows /about
// Rewritten request: /proxy, browser shows /about
return NextResponse.rewrite(new URL('/proxy', request.url))

`next()`

next() 方法對於中介層很有用，因為它允許您提早傳回並繼續路由。

import { NextResponse } from 'next/server'
 
return NextResponse.next()

您也可以在產生回應時轉發 headers

import { NextResponse } from 'next/server'
 
// Given an incoming request...
const newHeaders = new Headers(request.headers)
// Add a new header
newHeaders.set('x-version', '123')
// And produce a response with the new headers
return NextResponse.next({
  request: {
    // New request headers
    headers: newHeaders,
  },
})