Menu

NextRequest

NextRequest 扩展了 Web Request API,增加了一些便利方法。

cookies

读取或修改请求的 Set-Cookie header。

set(name, value)

给定一个名称,在请求中设置具有给定值的 cookie。

// 给定传入请求 /home
// 设置一个 cookie 来隐藏横幅
// 请求将具有 `Set-Cookie:show-banner=false;path=/home` header
request.cookies.set('show-banner', 'false')

get(name)

给定一个 cookie 名称,返回该 cookie 的值。如果未找到 cookie,则返回 undefined。如果找到多个 cookie,则返回第一个。

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

getAll()

给定一个 cookie 名称,返回该 cookie 的值。如果没有提供名称,则返回请求中的所有 cookie。

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

delete(name)

给定一个 cookie 名称,从请求中删除该 cookie。

// 删除成功返回 true,没有删除则返回 false
request.cookies.delete('experiments')

has(name)

给定一个 cookie 名称,如果请求中存在该 cookie 则返回 true

// 如果 cookie 存在则返回 true,不存在则返回 false
request.cookies.has('experiments')

clear()

从请求中移除 Set-Cookie header。

request.cookies.clear()

nextUrl

扩展了原生的 URL API,增加了额外的便利方法,包括 Next.js 特有的属性。

// 给定请求 /home,pathname 为 /home
request.nextUrl.pathname
// 给定请求 /home?name=lee,searchParams 为 { 'name': 'lee' }
request.nextUrl.searchParams

可用的选项如下:

属性类型描述
basePathstringURL 的基础路径
buildIdstring | undefinedNext.js 应用的构建标识符。可以自定义
pathnamestringURL 的路径名。
searchParamsObjectURL 的搜索参数。

**注意:**Pages 路由中的国际化属性在 App 路由中不可用。详细了解 App 路由的国际化

版本历史

版本变更
v15.0.0移除 ipgeo