会话

通过会话记住您的用户。

会话是一种通过 cookie 记住用户的方法。这是在网络上认证用户或保存关于他们的数据(例如其语言或偏好设置)的非常常见的方法。

H3 提供了许多用于处理会话的工具:

  • useSession 初始化一个会话并返回一个用于控制会话的包装器。
  • getSession 初始化或获取当前用户会话。
  • updateSession 更新当前会话的数据。
  • clearSession 清除当前会话。

大多数情况下,您将使用 useSession 来操作会话。

初始化会话

要初始化会话,您需要在事件处理器中使用 useSession

import { useSession } from "h3";

app.use(async (event) => {
  const session = await useSession(event, {
    password: "80d42cfb-1cd2-462c-8f17-e3237d9027e9",
  });

  // 做一些事情...
});
password 会对每个会话 cookie 进行加密,其熵是实际的安全边界。被窃取的会话 cookie 会以明文形式携带盐值和完整性摘要,因此弱密码或容易猜测的密码可能会遭到离线暴力破解——增加 PBKDF2 迭代次数只会减慢破解速度,并不能修复低熵密钥。请始终使用密码学安全的随机源生成密码,例如:
node -e "console.log(require('node:crypto').randomBytes(32).toString('base64'))"
下面的示例使用硬编码值以保持可读性,但在实际应用中,请从环境变量(例如 process.env.SESSION_PASSWORD)中加载一个随机生成的、至少包含 32 个字符的密钥,并且绝不要将其提交到源代码管理系统中。容易猜测的密码短语(即使长度 ≥32 个字符)也不安全。

这将初始化一个会话并返回一个包含名为 h3 的 cookie 和加密内容的 Set-Cookie 头。

如果请求中包含名为 h3 的 cookie 或名为 x-h3-session 的头部,会话将使用该 cookie 或头部的内容进行初始化。

头部优先于 cookie。

从会话中获取数据

要从会话中获取数据,我们仍然使用 useSession。在内部,它会使用 getSession 来获取会话。

import { useSession } from "h3";

app.use(async (event) => {
  const session = await useSession(event, {
    password: "80d42cfb-1cd2-462c-8f17-e3237d9027e9",
  });

  return session.data;
});

数据存储在会话的 data 属性中。如果没有数据,它将是一个空对象。

向会话添加数据

要向会话添加数据,我们仍然使用 useSession。在内部,它会使用 updateSession 来更新会话。

import { useSession } from "h3";

app.use(async (event) => {
  const session = await useSession(event, {
    password: "80d42cfb-1cd2-462c-8f17-e3237d9027e9",
  });

  const count = (session.data.count || 0) + 1;
  await session.update({
    count: count,
  });

  return count === 0 ? "Hello world!" : `Hello world! 您已经访问此页面 ${count} 次。`;
});

这里发生了什么?

我们尝试从请求中获取一个会话。如果没有会话,将创建一个新的。然后,我们递增会话的 count 属性,并用新值更新会话。最后,我们返回一条显示用户访问页面次数的消息。

尝试多次访问该页面,您将看到您访问的次数。

如果您使用类似 curl 的命令行工具测试此示例,您将看不到访问次数,因为命令行工具不会保存 cookie。您必须从响应中获取 cookie 并回传给服务器。

清除会话

要清除会话,我们仍然使用 useSession。在内部,它会使用 clearSession 来清除会话。

import { useSession } from "h3";

app.use("/clear", async (event) => {
  const session = await useSession(event, {
    password: "80d42cfb-1cd2-462c-8f17-e3237d9027e9",
  });

  await session.clear();

  return "会话已清除";
});

H3 将发送一个带有空的名为 h3 的 cookie 的 Set-Cookie 头,以清除会话。

选项

调用 useSession 时,您可以传递一个带有选项的对象作为第二个参数来配置会话:

import { useSession } from "h3";

app.use(async (event) => {
  const session = await useSession(event, {
    name: "my-session",
    password: "80d42cfb-1cd2-462c-8f17-e3237d9027e9",
    cookie: {
      httpOnly: true,
      secure: true,
      sameSite: "strict",
    },
    maxAge: 60 * 60 * 24 * 7, // 7 天
  });

  return session.data;
});

password 外,每个选项都是可选的。name 选项值得特别说明:它会设置用于存储会话的 cookie,默认值为 h3。H3 还会从一个由 name 派生的请求头中读取会话,并将其规范化为小写,格式为 x-${name.toLowerCase()}-session,因此默认名称 h3 会生成前面看到的 x-h3-session 请求头。像 MyApp 这样混合大小写的 name 仍然会解析为小写的 x-myapp-session 请求头,而 cookie 会保留原始大小写。正因为这个默认值,前面的示例才会设置一个名为 h3 的 cookie。

会话 cookie 的默认值为 secure: truehttpOnly: truesameSite: "lax"path: "/"。这些选项中的任何一个都可以通过 cookie 进行覆盖。
secure: true 选项会告知浏览器仅通过 HTTPS 存储和发送 cookie。在使用普通 HTTP 进行本地开发时,符合规范的浏览器(尤其是 Safari 和 iOS,以及某些本地域名下的 Chrome)会静默丢弃 cookie,因此会话将无法持久化。要解决此问题,请在本地开发期间设置 cookie: { secure: false }

使用多个会话

由于每个会话都存储在自己的 name 下,你可以在同一个请求上运行多个彼此独立的会话。它们会保存在不同的 cookie 中,且永远不会互相覆盖,这对于将无关的事项分开很有用,例如一个长期存在的认证会话和一个短暂的闪现消息:

import { useSession } from "h3";

app.use(async (event) => {
  const auth = await useSession(event, {
    name: "auth",
    password: "80d42cfb-1cd2-462c-8f17-e3237d9027e9",
  });

  const flash = await useSession(event, {
    name: "flash",
    password: "80d42cfb-1cd2-462c-8f17-e3237d9027e9",
  });

  await flash.update({ message: "已保存!" });

  // `auth` 和 `flash` 由不同的 cookie 支持,因此它们会保持独立
  return { user: auth.data.user, flash: flash.data.message };
});
为每个会话使用不同的 name。两个共享同一个 name 的会话也会共享同一个 cookie,因此最后一次写入的内容会生效。