NextResponse

NextResponse 扩展了 Web Response API，提供了更多便捷方法。

`cookies`

读取或修改响应中的 Set-Cookie 标头。

`set(name, value)`

根据给定的名称，在响应中设置对应值的 cookie。

// 给定传入请求 /home
let response = NextResponse.next()
// 设置一个隐藏横幅的 cookie
response.cookies.set('show-banner', 'false')
// 响应将包含 `Set-Cookie:show-banner=false;path=/home` 标头
return response

`get(name)`

根据 cookie 名称返回其值。如果未找到 cookie 则返回 undefined。如果找到多个同名 cookie，返回第一个。

// 给定传入请求 /home
let response = NextResponse.next()
// { name: 'show-banner', value: 'false', Path: '/home' }
response.cookies.get('show-banner')

`getAll()`

根据 cookie 名称返回其所有值。如果未指定名称，则返回响应中的所有 cookie。

// 给定传入请求 /home
let response = NextResponse.next()
// [
//   { name: 'experiments', value: 'new-pricing-page', Path: '/home' },
//   { name: 'experiments', value: 'winter-launch', Path: '/home' },
// ]
response.cookies.getAll('experiments')
// 或者获取响应中的所有 cookie
response.cookies.getAll()

`delete(name)`

根据 cookie 名称从响应中删除对应 cookie。

// 给定传入请求 /home
let response = NextResponse.next()
// 返回 true 表示已删除，false 表示无内容被删除
response.cookies.delete('experiments')

`json()`

生成包含给定 JSON 主体的响应。

import { NextResponse } from 'next/server'

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

import { NextResponse } from 'next/server'

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

URL 可以在 NextResponse.redirect() 方法中使用前被创建和修改。例如，您可以使用 request.nextUrl 属性获取当前 URL，然后修改它以重定向到不同的 URL。

import { NextResponse } from 'next/server'

// 给定传入请求...
const loginUrl = new URL('/login', request.url)
// 向 /login URL 添加 ?from=/incoming-url 参数
loginUrl.searchParams.set('from', request.nextUrl.pathname)
// 然后重定向到新 URL
return NextResponse.redirect(loginUrl)

`rewrite()`

生成重写（代理）指定 URL 的响应，同时保留原始 URL。

import { NextResponse } from 'next/server'

// 传入请求: /about, 浏览器显示 /about
// 重写请求: /proxy, 浏览器仍显示 /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'

// 给定传入请求...
const newHeaders = new Headers(request.headers)
// 添加新标头
newHeaders.set('x-version', '123')
// 生成包含新标头的响应
return NextResponse.next({
  request: {
    // 新的请求标头
    headers: newHeaders,
  },
})

On this page