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;

可用的选项如下：

属性	类型	描述
`basePath`	`string`	URL 的基础路径。
`buildId`	`string` \| `undefined`	Next.js 应用的构建标识符。可以自定义。
`pathname`	`string`	URL 的路径名。
`searchParams`	`Object`	URL 的搜索参数。

值得注意的是：Pages Router 中的国际化属性在 App Router 中不可用。了解更多关于 App Router 中的国际化。

`ip`

ip 属性是一个包含请求 IP 地址的字符串。这个值可以由你的托管平台选择性提供。

提示： 在 Vercel 上，默认提供这个值。在其他平台上，你可以使用 X-Forwarded-For 头来提供 IP 地址。

// Vercel 提供
request.ip;
// 自托管
request.headers.get("X-Forwarded-For");

`geo`

geo 属性是一个包含请求地理信息的对象。这个值可以由你的托管平台选择性提供。

提示： 在 Vercel 上，默认提供这个值。在其他平台上，你可以使用 X-Forwarded-For 头来提供 IP 地址，然后使用第三方服务查找地理信息。

// Vercel 提供
request.geo.city;
request.geo.country;
request.geo.region;
request.geo.latitude;
request.geo.longitude;
 
// 自托管
function getGeo(request) {
  let ip = request.headers.get("X-Forwarded-For");
  // 使用第三方服务查找地理信息
}