useCookie

在你的页面、组件和插件中，你可以使用 useCookie，这是一个 SSR 友好的组合式函数，用于读取和写入 cookie。

const cookie = useCookie(name, options)

useCookie 仅在 Nuxt 上下文中工作。

useCookie ref 将会自动序列化和反序列化 cookie 值到 JSON。

示例

下面的例子创建了一个名为 counter 的 cookie。如果 cookie 不存在，它最初会被设置为一个随机值。每当我们更新 counter 变量时，cookie 将会相应地更新。

app.vue

<script setup lang="ts">
const counter = useCookie('counter')

counter.value = counter.value || Math.round(Math.random() * 1000)
</script>

<template>
  <div>
    <h1>Counter: {{ counter || '-' }}</h1>
    <button @click="counter = null">reset</button>
    <button @click="counter--">-</button>
    <button @click="counter++">+</button>
  </div>
</template>

在文档 > 示例 > 高级 > Use Cookie 中读取和编辑一个实时示例。

当 cookie 发生更改时，使用 refreshCookie 手动刷新 useCookie 的值。

选项

Cookie 组合式函数接受多个选项，允许你修改 cookie 的行为。

大多数选项将直接传递给 cookie 包。

`maxAge` / `expires`

使用这些选项设置 cookie 的过期时间。

maxAge：指定 number（以秒为单位），作为 Max-Age Set-Cookie 属性的值。给定的数字将通过向下取整转换为整数。默认情况下，不设置最大期限。

expires：指定 Date 对象，作为 Expires Set-Cookie 属性的值。默认情况下，不设置过期时间。大多数客户端会将其视为“非持久 cookie”，并在诸如退出 Web 浏览器应用程序的条件下删除它。

cookie 存储模型规范声明，如果同时设置了 expires 和 maxAge，则 maxAge 优先，但并非所有客户端都遵守此规则，因此如果两者都设置，它们应该指向相同的日期和时间！

如果 expires 和 maxAge 都没有设置，则 cookie 将是会话级的，并在用户关闭浏览器时删除。

`httpOnly`

指定 HttpOnly Set-Cookie 属性的 boolean 值。当为真值时，会设置 HttpOnly 属性；否则不会设置。默认情况下，不设置 HttpOnly 属性。

当将其设置为 true 时请小心，因为符合规范的客户端将不允许客户端 JavaScript 在 document.cookie 中看到该 cookie。

`secure`

指定 Secure Set-Cookie 属性的 boolean 值。当为真值时，会设置 Secure 属性；否则不会设置。默认情况下，不设置 Secure 属性。

当将其设置为 true 时请小心，因为如果浏览器没有 HTTPS 连接，符合规范的客户端将来不会将 cookie 发回服务器。这可能会导致水合错误。

`partitioned`

指定 Partitioned Set-Cookie 属性的 boolean 值。当为真值时，会设置 Partitioned 属性，否则不会设置。默认情况下，不设置 Partitioned 属性。

这是一个尚未完全标准化的属性，将来可能会发生变化。这也意味着许多客户端可能会忽略此属性，直到它们理解它为止。更多信息可以在提案中找到。

`domain`

指定 Domain Set-Cookie 属性的值。默认情况下，不设置域，大多数客户端会认为该 cookie 仅适用于当前域。

`path`

指定 Path Set-Cookie 属性的值。默认情况下，路径被视为“默认路径”。

`sameSite`

指定 SameSite Set-Cookie 属性的 boolean 或 string 值。

true 将 SameSite 属性设置为 Strict，以实现严格的同站点强制执行。
false 将不设置 SameSite 属性。
'lax' 将 SameSite 属性设置为 Lax，以实现宽松的同站点强制执行。
'none' 将 SameSite 属性设置为 None，以用于显式的跨站点 cookie。
'strict' 将 SameSite 属性设置为 Strict，以实现严格的同站点强制执行。

有关不同强制级别的更多信息，请参阅规范。

`encode`

指定一个函数，该函数将用于编码 cookie 的值。由于 cookie 的值具有有限的字符集（并且必须是简单的字符串），因此可以使用此函数将值编码为适合 cookie 值的字符串。

默认的编码器是 JSON.stringify + encodeURIComponent。

`decode`

指定一个函数，该函数将用于解码 cookie 的值。由于 cookie 的值具有有限的字符集（并且必须是简单的字符串），因此可以使用此函数将先前编码的 cookie 值解码为 JavaScript 字符串或其他对象。

默认的解码器是 decodeURIComponent + destr。

如果此函数抛出错误，则会将原始的未解码的 cookie 值作为 cookie 的值返回。

true - 将监视 cookie ref 数据更改及其嵌套属性（默认）。
shallow - 将仅监视顶级属性的 cookie ref 数据更改
false - 将不监视 cookie ref 数据更改。

当 cookie 发生更改时，使用 refreshCookie 手动刷新 useCookie 的值。

示例 1

<script setup lang="ts">
const user = useCookie(
  'userInfo',
  {
    default: () => ({ score: -1 }),
    watch: false
  }
)

if (user.value && user.value !== null) {
  user.value.score++; // userInfo cookie not update with this change
}
</script>

<template>
  <div>User score: {{ user?.score }}</div>
</template>

示例 2

<script setup lang="ts">
const list = useCookie(
  'list',
  {
    default: () => [],
    watch: 'shallow'
  }
)

function add() {
  list.value?.push(Math.round(Math.random() * 1000))
  // list cookie not update with this change
}

function save() {
  if (list.value && list.value !== null) {
    list.value = [...list.value]
    // list cookie update with this change
  }
}
</script>

<template>
  <div>
    <h1>List</h1>
    <pre>{{ list }}</pre>
    <button @click="add">Add</button>
    <button @click="save">Save</button>
  </div>
</template>

API 路由中的 Cookie

你可以使用 h3 包中的 getCookie 和 setCookie 在服务器 API 路由中设置 cookie。

server/api/counter.ts

export default defineEventHandler(event => {
  // Read counter cookie
  let counter = getCookie(event, 'counter') || 0

  // Increase counter cookie by 1
  setCookie(event, 'counter', ++counter)

  // Send JSON response
  return { counter }
})

在文档 > 示例 > 高级 > Use Cookie 中读取和编辑一个实时示例。

useAsyncData

useAsyncData 提供对在 SSR 友好的组合式函数中异步解析的数据的访问。

useError

useError 组合式函数返回正在处理的全局 Nuxt 错误。

示例

选项