cookies

cookies 是一个异步函数，允许你在服务器组件中读取 HTTP 传入请求的 cookie，并在服务器操作或路由处理程序中读取/写入传出请求的 cookie。

import { cookies } from 'next/headers'
 
export default async function Page() {
  const cookieStore = await cookies()
  const theme = cookieStore.get('theme')
  return '...'
}

参考

方法

以下方法可用

方法	返回类型	描述
`get('name')`	对象	接受一个 cookie 名称并返回一个包含名称和值的对象。
`getAll()`	对象数组	返回所有匹配名称的 cookie 列表。
`has('name')`	布尔值	接受一个 cookie 名称，并根据 cookie 是否存在返回一个布尔值。
`set(name, value, options)`	-	接受一个 cookie 名称、值和选项，并设置传出请求的 cookie。
`delete(name)`	-	接受一个 cookie 名称并删除该 cookie。
`clear()`	-	删除所有 cookie。
`toString()`	字符串	返回 cookie 的字符串表示形式。

选项

设置 cookie 时，支持 options 对象中的以下属性

选项	类型	描述
`name`	字符串	指定 cookie 的名称。
`value`	字符串	指定要存储在 cookie 中的值。
`expires`	日期	定义 cookie 的精确过期日期。
`maxAge`	数字	设置 cookie 的生命周期（秒）。
`domain`	字符串	指定 cookie 可用的域。
`路径`	字符串，默认值：`'/'`	将 cookie 的范围限制在域内的特定路径。
`secure`	布尔值	确保 cookie 仅通过 HTTPS 连接发送，以增加安全性。
`httpOnly`	布尔值	将 cookie 限制为 HTTP 请求，防止客户端访问。
`sameSite`	布尔值，`'lax'`，`'strict'`，`'none'`	控制 cookie 的跨站点请求行为。
`优先级`	字符串（`"low"`，`"medium"`，`"high"`）	指定 cookie 的优先级
`partitioned`	布尔值	指示 cookie 是否分区。

唯一具有默认值的选项是 path。

要了解有关这些选项的更多信息，请参阅 MDN 文档。

须知

cookies 是一个异步函数，它返回一个 Promise。您必须使用 async/await 或 React 的 use 函数来访问 cookie。
- 在版本 14 及更早版本中，cookies 是一个同步函数。为了帮助向后兼容，您仍然可以在 Next.js 15 中同步访问它，但此行为将来会被弃用。
cookies 是一个动态 API，其返回的值无法提前知道。在布局或页面中使用它将使路由选择动态渲染。
.delete 方法只能在以下情况下调用
- 在服务器操作或路由处理程序中。
- 如果它属于与调用 .set 相同的域。对于通配符域，特定子域必须完全匹配。此外，代码必须在与您要删除的 cookie 相同的协议（HTTP 或 HTTPS）上执行。
HTTP 不允许在流开始后设置 cookie，因此您必须在服务器操作或路由处理程序中使用 .set。

在服务器组件中使用 cookie 时，重要的是要理解 cookie 基本上是一种客户端存储机制

读取 cookie 在服务器组件中有效，因为您正在访问客户端浏览器在 HTTP 请求头中发送给服务器的 cookie 数据。
设置 cookie 不能直接在服务器组件中完成，即使在使用路由处理程序或服务器操作时也是如此。这是因为 cookie 实际上是由浏览器而不是服务器存储的。

服务器只能发送指令（通过 Set-Cookie 头）来告诉浏览器存储 cookie - 实际存储发生在客户端。这就是为什么修改状态的 cookie 操作（.set、.delete、.clear）必须在路由处理程序或服务器操作中执行，以便正确设置响应头。

在服务器操作中设置或删除 cookie 后，Next.js 会在服务器上重新渲染当前页面及其布局，以便 UI 反映新的 cookie 值。请参阅缓存指南。

UI 不会被卸载，但依赖于服务器数据的效果将重新运行。

要刷新缓存数据，请在操作中调用revalidatePath或revalidateTag。

示例

您可以使用 (await cookies()).get('name') 方法获取单个 cookie

import { cookies } from 'next/headers'
 
export default async function Page() {
  const cookieStore = await cookies()
  const theme = cookieStore.get('theme')
  return '...'
}

获取所有 cookie

您可以使用 (await cookies()).getAll() 方法获取所有匹配名称的 cookie。如果未指定 name，它将返回所有可用的 cookie。

import { cookies } from 'next/headers'
 
export default async function Page() {
  const cookieStore = await cookies()
  return cookieStore.getAll().map((cookie) => (
    <div key={cookie.name}>
      <p>Name: {cookie.name}</p>
      <p>Value: {cookie.value}</p>
    </div>
  ))
}

您可以在服务器操作或路由处理程序中使用 (await cookies()).set(name, value, options) 方法来设置 cookie。options 对象是可选的。

'use server'
 
import { cookies } from 'next/headers'
 
export async function create(data) {
  const cookieStore = await cookies()
 
  cookieStore.set('name', 'lee')
  // or
  cookieStore.set('name', 'lee', { secure: true })
  // or
  cookieStore.set({
    name: 'name',
    value: 'lee',
    httpOnly: true,
    path: '/',
  })
}

您可以使用 (await cookies()).has(name) 方法检查 cookie 是否存在

import { cookies } from 'next/headers'
 
export default async function Page() {
  const cookieStore = await cookies()
  const hasCookie = cookieStore.has('theme')
  return '...'
}

删除 cookie

有三种方法可以删除 cookie。

使用 delete() 方法

'use server'
 
import { cookies } from 'next/headers'
 
export async function delete(data) {
  (await cookies()).delete('name')
}

设置一个同名但值为空的新 cookie

'use server'
 
import { cookies } from 'next/headers'
 
export async function delete(data) {
  (await cookies()).set('name', '')
}

将 maxAge 设置为 0 将立即使 cookie 过期。maxAge 接受一个以秒为单位的值。

'use server'
 
import { cookies } from 'next/headers'
 
export async function delete(data) {
  (await cookies()).set('name', 'value', { maxAge: 0 })
}

版本历史

版本	更改
`v15.0.0-RC`	`cookies` 现在是一个异步函数。可以使用代码转换工具。
`v13.0.0`	引入了 `cookies`。