NextRequest
NextRequest 扩展了 Web Request API,提供了更多便捷方法。
cookies
读取或修改请求中的 Set-Cookie
标头。
set(name, value)
根据给定的名称,在请求中设置具有对应值的 cookie。
// 假设传入请求为 /home
// 设置一个 cookie 来隐藏横幅
// 请求将包含 `Set-Cookie:show-banner=false;path=/home` 标头
request.cookies.set('show-banner', 'false')
get(name)
根据 cookie 名称返回其值。如果未找到 cookie 则返回 undefined
。如果找到多个同名 cookie,则返回第一个。
// 假设传入请求为 /home
// { name: 'show-banner', value: 'false', Path: '/home' }
request.cookies.get('show-banner')
getAll()
根据 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
。
// 存在返回 true,否则返回 false
request.cookies.has('experiments')
clear()
从请求中移除 Set-Cookie
标头。
request.cookies.clear()
nextUrl
扩展了原生 URL
API,提供更多便捷方法,包括 Next.js 特有的属性。
// 对于 /home 请求,pathname 为 /home
request.nextUrl.pathname
// 对于 /home?name=lee 请求,searchParams 为 { 'name': 'lee' }
request.nextUrl.searchParams
版本历史
版本 | 变更 |
---|---|
v13.0.0 | 新增 useSearchParams 功能。 |