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 的值。如果找不到該 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
標頭。
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 功能。 |