Next 請求 (NextRequest)
NextRequest 擴充了 網頁請求 API,並提供了一些額外的便捷方法。
cookies
讀取或修改請求的 Set-Cookie
標頭。
set(name, value)
給定名稱,在請求中設定具有給定值的 Cookie。
// Given incoming request /home
// Set a cookie to hide the banner
// request will have a `Set-Cookie:show-banner=false;path=/home` header
request.cookies.set('show-banner', 'false')
get(name)
給定 Cookie 名稱,返回 Cookie 的值。如果找不到 Cookie,則返回 undefined
。如果找到多個 Cookie,則返回第一個。
// Given incoming request /home
// { name: 'show-banner', value: 'false', Path: '/home' }
request.cookies.get('show-banner')
getAll()
給定 Cookie 名稱,返回 Cookie 的值。如果未提供名稱,則返回請求中的所有 Cookie。
// Given incoming request /home
// [
// { name: 'experiments', value: 'new-pricing-page', Path: '/home' },
// { name: 'experiments', value: 'winter-launch', Path: '/home' },
// ]
request.cookies.getAll('experiments')
// Alternatively, get all cookies for the request
request.cookies.getAll()
delete(name)
給定 Cookie 名稱,從請求中刪除 Cookie。
// Returns true for deleted, false is nothing is deleted
request.cookies.delete('experiments')
has(name)
給定一個 Cookie 名稱,如果請求中存在該 Cookie,則返回 true
。
// Returns true if cookie exists, false if it does not
request.cookies.has('experiments')
clear()
從請求中移除 Set-Cookie
標頭。
request.cookies.clear()
nextUrl
使用額外的便捷方法擴展原生 URL
API,包含 Next.js 特定的屬性。
// Given a request to /home, pathname is /home
request.nextUrl.pathname
// Given a request to /home?name=lee, searchParams is { 'name': 'lee' }
request.nextUrl.searchParams
以下選項可用:
屬性 | 類型 | 說明 |
---|---|---|
基礎路徑 (basePath) | string | URL 的基底路徑。 |
buildId | string | undefined | Next.js 應用程式的建置識別碼。可以自訂。 |
pathname | string | URL 的路徑名稱。 |
searchParams | 物件 | URL 的搜尋參數。 |
注意:來自 Pages Router 的國際化屬性無法在 App Router 中使用。進一步了解App Router 的國際化。